From eab11ace9b2163d866825fd45807aea4fdd9a7a7 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 3 May 2024 11:15:50 +1000 Subject: [PATCH] copyable code for aws --- .github/workflows/build-docs.yaml | 8 +- .../aws/accessanalyzer/analyzer/index.md | 31 +-- .../aws/accessanalyzer/analyzers/index.md | 17 +- .../providers/aws/acmpca/certificate/index.md | 37 ++-- .../acmpca/certificate_authorities/index.md | 17 +- .../aws/acmpca/certificate_authority/index.md | 41 ++-- .../certificate_authority_activation/index.md | 29 +-- .../index.md | 17 +- .../aws/acmpca/certificates/index.md | 19 +- .../providers/aws/acmpca/permission/index.md | 23 ++- .../providers/aws/acmpca/permissions/index.md | 19 +- .../providers/aws/amplify/app/index.md | 57 +++--- .../providers/aws/amplify/apps/index.md | 17 +- .../providers/aws/amplify/branch/index.md | 49 ++--- .../providers/aws/amplify/branches/index.md | 17 +- .../providers/aws/amplify/domain/index.md | 45 ++--- .../providers/aws/amplify/domains/index.md | 17 +- .../aws/amplifyuibuilder/component/index.md | 53 +++--- .../aws/amplifyuibuilder/components/index.md | 21 ++- .../aws/amplifyuibuilder/form/index.md | 45 ++--- .../aws/amplifyuibuilder/forms/index.md | 21 ++- .../aws/amplifyuibuilder/theme/index.md | 37 ++-- .../aws/amplifyuibuilder/themes/index.md | 21 ++- .../providers/aws/apigateway/account/index.md | 23 ++- .../aws/apigateway/accounts/index.md | 17 +- .../providers/aws/apigateway/api_key/index.md | 37 ++-- .../aws/apigateway/api_keys/index.md | 17 +- .../aws/apigateway/authorizer/index.md | 41 ++-- .../aws/apigateway/authorizers/index.md | 19 +- .../aws/apigateway/base_path_mapping/index.md | 27 +-- .../apigateway/base_path_mappings/index.md | 19 +- .../apigateway/client_certificate/index.md | 25 +-- .../apigateway/client_certificates/index.md | 17 +- .../aws/apigateway/deployment/index.md | 31 +-- .../aws/apigateway/deployments/index.md | 19 +- .../apigateway/documentation_part/index.md | 27 +-- .../apigateway/documentation_parts/index.md | 19 +- .../apigateway/documentation_version/index.md | 25 +-- .../documentation_versions/index.md | 19 +- .../aws/apigateway/domain_name/index.md | 43 +++-- .../aws/apigateway/domain_names/index.md | 17 +- .../providers/aws/apigateway/method/index.md | 45 ++--- .../providers/aws/apigateway/methods/index.md | 21 ++- .../providers/aws/apigateway/model/index.md | 29 +-- .../providers/aws/apigateway/models/index.md | 19 +- .../aws/apigateway/request_validator/index.md | 29 +-- .../apigateway/request_validators/index.md | 19 +- .../aws/apigateway/resource/index.md | 27 +-- .../aws/apigateway/resources/index.md | 19 +- .../aws/apigateway/rest_api/index.md | 53 +++--- .../aws/apigateway/rest_apis/index.md | 17 +- .../providers/aws/apigateway/stage/index.md | 47 ++--- .../providers/aws/apigateway/stages/index.md | 19 +- .../aws/apigateway/usage_plan/index.md | 33 ++-- .../aws/apigateway/usage_plan_key/index.md | 23 ++- .../aws/apigateway/usage_plan_keys/index.md | 17 +- .../aws/apigateway/usage_plans/index.md | 17 +- .../aws/apigateway/vpc_link/index.md | 29 +-- .../aws/apigateway/vpc_links/index.md | 17 +- .../providers/aws/apigatewayv2/api/index.md | 57 +++--- .../aws/apigatewayv2/api_mapping/index.md | 29 +-- .../aws/apigatewayv2/api_mappings/index.md | 19 +- .../providers/aws/apigatewayv2/apis/index.md | 17 +- .../aws/apigatewayv2/authorizer/index.md | 43 +++-- .../aws/apigatewayv2/authorizers/index.md | 19 +- .../aws/apigatewayv2/deployment/index.md | 27 +-- .../aws/apigatewayv2/deployments/index.md | 19 +- .../aws/apigatewayv2/domain_name/index.md | 31 +-- .../aws/apigatewayv2/domain_names/index.md | 17 +- .../integration_response/index.md | 35 ++-- .../integration_responses/index.md | 21 ++- .../providers/aws/apigatewayv2/model/index.md | 31 +-- .../aws/apigatewayv2/models/index.md | 19 +- .../providers/aws/apigatewayv2/route/index.md | 45 ++--- .../aws/apigatewayv2/route_response/index.md | 33 ++-- .../aws/apigatewayv2/route_responses/index.md | 21 ++- .../aws/apigatewayv2/routes/index.md | 19 +- .../aws/apigatewayv2/vpc_link/index.md | 29 +-- .../aws/apigatewayv2/vpc_links/index.md | 17 +- .../aws/appconfig/application/index.md | 27 +-- .../aws/appconfig/applications/index.md | 17 +- .../appconfig/configuration_profile/index.md | 41 ++-- .../appconfig/configuration_profiles/index.md | 19 +- .../aws/appconfig/environment/index.md | 31 +-- .../aws/appconfig/environments/index.md | 19 +- .../aws/appconfig/extension/index.md | 37 ++-- .../appconfig/extension_association/index.md | 37 ++-- .../appconfig/extension_associations/index.md | 17 +- .../aws/appconfig/extensions/index.md | 17 +- .../hosted_configuration_version/index.md | 31 +-- .../hosted_configuration_versions/index.md | 21 ++- .../providers/aws/appflow/connector/index.md | 29 +-- .../aws/appflow/connector_profile/index.md | 35 ++-- .../aws/appflow/connector_profiles/index.md | 17 +- .../providers/aws/appflow/connectors/index.md | 17 +- .../providers/aws/appflow/flow/index.md | 41 ++-- .../providers/aws/appflow/flows/index.md | 17 +- .../aws/appintegrations/application/index.md | 35 ++-- .../aws/appintegrations/applications/index.md | 17 +- .../appintegrations/data_integration/index.md | 39 ++-- .../data_integrations/index.md | 17 +- .../event_integration/index.md | 31 +-- .../event_integrations/index.md | 17 +- .../scalable_target/index.md | 37 ++-- .../scalable_targets/index.md | 21 ++- .../scaling_policies/index.md | 19 +- .../scaling_policy/index.md | 37 ++-- .../applicationinsights/application/index.md | 43 +++-- .../applicationinsights/applications/index.md | 17 +- .../auto_scaling_configuration/index.md | 31 +-- .../auto_scaling_configurations/index.md | 17 +- .../observability_configuration/index.md | 27 +-- .../observability_configurations/index.md | 17 +- .../providers/aws/apprunner/service/index.md | 45 ++--- .../providers/aws/apprunner/services/index.md | 17 +- .../aws/apprunner/vpc_connector/index.md | 27 +-- .../aws/apprunner/vpc_connectors/index.md | 17 +- .../apprunner/vpc_ingress_connection/index.md | 33 ++-- .../vpc_ingress_connections/index.md | 17 +- .../aws/appstream/app_block/index.md | 35 ++-- .../aws/appstream/app_block_builder/index.md | 45 ++--- .../aws/appstream/app_block_builders/index.md | 17 +- .../aws/appstream/app_blocks/index.md | 17 +- .../aws/appstream/application/index.md | 47 ++--- .../index.md | 21 ++- .../index.md | 21 ++- .../application_fleet_association/index.md | 19 +- .../application_fleet_associations/index.md | 19 +- .../aws/appstream/applications/index.md | 17 +- .../aws/appstream/directory_config/index.md | 27 +-- .../aws/appstream/directory_configs/index.md | 17 +- .../aws/appstream/entitlement/index.md | 33 ++-- .../aws/appstream/entitlements/index.md | 19 +- .../aws/appstream/image_builder/index.md | 43 +++-- .../aws/appstream/image_builders/index.md | 17 +- .../aws/appsync/domain_name/index.md | 29 +-- .../domain_name_api_association/index.md | 25 +-- .../domain_name_api_associations/index.md | 17 +- .../aws/appsync/domain_names/index.md | 17 +- .../appsync/function_configuration/index.md | 51 ++--- .../appsync/function_configurations/index.md | 17 +- .../providers/aws/appsync/resolver/index.md | 55 +++--- .../providers/aws/appsync/resolvers/index.md | 17 +- .../appsync/source_api_association/index.md | 45 ++--- .../appsync/source_api_associations/index.md | 17 +- .../aws/aps/rule_groups_namespace/index.md | 29 +-- .../aws/aps/rule_groups_namespaces/index.md | 17 +- .../providers/aws/aps/scraper/index.md | 35 ++-- .../providers/aws/aps/scrapers/index.md | 17 +- .../providers/aws/aps/workspace/index.md | 35 ++-- .../providers/aws/aps/workspaces/index.md | 17 +- .../zonal_autoshift_configuration/index.md | 25 +-- .../zonal_autoshift_configurations/index.md | 17 +- .../aws/athena/capacity_reservation/index.md | 37 ++-- .../aws/athena/capacity_reservations/index.md | 17 +- .../aws/athena/data_catalog/index.md | 29 +-- .../aws/athena/data_catalogs/index.md | 17 +- .../aws/athena/named_queries/index.md | 17 +- .../providers/aws/athena/named_query/index.md | 27 +-- .../aws/athena/prepared_statement/index.md | 27 +-- .../aws/athena/prepared_statements/index.md | 19 +- .../providers/aws/athena/work_group/index.md | 35 ++-- .../providers/aws/athena/work_groups/index.md | 17 +- .../aws/auditmanager/assessment/index.md | 45 ++--- .../aws/auditmanager/assessments/index.md | 17 +- .../autoscaling/auto_scaling_group/index.md | 79 ++++---- .../autoscaling/auto_scaling_groups/index.md | 17 +- .../autoscaling/launch_configuration/index.md | 53 +++--- .../launch_configurations/index.md | 17 +- .../aws/autoscaling/lifecycle_hook/index.md | 35 ++-- .../aws/autoscaling/lifecycle_hooks/index.md | 19 +- .../aws/autoscaling/scaling_policies/index.md | 17 +- .../aws/autoscaling/scaling_policy/index.md | 45 ++--- .../aws/autoscaling/scheduled_action/index.md | 37 ++-- .../autoscaling/scheduled_actions/index.md | 19 +- .../aws/autoscaling/warm_pool/index.md | 29 +-- .../aws/autoscaling/warm_pools/index.md | 17 +- .../providers/aws/b2bi/capabilities/index.md | 17 +- .../providers/aws/b2bi/capability/index.md | 37 ++-- .../providers/aws/b2bi/partnership/index.md | 41 ++-- .../providers/aws/b2bi/partnerships/index.md | 17 +- .../providers/aws/b2bi/profile/index.md | 41 ++-- .../providers/aws/b2bi/profiles/index.md | 17 +- .../providers/aws/b2bi/transformer/index.md | 41 ++-- .../providers/aws/b2bi/transformers/index.md | 17 +- .../providers/aws/backup/backup_plan/index.md | 29 +-- .../aws/backup/backup_plans/index.md | 17 +- .../aws/backup/backup_selection/index.md | 23 ++- .../aws/backup/backup_selections/index.md | 17 +- .../aws/backup/backup_vault/index.md | 33 ++-- .../aws/backup/backup_vaults/index.md | 17 +- .../providers/aws/backup/framework/index.md | 35 ++-- .../providers/aws/backup/frameworks/index.md | 17 +- .../providers/aws/backup/report_plan/index.md | 31 +-- .../aws/backup/report_plans/index.md | 17 +- .../aws/backup/restore_testing_plan/index.md | 33 ++-- .../aws/backup/restore_testing_plans/index.md | 17 +- .../backup/restore_testing_selection/index.md | 35 ++-- .../restore_testing_selections/index.md | 19 +- .../aws/backupgateway/hypervisor/index.md | 35 ++-- .../aws/backupgateway/hypervisors/index.md | 17 +- .../aws/batch/compute_environment/index.md | 41 ++-- .../aws/batch/compute_environments/index.md | 17 +- .../providers/aws/batch/job_queue/index.md | 35 ++-- .../providers/aws/batch/job_queues/index.md | 17 +- .../aws/batch/scheduling_policies/index.md | 17 +- .../aws/batch/scheduling_policy/index.md | 27 +-- .../aws/bcmdataexports/export/index.md | 25 +-- .../aws/bcmdataexports/exports/index.md | 17 +- .../providers/aws/bedrock/agent/index.md | 63 ++++--- .../aws/bedrock/agent_alias/index.md | 41 ++-- .../aws/bedrock/agent_aliases/index.md | 19 +- .../providers/aws/bedrock/agents/index.md | 17 +- .../aws/bedrock/data_source/index.md | 39 ++-- .../aws/bedrock/data_sources/index.md | 19 +- .../aws/bedrock/knowledge_base/index.md | 43 +++-- .../aws/bedrock/knowledge_bases/index.md | 17 +- .../billingconductor/billing_group/index.md | 43 +++-- .../billingconductor/billing_groups/index.md | 17 +- .../custom_line_item/index.md | 45 ++--- .../custom_line_items/index.md | 17 +- .../billingconductor/pricing_plan/index.md | 35 ++-- .../billingconductor/pricing_plans/index.md | 17 +- .../billingconductor/pricing_rule/index.md | 49 ++--- .../billingconductor/pricing_rules/index.md | 17 +- .../aws/budgets/budgets_action/index.md | 37 ++-- .../aws/budgets/budgets_actions/index.md | 19 +- .../providers/aws/cassandra/keyspace/index.md | 25 +-- .../aws/cassandra/keyspaces/index.md | 17 +- .../providers/aws/cassandra/table/index.md | 45 ++--- .../providers/aws/cassandra/tables/index.md | 19 +- .../providers/aws/ce/anomaly_monitor/index.md | 39 ++-- .../aws/ce/anomaly_monitors/index.md | 17 +- .../aws/ce/anomaly_subscription/index.md | 37 ++-- .../aws/ce/anomaly_subscriptions/index.md | 17 +- .../providers/aws/ce/cost_categories/index.md | 17 +- .../providers/aws/ce/cost_category/index.md | 33 ++-- .../aws/certificatemanager/account/index.md | 23 ++- .../aws/certificatemanager/accounts/index.md | 17 +- .../index.md | 39 ++-- .../index.md | 17 +- .../slack_channel_configuration/index.md | 37 ++-- .../slack_channel_configurations/index.md | 17 +- .../aws/cleanrooms/analysis_template/index.md | 45 ++--- .../cleanrooms/analysis_templates/index.md | 19 +- .../aws/cleanrooms/collaboration/index.md | 41 ++-- .../aws/cleanrooms/collaborations/index.md | 17 +- .../aws/cleanrooms/configured_table/index.md | 37 ++-- .../configured_table_association/index.md | 35 ++-- .../configured_table_associations/index.md | 19 +- .../aws/cleanrooms/configured_tables/index.md | 17 +- .../aws/cleanrooms/membership/index.md | 37 ++-- .../aws/cleanrooms/memberships/index.md | 17 +- .../privacy_budget_template/index.md | 39 ++-- .../privacy_budget_templates/index.md | 19 +- .../cleanroomsml/training_dataset/index.md | 33 ++-- .../cleanroomsml/training_datasets/index.md | 17 +- .../hook_default_version/index.md | 27 +-- .../hook_default_versions/index.md | 17 +- .../cloudformation/hook_type_config/index.md | 29 +-- .../cloudformation/hook_type_configs/index.md | 17 +- .../aws/cloudformation/hook_version/index.md | 33 ++-- .../aws/cloudformation/hook_versions/index.md | 17 +- .../module_default_version/index.md | 21 ++- .../module_default_versions/index.md | 17 +- .../cloudformation/module_version/index.md | 35 ++-- .../cloudformation/module_versions/index.md | 17 +- .../public_type_version/index.md | 31 +-- .../public_type_versions/index.md | 17 +- .../aws/cloudformation/publisher/index.md | 27 +-- .../aws/cloudformation/publishers/index.md | 17 +- .../resource_default_version/index.md | 27 +-- .../resource_default_versions/index.md | 17 +- .../cloudformation/resource_version/index.md | 35 ++-- .../cloudformation/resource_versions/index.md | 17 +- .../aws/cloudformation/stack/index.md | 65 ++++--- .../aws/cloudformation/stack_set/index.md | 51 ++--- .../aws/cloudformation/stack_sets/index.md | 17 +- .../aws/cloudformation/stacks/index.md | 17 +- .../cloudformation/type_activation/index.md | 41 ++-- .../cloudformation/type_activations/index.md | 17 +- .../aws/cloudfront/cache_policies/index.md | 17 +- .../aws/cloudfront/cache_policy/index.md | 25 +-- .../index.md | 17 +- .../index.md | 25 +-- .../continuous_deployment_policies/index.md | 17 +- .../continuous_deployment_policy/index.md | 25 +-- .../aws/cloudfront/distribution/index.md | 27 +-- .../aws/cloudfront/distributions/index.md | 17 +- .../aws/cloudfront/function/index.md | 33 ++-- .../aws/cloudfront/functions/index.md | 17 +- .../aws/cloudfront/key_group/index.md | 25 +-- .../aws/cloudfront/key_groups/index.md | 17 +- .../aws/cloudfront/key_value_store/index.md | 31 +-- .../aws/cloudfront/key_value_stores/index.md | 17 +- .../monitoring_subscription/index.md | 19 +- .../monitoring_subscriptions/index.md | 17 +- .../cloudfront/origin_access_control/index.md | 23 ++- .../origin_access_controls/index.md | 17 +- .../origin_request_policies/index.md | 17 +- .../cloudfront/origin_request_policy/index.md | 25 +-- .../aws/cloudfront/public_key/index.md | 25 +-- .../aws/cloudfront/public_keys/index.md | 17 +- .../cloudfront/realtime_log_config/index.md | 29 +-- .../cloudfront/realtime_log_configs/index.md | 17 +- .../response_headers_policies/index.md | 17 +- .../response_headers_policy/index.md | 25 +-- .../providers/aws/cloudtrail/channel/index.md | 29 +-- .../aws/cloudtrail/channels/index.md | 17 +- .../aws/cloudtrail/event_data_store/index.md | 55 +++--- .../aws/cloudtrail/event_data_stores/index.md | 17 +- .../aws/cloudtrail/resource_policies/index.md | 17 +- .../aws/cloudtrail/resource_policy/index.md | 23 ++- .../providers/aws/cloudtrail/trail/index.md | 55 +++--- .../providers/aws/cloudtrail/trails/index.md | 17 +- .../providers/aws/cloudwatch/alarm/index.md | 65 ++++--- .../providers/aws/cloudwatch/alarms/index.md | 17 +- .../aws/cloudwatch/composite_alarm/index.md | 43 +++-- .../aws/cloudwatch/composite_alarms/index.md | 17 +- .../aws/cloudwatch/metric_stream/index.md | 45 ++--- .../aws/cloudwatch/metric_streams/index.md | 17 +- .../aws/codeartifact/domain/index.md | 33 ++-- .../aws/codeartifact/domains/index.md | 17 +- .../aws/codeartifact/package_group/index.md | 35 ++-- .../aws/codeartifact/package_groups/index.md | 17 +- .../aws/codeartifact/repositories/index.md | 17 +- .../aws/codeartifact/repository/index.md | 39 ++-- .../providers/aws/codebuild/fleet/index.md | 31 +-- .../providers/aws/codebuild/fleets/index.md | 17 +- .../aws/codeconnections/connection/index.md | 33 ++-- .../aws/codeconnections/connections/index.md | 17 +- .../aws/codedeploy/application/index.md | 25 +-- .../aws/codedeploy/applications/index.md | 17 +- .../aws/codedeploy/deployment_config/index.md | 25 +-- .../codedeploy/deployment_configs/index.md | 17 +- .../codeguruprofiler/profiling_group/index.md | 31 +-- .../profiling_groups/index.md | 17 +- .../repository_association/index.md | 29 +-- .../repository_associations/index.md | 17 +- .../codepipeline/custom_action_type/index.md | 37 ++-- .../codepipeline/custom_action_types/index.md | 21 ++- .../codestarconnections/connection/index.md | 33 ++-- .../codestarconnections/connections/index.md | 17 +- .../repository_link/index.md | 35 ++-- .../repository_links/index.md | 17 +- .../sync_configuration/index.md | 41 ++-- .../sync_configurations/index.md | 19 +- .../notification_rule/index.md | 41 ++-- .../notification_rules/index.md | 17 +- .../aws/cognito/identity_pool/index.md | 45 ++--- .../identity_pool_principal_tag/index.md | 27 +-- .../identity_pool_principal_tags/index.md | 19 +- .../identity_pool_role_attachment/index.md | 27 +-- .../identity_pool_role_attachments/index.md | 17 +- .../aws/cognito/identity_pools/index.md | 17 +- .../log_delivery_configuration/index.md | 25 +-- .../log_delivery_configurations/index.md | 17 +- .../providers/aws/cognito/user_pool/index.md | 75 ++++---- .../aws/cognito/user_pool_client/index.md | 69 +++---- .../aws/cognito/user_pool_clients/index.md | 19 +- .../aws/cognito/user_pool_group/index.md | 29 +-- .../aws/cognito/user_pool_groups/index.md | 19 +- .../index.md | 29 +-- .../index.md | 19 +- .../aws/cognito/user_pool_user/index.md | 31 +-- .../index.md | 21 ++- .../index.md | 21 ++- .../aws/cognito/user_pool_users/index.md | 19 +- .../providers/aws/cognito/user_pools/index.md | 17 +- .../comprehend/document_classifier/index.md | 45 ++--- .../comprehend/document_classifiers/index.md | 17 +- .../aws/comprehend/flywheel/index.md | 37 ++-- .../aws/comprehend/flywheels/index.md | 17 +- .../config/aggregation_authorization/index.md | 27 +-- .../aggregation_authorizations/index.md | 19 +- .../providers/aws/config/config_rule/index.md | 39 ++-- .../aws/config/config_rules/index.md | 17 +- .../config/configuration_aggregator/index.md | 29 +-- .../config/configuration_aggregators/index.md | 17 +- .../aws/config/conformance_pack/index.md | 33 ++-- .../aws/config/conformance_packs/index.md | 17 +- .../organization_conformance_pack/index.md | 33 ++-- .../organization_conformance_packs/index.md | 17 +- .../aws/config/stored_queries/index.md | 17 +- .../aws/config/stored_query/index.md | 31 +-- .../aws/connect/approved_origin/index.md | 23 ++- .../aws/connect/approved_origins/index.md | 19 +- .../aws/connect/contact_flow/index.md | 35 ++-- .../aws/connect/contact_flow_module/index.md | 35 ++-- .../aws/connect/contact_flow_modules/index.md | 17 +- .../aws/connect/contact_flows/index.md | 17 +- .../aws/connect/evaluation_form/index.md | 35 ++-- .../aws/connect/evaluation_forms/index.md | 17 +- .../aws/connect/hours_of_operation/index.md | 33 ++-- .../aws/connect/hours_of_operations/index.md | 17 +- .../providers/aws/connect/instance/index.md | 39 ++-- .../connect/instance_storage_config/index.md | 35 ++-- .../connect/instance_storage_configs/index.md | 21 ++- .../providers/aws/connect/instances/index.md | 17 +- .../connect/integration_association/index.md | 27 +-- .../connect/integration_associations/index.md | 21 ++- .../aws/connect/predefined_attribute/index.md | 29 +-- .../connect/predefined_attributes/index.md | 19 +- .../providers/aws/connect/prompt/index.md | 31 +-- .../providers/aws/connect/prompts/index.md | 17 +- .../providers/aws/connect/queue/index.md | 41 ++-- .../providers/aws/connect/queues/index.md | 17 +- .../aws/connect/quick_connect/index.md | 33 ++-- .../aws/connect/quick_connects/index.md | 17 +- .../aws/connect/routing_profile/index.md | 37 ++-- .../aws/connect/routing_profiles/index.md | 17 +- .../providers/aws/connect/rule/index.md | 35 ++-- .../providers/aws/connect/rules/index.md | 17 +- .../aws/connect/security_key/index.md | 25 +-- .../aws/connect/security_keys/index.md | 19 +- .../aws/connect/security_profile/index.md | 45 ++--- .../aws/connect/security_profiles/index.md | 17 +- .../aws/connect/task_template/index.md | 41 ++-- .../aws/connect/task_templates/index.md | 17 +- .../traffic_distribution_group/index.md | 33 ++-- .../traffic_distribution_groups/index.md | 17 +- .../providers/aws/connect/user/index.md | 43 +++-- .../aws/connect/user_hierarchy_group/index.md | 29 +-- .../connect/user_hierarchy_groups/index.md | 17 +- .../providers/aws/connect/users/index.md | 17 +- .../providers/aws/connect/view/index.md | 37 ++-- .../aws/connect/view_version/index.md | 29 +-- .../aws/connect/view_versions/index.md | 17 +- .../providers/aws/connect/views/index.md | 17 +- .../aws/connectcampaigns/campaign/index.md | 31 +-- .../aws/connectcampaigns/campaigns/index.md | 17 +- .../controltower/enabled_baseline/index.md | 31 +-- .../controltower/enabled_baselines/index.md | 17 +- .../aws/controltower/enabled_control/index.md | 27 +-- .../controltower/enabled_controls/index.md | 19 +- .../aws/controltower/landing_zone/index.md | 35 ++-- .../aws/controltower/landing_zones/index.md | 17 +- .../aws/cur/report_definition/index.md | 43 +++-- .../aws/cur/report_definitions/index.md | 17 +- .../calculated_attribute_definition/index.md | 39 ++-- .../calculated_attribute_definitions/index.md | 19 +- .../aws/customerprofiles/domain/index.md | 39 ++-- .../aws/customerprofiles/domains/index.md | 17 +- .../customerprofiles/event_stream/index.md | 35 ++-- .../customerprofiles/event_streams/index.md | 19 +- .../aws/customerprofiles/integration/index.md | 35 ++-- .../customerprofiles/integrations/index.md | 19 +- .../aws/customerprofiles/object_type/index.md | 45 ++--- .../customerprofiles/object_types/index.md | 19 +- .../providers/aws/databrew/dataset/index.md | 31 +-- .../providers/aws/databrew/datasets/index.md | 17 +- .../providers/aws/databrew/job/index.md | 59 +++--- .../providers/aws/databrew/jobs/index.md | 17 +- .../providers/aws/databrew/project/index.md | 31 +-- .../providers/aws/databrew/projects/index.md | 17 +- .../providers/aws/databrew/recipe/index.md | 27 +-- .../providers/aws/databrew/recipes/index.md | 17 +- .../providers/aws/databrew/ruleset/index.md | 29 +-- .../providers/aws/databrew/rulesets/index.md | 17 +- .../providers/aws/databrew/schedule/index.md | 27 +-- .../providers/aws/databrew/schedules/index.md | 17 +- .../aws/datapipeline/pipeline/index.md | 35 ++-- .../aws/datapipeline/pipelines/index.md | 17 +- .../providers/aws/datasync/agent/index.md | 35 ++-- .../providers/aws/datasync/agents/index.md | 17 +- .../aws/datasync/location_azure_blob/index.md | 39 ++-- .../datasync/location_azure_blobs/index.md | 17 +- .../aws/datasync/location_efs/index.md | 37 ++-- .../aws/datasync/location_hdfs/index.md | 49 ++--- .../aws/datasync/location_nfs/index.md | 33 ++-- .../datasync/location_object_storage/index.md | 43 +++-- .../location_object_storages/index.md | 17 +- .../aws/datasync/location_s3/index.md | 33 ++-- .../aws/datasync/location_s3s/index.md | 17 +- .../aws/datasync/location_smb/index.md | 39 ++-- .../aws/datasync/location_smbs/index.md | 17 +- .../aws/datasync/locationf_sx_lustre/index.md | 31 +-- .../datasync/locationf_sx_lustres/index.md | 17 +- .../aws/datasync/locationf_sx_ontap/index.md | 35 ++-- .../aws/datasync/locationf_sx_ontaps/index.md | 17 +- .../datasync/locationf_sx_open_zfs/index.md | 33 ++-- .../datasync/locationf_sx_windows/index.md | 37 ++-- .../aws/datasync/storage_system/index.md | 39 ++-- .../aws/datasync/storage_systems/index.md | 17 +- .../providers/aws/datasync/task/index.md | 49 ++--- .../providers/aws/datasync/tasks/index.md | 17 +- .../aws/datazone/data_source/index.md | 63 ++++--- .../aws/datazone/data_sources/index.md | 19 +- .../providers/aws/datazone/domain/index.md | 45 ++--- .../providers/aws/datazone/domains/index.md | 17 +- .../aws/datazone/environment/index.md | 57 +++--- .../index.md | 39 ++-- .../index.md | 19 +- .../aws/datazone/environment_profile/index.md | 49 ++--- .../datazone/environment_profiles/index.md | 19 +- .../aws/datazone/environments/index.md | 19 +- .../providers/aws/datazone/project/index.md | 37 ++-- .../providers/aws/datazone/projects/index.md | 19 +- .../aws/datazone/subscription_target/index.md | 53 +++--- .../datazone/subscription_targets/index.md | 21 ++- .../providers/aws/deadline/farm/index.md | 29 +-- .../providers/aws/deadline/farms/index.md | 17 +- .../providers/aws/deadline/fleet/index.md | 43 +++-- .../providers/aws/deadline/fleets/index.md | 17 +- .../aws/deadline/license_endpoint/index.md | 31 +-- .../aws/deadline/license_endpoints/index.md | 17 +- .../aws/deadline/metered_product/index.md | 27 +-- .../aws/deadline/metered_products/index.md | 17 +- .../providers/aws/deadline/queue/index.md | 41 ++-- .../aws/deadline/queue_environment/index.md | 33 ++-- .../aws/deadline/queue_environments/index.md | 21 ++- .../deadline/queue_fleet_association/index.md | 21 ++- .../queue_fleet_associations/index.md | 21 ++- .../providers/aws/deadline/queues/index.md | 17 +- .../aws/deadline/storage_profile/index.md | 29 +-- .../aws/deadline/storage_profiles/index.md | 19 +- .../providers/aws/detective/graph/index.md | 25 +-- .../providers/aws/detective/graphs/index.md | 17 +- .../aws/detective/member_invitation/index.md | 29 +-- .../aws/detective/member_invitations/index.md | 19 +- .../aws/detective/organization_admin/index.md | 23 ++- .../detective/organization_admins/index.md | 17 +- .../index.md | 21 ++- .../index.md | 17 +- .../devopsguru/notification_channel/index.md | 19 +- .../devopsguru/notification_channels/index.md | 17 +- .../devopsguru/resource_collection/index.md | 23 ++- .../devopsguru/resource_collections/index.md | 17 +- .../aws/directoryservice/simple_ad/index.md | 41 ++-- .../aws/directoryservice/simple_ads/index.md | 17 +- .../providers/aws/dms/data_provider/index.md | 37 ++-- .../providers/aws/dms/data_providers/index.md | 17 +- .../aws/dms/instance_profile/index.md | 43 +++-- .../aws/dms/instance_profiles/index.md | 17 +- .../aws/dms/migration_project/index.md | 45 ++--- .../aws/dms/migration_projects/index.md | 17 +- .../aws/dms/replication_config/index.md | 41 ++-- .../aws/dms/replication_configs/index.md | 17 +- .../aws/docdbelastic/cluster/index.md | 51 ++--- .../aws/docdbelastic/clusters/index.md | 17 +- .../aws/dynamodb/global_table/index.md | 47 ++--- .../aws/dynamodb/global_tables/index.md | 17 +- .../providers/aws/dynamodb/table/index.md | 59 +++--- .../providers/aws/dynamodb/tables/index.md | 17 +- .../aws/ec2/capacity_reservation/index.md | 51 ++--- .../ec2/capacity_reservation_fleet/index.md | 39 ++-- .../ec2/capacity_reservation_fleets/index.md | 17 +- .../aws/ec2/capacity_reservations/index.md | 17 +- .../aws/ec2/carrier_gateway/index.md | 29 +-- .../aws/ec2/carrier_gateways/index.md | 17 +- .../aws/ec2/customer_gateway/index.md | 33 ++-- .../aws/ec2/customer_gateways/index.md | 17 +- .../providers/aws/ec2/dhcp_options/index.md | 35 ++-- .../providers/aws/ec2/ec2fleet/index.md | 45 ++--- .../providers/aws/ec2/ec2fleets/index.md | 17 +- .../ec2/egress_only_internet_gateway/index.md | 19 +- .../egress_only_internet_gateways/index.md | 17 +- docs/aws-docs/providers/aws/ec2/eip/index.md | 35 ++-- .../aws/ec2/eip_association/index.md | 27 +-- .../aws/ec2/eip_associations/index.md | 17 +- docs/aws-docs/providers/aws/ec2/eips/index.md | 19 +- .../index.md | 25 +-- .../index.md | 19 +- .../providers/aws/ec2/flow_log/index.md | 45 ++--- .../providers/aws/ec2/flow_logs/index.md | 17 +- .../gateway_route_table_association/index.md | 25 +-- .../gateway_route_table_associations/index.md | 17 +- docs/aws-docs/providers/aws/ec2/host/index.md | 37 ++-- .../aws-docs/providers/aws/ec2/hosts/index.md | 17 +- .../providers/aws/ec2/instance/index.md | 111 +++++------ .../ec2/instance_connect_endpoint/index.md | 31 +-- .../ec2/instance_connect_endpoints/index.md | 17 +- .../providers/aws/ec2/instances/index.md | 17 +- .../aws/ec2/internet_gateway/index.md | 23 ++- .../aws/ec2/internet_gateways/index.md | 17 +- docs/aws-docs/providers/aws/ec2/ipam/index.md | 43 +++-- .../aws/ec2/ipam_allocation/index.md | 25 +-- .../aws/ec2/ipam_allocations/index.md | 21 ++- .../providers/aws/ec2/ipam_pool/index.md | 67 +++---- .../providers/aws/ec2/ipam_pool_cidr/index.md | 25 +-- .../aws/ec2/ipam_pool_cidrs/index.md | 19 +- .../providers/aws/ec2/ipam_pools/index.md | 17 +- .../ec2/ipam_resource_discoveries/index.md | 17 +- .../aws/ec2/ipam_resource_discovery/index.md | 37 ++-- .../index.md | 41 ++-- .../index.md | 17 +- .../providers/aws/ec2/ipam_scope/index.md | 37 ++-- .../providers/aws/ec2/ipam_scopes/index.md | 17 +- .../aws-docs/providers/aws/ec2/ipams/index.md | 17 +- .../providers/aws/ec2/key_pair/index.md | 29 +-- .../providers/aws/ec2/key_pairs/index.md | 17 +- .../aws/ec2/launch_template/index.md | 33 ++-- .../aws/ec2/launch_templates/index.md | 17 +- .../aws/ec2/local_gateway_route/index.md | 31 +-- .../ec2/local_gateway_route_table/index.md | 35 ++-- .../index.md | 35 ++-- .../index.md | 17 +- .../ec2/local_gateway_route_tables/index.md | 17 +- .../index.md | 31 +-- .../index.md | 17 +- .../aws/ec2/local_gateway_routes/index.md | 19 +- .../providers/aws/ec2/nat_gateway/index.md | 39 ++-- .../providers/aws/ec2/nat_gateways/index.md | 17 +- .../providers/aws/ec2/network_acl/index.md | 25 +-- .../providers/aws/ec2/network_acls/index.md | 17 +- .../network_insights_access_scope/index.md | 33 ++-- .../index.md | 17 +- .../index.md | 39 ++-- .../network_insights_access_scopes/index.md | 17 +- .../ec2/network_insights_analyses/index.md | 17 +- .../ec2/network_insights_analysis/index.md | 49 ++--- .../aws/ec2/network_insights_path/index.md | 47 ++--- .../aws/ec2/network_insights_paths/index.md | 17 +- .../aws/ec2/network_interface/index.md | 63 ++++--- .../ec2/network_interface_attachment/index.md | 31 +-- .../network_interface_attachments/index.md | 17 +- .../aws/ec2/network_interfaces/index.md | 17 +- .../index.md | 23 ++- .../index.md | 23 ++- .../aws/ec2/placement_group/index.md | 25 +-- .../aws/ec2/placement_groups/index.md | 17 +- .../providers/aws/ec2/prefix_list/index.md | 37 ++-- .../providers/aws/ec2/prefix_lists/index.md | 17 +- .../aws-docs/providers/aws/ec2/route/index.md | 51 ++--- .../providers/aws/ec2/route_table/index.md | 25 +-- .../providers/aws/ec2/route_tables/index.md | 17 +- .../providers/aws/ec2/routes/index.md | 19 +- .../providers/aws/ec2/security_group/index.md | 35 ++-- .../aws/ec2/security_group_egress/index.md | 39 ++-- .../aws/ec2/security_group_egresses/index.md | 17 +- .../aws/ec2/security_group_ingress/index.md | 45 ++--- .../aws/ec2/security_group_ingresses/index.md | 17 +- .../aws/ec2/security_groups/index.md | 17 +- .../ec2/snapshot_block_public_access/index.md | 23 ++- .../snapshot_block_public_accesses/index.md | 17 +- .../providers/aws/ec2/snapshots/index.md | 47 ++--- .../providers/aws/ec2/spot_fleet/index.md | 23 ++- .../providers/aws/ec2/spot_fleets/index.md | 17 +- .../providers/aws/ec2/subnet/index.md | 59 +++--- .../aws/ec2/subnet_cidr_block/index.md | 25 +-- .../aws/ec2/subnet_cidr_blocks/index.md | 17 +- .../subnet_network_acl_association/index.md | 21 ++- .../subnet_network_acl_associations/index.md | 17 +- .../subnet_route_table_association/index.md | 21 ++- .../subnet_route_table_associations/index.md | 17 +- .../providers/aws/ec2/subnets/index.md | 17 +- .../aws/ec2/transit_gateway/index.md | 47 ++--- .../ec2/transit_gateway_attachment/index.md | 31 +-- .../ec2/transit_gateway_attachments/index.md | 17 +- .../aws/ec2/transit_gateway_connect/index.md | 33 ++-- .../aws/ec2/transit_gateway_connects/index.md | 17 +- .../transit_gateway_multicast_domain/index.md | 33 ++-- .../index.md | 27 +-- .../index.md | 21 ++- .../index.md | 17 +- .../index.md | 37 ++-- .../index.md | 21 ++- .../index.md | 37 ++-- .../index.md | 21 ++- .../index.md | 37 ++-- .../index.md | 17 +- .../ec2/transit_gateway_route_table/index.md | 21 ++- .../index.md | 19 +- .../index.md | 19 +- .../ec2/transit_gateway_route_tables/index.md | 17 +- .../transit_gateway_vpc_attachment/index.md | 35 ++-- .../transit_gateway_vpc_attachments/index.md | 17 +- .../aws/ec2/transit_gateways/index.md | 17 +- .../aws/ec2/verified_access_endpoint/index.md | 61 +++--- .../ec2/verified_access_endpoints/index.md | 17 +- .../aws/ec2/verified_access_group/index.md | 41 ++-- .../aws/ec2/verified_access_groups/index.md | 17 +- .../aws/ec2/verified_access_instance/index.md | 37 ++-- .../ec2/verified_access_instances/index.md | 17 +- .../verified_access_trust_provider/index.md | 43 +++-- .../verified_access_trust_providers/index.md | 17 +- .../providers/aws/ec2/volume/index.md | 45 ++--- .../aws/ec2/volume_attachment/index.md | 21 ++- .../aws/ec2/volume_attachments/index.md | 19 +- .../providers/aws/ec2/volumes/index.md | 17 +- docs/aws-docs/providers/aws/ec2/vpc/index.md | 43 +++-- .../providers/aws/ec2/vpc_cidr_block/index.md | 35 ++-- .../aws/ec2/vpc_cidr_blocks/index.md | 19 +- .../providers/aws/ec2/vpc_endpoint/index.md | 43 +++-- .../index.md | 29 +-- .../index.md | 17 +- .../aws/ec2/vpc_endpoint_service/index.md | 31 +-- .../vpc_endpoint_service_permissions/index.md | 23 ++- .../aws/ec2/vpc_endpoint_services/index.md | 17 +- .../providers/aws/ec2/vpc_endpoints/index.md | 17 +- .../aws/ec2/vpc_gateway_attachment/index.md | 27 +-- .../aws/ec2/vpc_gateway_attachments/index.md | 19 +- .../aws/ec2/vpc_peering_connection/index.md | 33 ++-- .../aws/ec2/vpc_peering_connections/index.md | 17 +- .../ec2/vpcdhcp_options_association/index.md | 23 ++- .../ec2/vpcdhcp_options_associations/index.md | 19 +- docs/aws-docs/providers/aws/ec2/vpcs/index.md | 17 +- .../providers/aws/ec2/vpn_connection/index.md | 35 ++-- .../aws/ec2/vpn_connection_route/index.md | 19 +- .../aws/ec2/vpn_connection_routes/index.md | 19 +- .../aws/ec2/vpn_connections/index.md | 17 +- .../providers/aws/ec2/vpn_gateway/index.md | 27 +-- .../providers/aws/ec2/vpn_gateways/index.md | 17 +- .../aws/ecr/public_repositories/index.md | 17 +- .../aws/ecr/public_repository/index.md | 29 +-- .../aws/ecr/pull_through_cache_rule/index.md | 27 +-- .../aws/ecr/pull_through_cache_rules/index.md | 17 +- .../aws/ecr/registry_policies/index.md | 17 +- .../aws/ecr/registry_policy/index.md | 23 ++- .../ecr/replication_configuration/index.md | 23 ++- .../ecr/replication_configurations/index.md | 17 +- .../providers/aws/ecr/repositories/index.md | 17 +- .../providers/aws/ecr/repository/index.md | 39 ++-- .../ecr/repository_creation_template/index.md | 39 ++-- .../repository_creation_templates/index.md | 17 +- .../index.md | 25 +-- .../aws/ecs/primary_task_set/index.md | 25 +-- .../aws/ecs/primary_task_sets/index.md | 19 +- .../providers/aws/ecs/service/index.md | 69 +++---- .../providers/aws/ecs/services/index.md | 19 +- .../aws/ecs/task_definition/index.md | 55 +++--- .../aws/ecs/task_definitions/index.md | 17 +- .../providers/aws/ecs/task_set/index.md | 43 +++-- .../providers/aws/ecs/task_sets/index.md | 21 ++- .../providers/aws/efs/access_point/index.md | 33 ++-- .../providers/aws/efs/access_points/index.md | 17 +- .../providers/aws/efs/file_system/index.md | 49 ++--- .../providers/aws/efs/file_systems/index.md | 17 +- .../providers/aws/efs/mount_target/index.md | 29 +-- .../providers/aws/efs/mount_targets/index.md | 17 +- .../providers/aws/eks/access_entries/index.md | 19 +- .../providers/aws/eks/access_entry/index.md | 35 ++-- .../aws-docs/providers/aws/eks/addon/index.md | 37 ++-- .../providers/aws/eks/addons/index.md | 19 +- .../providers/aws/eks/cluster/index.md | 53 +++--- .../providers/aws/eks/clusters/index.md | 17 +- .../aws/eks/fargate_profile/index.md | 33 ++-- .../aws/eks/fargate_profiles/index.md | 19 +- .../aws/eks/identity_provider_config/index.md | 31 +-- .../eks/identity_provider_configs/index.md | 21 ++- .../providers/aws/eks/nodegroup/index.md | 59 +++--- .../providers/aws/eks/nodegroups/index.md | 17 +- .../aws/eks/pod_identity_association/index.md | 33 ++-- .../eks/pod_identity_associations/index.md | 17 +- .../global_replication_group/index.md | 41 ++-- .../global_replication_groups/index.md | 17 +- .../aws/elasticache/serverless_cache/index.md | 59 +++--- .../elasticache/serverless_caches/index.md | 17 +- .../aws/elasticache/subnet_group/index.md | 27 +-- .../aws/elasticache/subnet_groups/index.md | 17 +- .../providers/aws/elasticache/user/index.md | 39 ++-- .../aws/elasticache/user_group/index.md | 31 +-- .../aws/elasticache/user_groups/index.md | 17 +- .../providers/aws/elasticache/users/index.md | 17 +- .../aws/elasticbeanstalk/application/index.md | 25 +-- .../application_version/index.md | 27 +-- .../application_versions/index.md | 19 +- .../elasticbeanstalk/applications/index.md | 17 +- .../configuration_template/index.md | 35 ++-- .../configuration_templates/index.md | 19 +- .../aws/elasticbeanstalk/environment/index.md | 45 ++--- .../elasticbeanstalk/environments/index.md | 17 +- .../elasticloadbalancingv2/listener/index.md | 37 ++-- .../listener_rule/index.md | 31 +-- .../listener_rules/index.md | 17 +- .../elasticloadbalancingv2/listeners/index.md | 17 +- .../load_balancer/index.md | 49 ++--- .../load_balancers/index.md | 17 +- .../target_group/index.md | 65 ++++--- .../target_groups/index.md | 17 +- .../trust_store/index.md | 35 ++-- .../trust_store_revocation/index.md | 23 ++- .../trust_store_revocations/index.md | 19 +- .../trust_stores/index.md | 17 +- .../aws/emr/security_configuration/index.md | 19 +- .../aws/emr/security_configurations/index.md | 17 +- .../providers/aws/emr/studio/index.md | 59 +++--- .../aws/emr/studio_session_mapping/index.md | 27 +-- .../aws/emr/studio_session_mappings/index.md | 21 ++- .../providers/aws/emr/studios/index.md | 17 +- .../providers/aws/emr/wal_workspace/index.md | 23 ++- .../providers/aws/emr/wal_workspaces/index.md | 17 +- .../emrcontainers/virtual_cluster/index.md | 29 +-- .../emrcontainers/virtual_clusters/index.md | 17 +- .../aws/emrserverless/application/index.md | 51 ++--- .../aws/emrserverless/applications/index.md | 17 +- .../id_mapping_workflow/index.md | 39 ++-- .../id_mapping_workflows/index.md | 17 +- .../entityresolution/id_namespace/index.md | 39 ++-- .../entityresolution/id_namespaces/index.md | 17 +- .../matching_workflow/index.md | 39 ++-- .../matching_workflows/index.md | 17 +- .../policy_statement/index.md | 31 +-- .../policy_statements/index.md | 19 +- .../entityresolution/schema_mapping/index.md | 35 ++-- .../entityresolution/schema_mappings/index.md | 17 +- .../aws/events/api_destination/index.md | 33 ++-- .../aws/events/api_destinations/index.md | 17 +- .../providers/aws/events/archive/index.md | 31 +-- .../providers/aws/events/archives/index.md | 17 +- .../providers/aws/events/connection/index.md | 31 +-- .../providers/aws/events/connections/index.md | 17 +- .../providers/aws/events/endpoint/index.md | 41 ++-- .../providers/aws/events/endpoints/index.md | 17 +- .../providers/aws/events/event_bus/index.md | 29 +-- .../providers/aws/events/event_buses/index.md | 17 +- .../providers/aws/events/rule/index.md | 37 ++-- .../providers/aws/events/rules/index.md | 17 +- .../aws/eventschemas/discoverer/index.md | 33 ++-- .../aws/eventschemas/discoverers/index.md | 17 +- .../eventschemas_registry/index.md | 27 +-- .../aws/eventschemas/registries/index.md | 17 +- .../eventschemas/registry_policies/index.md | 17 +- .../aws/eventschemas/registry_policy/index.md | 27 +-- .../aws/eventschemas/schema/index.md | 39 ++-- .../aws/eventschemas/schemata/index.md | 17 +- .../aws/evidently/experiment/index.md | 45 ++--- .../aws/evidently/experiments/index.md | 17 +- .../providers/aws/evidently/feature/index.md | 37 ++-- .../providers/aws/evidently/features/index.md | 17 +- .../providers/aws/evidently/launch/index.md | 39 ++-- .../providers/aws/evidently/launches/index.md | 17 +- .../providers/aws/evidently/project/index.md | 31 +-- .../providers/aws/evidently/projects/index.md | 17 +- .../providers/aws/evidently/segment/index.md | 25 +-- .../providers/aws/evidently/segments/index.md | 17 +- .../aws/finspace/environment/index.md | 49 ++--- .../aws/finspace/environments/index.md | 17 +- .../aws/fis/experiment_template/index.md | 37 ++-- .../aws/fis/experiment_templates/index.md | 17 +- .../fis/target_account_configuration/index.md | 27 +-- .../target_account_configurations/index.md | 19 +- .../aws/fms/notification_channel/index.md | 23 ++- .../aws/fms/notification_channels/index.md | 17 +- .../providers/aws/fms/policies/index.md | 17 +- .../providers/aws/fms/policy/index.md | 51 ++--- .../providers/aws/fms/resource_set/index.md | 31 +-- .../providers/aws/fms/resource_sets/index.md | 17 +- .../providers/aws/forecast/dataset/index.md | 31 +-- .../aws/forecast/dataset_group/index.md | 29 +-- .../aws/forecast/dataset_groups/index.md | 17 +- .../providers/aws/forecast/datasets/index.md | 17 +- .../aws/frauddetector/detector/index.md | 43 +++-- .../aws/frauddetector/detectors/index.md | 17 +- .../aws/frauddetector/event_type/index.md | 37 ++-- .../aws/frauddetector/event_types/index.md | 17 +- .../frauddetector/frauddetector_list/index.md | 35 ++-- .../aws/frauddetector/label/index.md | 31 +-- .../aws/frauddetector/labels/index.md | 17 +- .../aws/frauddetector/lists/index.md | 17 +- .../aws/frauddetector/outcome/index.md | 31 +-- .../aws/frauddetector/outcomes/index.md | 17 +- .../aws/frauddetector/variable/index.md | 39 ++-- .../aws/frauddetector/variables/index.md | 17 +- .../fsx/data_repository_association/index.md | 37 ++-- .../fsx/data_repository_associations/index.md | 17 +- .../providers/aws/gamelift/alias/index.md | 27 +-- .../providers/aws/gamelift/aliases/index.md | 17 +- .../providers/aws/gamelift/build/index.md | 31 +-- .../providers/aws/gamelift/builds/index.md | 17 +- .../providers/aws/gamelift/fleet/index.md | 75 ++++---- .../providers/aws/gamelift/fleets/index.md | 17 +- .../aws/gamelift/game_server_group/index.md | 47 ++--- .../aws/gamelift/game_server_groups/index.md | 17 +- .../aws/gamelift/game_session_queue/index.md | 39 ++-- .../aws/gamelift/game_session_queues/index.md | 17 +- .../providers/aws/gamelift/location/index.md | 25 +-- .../providers/aws/gamelift/locations/index.md | 17 +- .../matchmaking_configuration/index.md | 55 +++--- .../matchmaking_configurations/index.md | 17 +- .../gamelift/matchmaking_rule_set/index.md | 29 +-- .../gamelift/matchmaking_rule_sets/index.md | 17 +- .../providers/aws/gamelift/script/index.md | 35 ++-- .../providers/aws/gamelift/scripts/index.md | 17 +- .../globalaccelerator/accelerator/index.md | 39 ++-- .../globalaccelerator/accelerators/index.md | 17 +- .../cross_account_attachment/index.md | 29 +-- .../cross_account_attachments/index.md | 17 +- .../globalaccelerator/endpoint_group/index.md | 41 ++-- .../endpoint_groups/index.md | 17 +- .../aws/globalaccelerator/listener/index.md | 29 +-- .../aws/globalaccelerator/listeners/index.md | 17 +- .../aws/glue/schema_version/index.md | 21 ++- .../aws/glue/schema_version_metadata/index.md | 21 ++- .../aws/glue/schema_versions/index.md | 17 +- .../providers/aws/grafana/workspace/index.md | 67 +++---- .../providers/aws/grafana/workspaces/index.md | 17 +- .../greengrassv2/component_version/index.md | 31 +-- .../greengrassv2/component_versions/index.md | 17 +- .../aws/greengrassv2/deployment/index.md | 35 ++-- .../aws/greengrassv2/deployments/index.md | 17 +- .../aws/groundstation/config/index.md | 31 +-- .../aws/groundstation/configs/index.md | 17 +- .../dataflow_endpoint_group/index.md | 27 +-- .../dataflow_endpoint_groups/index.md | 17 +- .../groundstation/mission_profile/index.md | 43 +++-- .../groundstation/mission_profiles/index.md | 19 +- .../providers/aws/guardduty/detector/index.md | 31 +-- .../aws/guardduty/detectors/index.md | 17 +- .../providers/aws/guardduty/filter/index.md | 33 ++-- .../providers/aws/guardduty/filters/index.md | 19 +- .../providers/aws/guardduty/ip_set/index.md | 33 ++-- .../providers/aws/guardduty/ip_sets/index.md | 19 +- .../providers/aws/guardduty/master/index.md | 21 ++- .../providers/aws/guardduty/masters/index.md | 19 +- .../providers/aws/guardduty/member/index.md | 31 +-- .../providers/aws/guardduty/members/index.md | 19 +- .../aws/guardduty/threat_intel_set/index.md | 33 ++-- .../aws/guardduty/threat_intel_sets/index.md | 19 +- .../aws/healthimaging/datastore/index.md | 31 +-- .../aws/healthimaging/datastores/index.md | 17 +- .../aws/healthlake/fhir_datastore/index.md | 41 ++-- .../aws/healthlake/fhir_datastores/index.md | 17 +- .../aws-docs/providers/aws/iam/group/index.md | 29 +-- .../providers/aws/iam/group_policies/index.md | 19 +- .../providers/aws/iam/group_policy/index.md | 25 +-- .../providers/aws/iam/groups/index.md | 17 +- .../aws/iam/instance_profile/index.md | 27 +-- .../aws/iam/instance_profiles/index.md | 17 +- .../aws/iam/managed_policies/index.md | 17 +- .../providers/aws/iam/managed_policy/index.md | 49 ++--- .../providers/aws/iam/oidc_provider/index.md | 29 +-- .../providers/aws/iam/oidc_providers/index.md | 17 +- .../providers/aws/iam/policies/index.md | 37 ++-- docs/aws-docs/providers/aws/iam/role/index.md | 41 ++-- .../providers/aws/iam/role_policies/index.md | 19 +- .../providers/aws/iam/role_policy/index.md | 25 +-- .../aws-docs/providers/aws/iam/roles/index.md | 17 +- .../providers/aws/iam/saml_provider/index.md | 27 +-- .../providers/aws/iam/saml_providers/index.md | 17 +- .../aws/iam/server_certificate/index.md | 33 ++-- .../aws/iam/server_certificates/index.md | 17 +- .../aws/iam/service_linked_role/index.md | 27 +-- .../aws/iam/service_linked_roles/index.md | 17 +- docs/aws-docs/providers/aws/iam/user/index.md | 37 ++-- .../providers/aws/iam/user_policies/index.md | 17 +- .../providers/aws/iam/user_policy/index.md | 25 +-- .../aws-docs/providers/aws/iam/users/index.md | 17 +- .../aws/iam/virtualmfa_device/index.md | 29 +-- .../aws/iam/virtualmfa_devices/index.md | 17 +- .../aws/identitystore/group/index.md | 27 +-- .../identitystore/group_membership/index.md | 23 ++- .../identitystore/group_memberships/index.md | 19 +- .../aws/identitystore/groups/index.md | 19 +- .../aws/imagebuilder/component/index.md | 41 ++-- .../aws/imagebuilder/components/index.md | 17 +- .../imagebuilder/container_recipe/index.md | 47 ++--- .../imagebuilder/container_recipes/index.md | 17 +- .../distribution_configuration/index.md | 29 +-- .../distribution_configurations/index.md | 17 +- .../providers/aws/imagebuilder/image/index.md | 43 +++-- .../aws/imagebuilder/image_pipeline/index.md | 49 ++--- .../aws/imagebuilder/image_pipelines/index.md | 17 +- .../aws/imagebuilder/image_recipe/index.md | 35 ++-- .../aws/imagebuilder/image_recipes/index.md | 17 +- .../aws/imagebuilder/images/index.md | 17 +- .../infrastructure_configuration/index.md | 47 ++--- .../infrastructure_configurations/index.md | 17 +- .../imagebuilder/lifecycle_policies/index.md | 17 +- .../imagebuilder/lifecycle_policy/index.md | 37 ++-- .../aws/imagebuilder/workflow/index.md | 35 ++-- .../aws/imagebuilder/workflows/index.md | 17 +- .../aws/inspector/assessment_target/index.md | 25 +-- .../aws/inspector/assessment_targets/index.md | 17 +- .../inspector/assessment_template/index.md | 27 +-- .../inspector/assessment_templates/index.md | 17 +- .../aws/inspector/resource_group/index.md | 19 +- .../aws/inspector/resource_groups/index.md | 17 +- .../cis_scan_configuration/index.md | 31 +-- .../cis_scan_configurations/index.md | 17 +- .../providers/aws/inspectorv2/filter/index.md | 29 +-- .../aws/inspectorv2/filters/index.md | 17 +- .../aws/internetmonitor/monitor/index.md | 53 +++--- .../aws/internetmonitor/monitors/index.md | 17 +- .../iot/account_audit_configuration/index.md | 27 +-- .../iot/account_audit_configurations/index.md | 17 +- .../providers/aws/iot/authorizer/index.md | 37 ++-- .../providers/aws/iot/authorizers/index.md | 17 +- .../providers/aws/iot/billing_group/index.md | 29 +-- .../providers/aws/iot/billing_groups/index.md | 17 +- .../providers/aws/iot/ca_certificate/index.md | 39 ++-- .../aws/iot/ca_certificates/index.md | 17 +- .../providers/aws/iot/certificate/index.md | 33 ++-- .../aws/iot/certificate_provider/index.md | 29 +-- .../aws/iot/certificate_providers/index.md | 17 +- .../providers/aws/iot/certificates/index.md | 17 +- .../providers/aws/iot/custom_metric/index.md | 29 +-- .../providers/aws/iot/custom_metrics/index.md | 17 +- .../providers/aws/iot/dimension/index.md | 29 +-- .../providers/aws/iot/dimensions/index.md | 17 +- .../aws/iot/domain_configuration/index.md | 45 ++--- .../aws/iot/domain_configurations/index.md | 17 +- .../providers/aws/iot/fleet_metric/index.md | 47 ++--- .../providers/aws/iot/fleet_metrics/index.md | 17 +- .../providers/aws/iot/job_template/index.md | 43 +++-- .../providers/aws/iot/job_templates/index.md | 17 +- .../providers/aws/iot/logging/index.md | 25 +-- .../providers/aws/iot/loggings/index.md | 17 +- .../aws/iot/mitigation_action/index.md | 31 +-- .../aws/iot/mitigation_actions/index.md | 17 +- .../providers/aws/iot/policies/index.md | 17 +- .../providers/aws/iot/policy/index.md | 29 +-- .../aws/iot/provisioning_template/index.md | 37 ++-- .../aws/iot/provisioning_templates/index.md | 17 +- .../iot/resource_specific_logging/index.md | 27 +-- .../iot/resource_specific_loggings/index.md | 17 +- .../providers/aws/iot/role_alias/index.md | 29 +-- .../providers/aws/iot/role_aliases/index.md | 17 +- .../aws/iot/scheduled_audit/index.md | 33 ++-- .../aws/iot/scheduled_audits/index.md | 17 +- .../aws/iot/security_profile/index.md | 37 ++-- .../aws/iot/security_profiles/index.md | 17 +- .../aws/iot/software_package/index.md | 27 +-- .../aws/iot/software_package_version/index.md | 35 ++-- .../iot/software_package_versions/index.md | 19 +- .../aws/iot/software_packages/index.md | 17 +- .../aws-docs/providers/aws/iot/thing/index.md | 27 +-- .../providers/aws/iot/thing_group/index.md | 33 ++-- .../providers/aws/iot/thing_groups/index.md | 17 +- .../providers/aws/iot/thing_type/index.md | 31 +-- .../providers/aws/iot/thing_types/index.md | 17 +- .../providers/aws/iot/things/index.md | 17 +- .../providers/aws/iot/topic_rule/index.md | 27 +-- .../aws/iot/topic_rule_destination/index.md | 29 +-- .../aws/iot/topic_rule_destinations/index.md | 17 +- .../providers/aws/iot/topic_rules/index.md | 17 +- .../aws/iotanalytics/dataset/index.md | 37 ++-- .../aws/iotanalytics/datasets/index.md | 17 +- .../aws/iotanalytics/pipeline/index.md | 27 +-- .../aws/iotanalytics/pipelines/index.md | 17 +- .../suite_definition/index.md | 29 +-- .../suite_definitions/index.md | 17 +- .../aws/iotevents/alarm_model/index.md | 37 ++-- .../aws/iotevents/alarm_models/index.md | 17 +- .../aws/iotevents/detector_model/index.md | 33 ++-- .../aws/iotevents/detector_models/index.md | 17 +- .../providers/aws/iotevents/input/index.md | 27 +-- .../providers/aws/iotevents/inputs/index.md | 17 +- .../aws/iotfleethub/application/index.md | 43 +++-- .../aws/iotfleethub/applications/index.md | 17 +- .../aws/iotfleetwise/campaign/index.md | 61 +++--- .../aws/iotfleetwise/campaigns/index.md | 17 +- .../iotfleetwise/decoder_manifest/index.md | 39 ++-- .../iotfleetwise/decoder_manifests/index.md | 17 +- .../providers/aws/iotfleetwise/fleet/index.md | 33 ++-- .../aws/iotfleetwise/fleets/index.md | 17 +- .../aws/iotfleetwise/model_manifest/index.md | 37 ++-- .../aws/iotfleetwise/model_manifests/index.md | 17 +- .../aws/iotfleetwise/signal_catalog/index.md | 35 ++-- .../aws/iotfleetwise/signal_catalogs/index.md | 17 +- .../aws/iotfleetwise/vehicle/index.md | 37 ++-- .../aws/iotfleetwise/vehicles/index.md | 17 +- .../aws/iotsitewise/access_policies/index.md | 17 +- .../aws/iotsitewise/access_policy/index.md | 29 +-- .../providers/aws/iotsitewise/asset/index.md | 37 ++-- .../aws/iotsitewise/asset_model/index.md | 39 ++-- .../aws/iotsitewise/asset_models/index.md | 17 +- .../providers/aws/iotsitewise/assets/index.md | 17 +- .../aws/iotsitewise/dashboard/index.md | 33 ++-- .../aws/iotsitewise/dashboards/index.md | 17 +- .../aws/iotsitewise/gateway/index.md | 29 +-- .../aws/iotsitewise/gateways/index.md | 17 +- .../providers/aws/iotsitewise/portal/index.md | 43 +++-- .../aws/iotsitewise/portals/index.md | 17 +- .../aws/iotsitewise/project/index.md | 33 ++-- .../aws/iotsitewise/projects/index.md | 17 +- .../aws/iottwinmaker/component_type/index.md | 51 ++--- .../aws/iottwinmaker/component_types/index.md | 19 +- .../aws/iottwinmaker/entities/index.md | 19 +- .../aws/iottwinmaker/entity/index.md | 45 ++--- .../providers/aws/iottwinmaker/scene/index.md | 41 ++-- .../aws/iottwinmaker/scenes/index.md | 19 +- .../aws/iottwinmaker/sync_job/index.md | 31 +-- .../aws/iottwinmaker/sync_jobs/index.md | 19 +- .../aws/iottwinmaker/workspace/index.md | 35 ++-- .../aws/iottwinmaker/workspaces/index.md | 17 +- .../aws/iotwireless/destination/index.md | 33 ++-- .../aws/iotwireless/destinations/index.md | 17 +- .../aws/iotwireless/device_profile/index.md | 25 +-- .../aws/iotwireless/device_profiles/index.md | 17 +- .../aws/iotwireless/fuota_task/index.md | 45 ++--- .../aws/iotwireless/fuota_tasks/index.md | 17 +- .../aws/iotwireless/multicast_group/index.md | 37 ++-- .../aws/iotwireless/multicast_groups/index.md | 17 +- .../network_analyzer_configuration/index.md | 33 ++-- .../network_analyzer_configurations/index.md | 17 +- .../aws/iotwireless/partner_account/index.md | 37 ++-- .../aws/iotwireless/partner_accounts/index.md | 17 +- .../aws/iotwireless/service_profile/index.md | 25 +-- .../aws/iotwireless/service_profiles/index.md | 17 +- .../aws/iotwireless/task_definition/index.md | 31 +-- .../aws/iotwireless/task_definitions/index.md | 17 +- .../aws/iotwireless/wireless_device/index.md | 43 +++-- .../wireless_device_import_task/index.md | 43 +++-- .../wireless_device_import_tasks/index.md | 17 +- .../aws/iotwireless/wireless_devices/index.md | 17 +- .../aws/iotwireless/wireless_gateway/index.md | 37 ++-- .../iotwireless/wireless_gateways/index.md | 17 +- .../providers/aws/ivs/channel/index.md | 41 ++-- .../providers/aws/ivs/channels/index.md | 17 +- .../aws/ivs/encoder_configuration/index.md | 27 +-- .../aws/ivs/encoder_configurations/index.md | 17 +- .../aws/ivs/playback_key_pair/index.md | 29 +-- .../aws/ivs/playback_key_pairs/index.md | 17 +- .../playback_restriction_policies/index.md | 17 +- .../ivs/playback_restriction_policy/index.md | 31 +-- .../aws/ivs/recording_configuration/index.md | 35 ++-- .../aws/ivs/recording_configurations/index.md | 17 +- .../aws-docs/providers/aws/ivs/stage/index.md | 27 +-- .../providers/aws/ivs/stages/index.md | 17 +- .../aws/ivs/storage_configuration/index.md | 27 +-- .../aws/ivs/storage_configurations/index.md | 17 +- .../providers/aws/ivs/stream_key/index.md | 27 +-- .../providers/aws/ivs/stream_keys/index.md | 17 +- .../ivschat/logging_configuration/index.md | 31 +-- .../ivschat/logging_configurations/index.md | 17 +- .../providers/aws/ivschat/room/index.md | 35 ++-- .../providers/aws/ivschat/rooms/index.md | 17 +- .../aws/kafkaconnect/connector/index.md | 47 ++--- .../aws/kafkaconnect/connectors/index.md | 17 +- .../aws/kafkaconnect/custom_plugin/index.md | 35 ++-- .../aws/kafkaconnect/custom_plugins/index.md | 17 +- .../worker_configuration/index.md | 31 +-- .../worker_configurations/index.md | 17 +- .../providers/aws/kendra/data_source/index.md | 43 +++-- .../aws/kendra/data_sources/index.md | 19 +- .../providers/aws/kendra/faq/index.md | 39 ++-- .../providers/aws/kendra/faqs/index.md | 19 +- .../providers/aws/kendra/index/index.md | 43 +++-- .../providers/aws/kendra/indices/index.md | 17 +- .../aws/kendraranking/execution_plan/index.md | 31 +-- .../kendraranking/execution_plans/index.md | 17 +- .../aws/kinesis/kinesis_stream/index.md | 33 ++-- .../providers/aws/kinesis/streams/index.md | 17 +- .../kinesisanalyticsv2/application/index.md | 37 ++-- .../kinesisanalyticsv2/applications/index.md | 17 +- .../kinesisfirehose/delivery_stream/index.md | 51 ++--- .../kinesisfirehose/delivery_streams/index.md | 17 +- .../kinesisvideo/kinesisvideo_stream/index.md | 33 ++-- .../kinesisvideo/signaling_channel/index.md | 29 +-- .../kinesisvideo/signaling_channels/index.md | 17 +- .../aws/kinesisvideo/streams/index.md | 17 +- .../aws-docs/providers/aws/kms/alias/index.md | 23 ++- .../providers/aws/kms/aliases/index.md | 17 +- docs/aws-docs/providers/aws/kms/key/index.md | 47 ++--- docs/aws-docs/providers/aws/kms/keys/index.md | 17 +- .../providers/aws/kms/replica_key/index.md | 35 ++-- .../providers/aws/kms/replica_keys/index.md | 17 +- .../lakeformation/data_cells_filter/index.md | 29 +-- .../lakeformation/data_cells_filters/index.md | 23 ++- .../principal_permissions/index.md | 29 +-- .../providers/aws/lakeformation/tag/index.md | 25 +-- .../lakeformation/tag_association/index.md | 23 ++- .../lakeformation/tag_associations/index.md | 19 +- .../providers/aws/lakeformation/tags/index.md | 17 +- .../aws/lambda/code_signing_config/index.md | 29 +-- .../aws/lambda/code_signing_configs/index.md | 17 +- .../aws/lambda/event_invoke_config/index.md | 29 +-- .../aws/lambda/event_invoke_configs/index.md | 19 +- .../aws/lambda/event_source_mapping/index.md | 67 +++---- .../aws/lambda/event_source_mappings/index.md | 17 +- .../providers/aws/lambda/function/index.md | 73 ++++---- .../providers/aws/lambda/functions/index.md | 17 +- .../aws/lambda/layer_version/index.md | 29 +-- .../lambda/layer_version_permission/index.md | 25 +-- .../lambda/layer_version_permissions/index.md | 17 +- .../aws/lambda/layer_versions/index.md | 17 +- .../providers/aws/lambda/permission/index.md | 33 ++-- .../providers/aws/lambda/permissions/index.md | 19 +- .../providers/aws/lambda/url/index.md | 33 ++-- .../providers/aws/lambda/urls/index.md | 17 +- .../providers/aws/lambda/version/index.md | 33 ++-- .../providers/aws/lambda/versions/index.md | 17 +- docs/aws-docs/providers/aws/lex/bot/index.md | 45 ++--- .../providers/aws/lex/bot_alias/index.md | 41 ++-- .../providers/aws/lex/bot_aliases/index.md | 19 +- .../providers/aws/lex/bot_version/index.md | 23 ++- .../providers/aws/lex/bot_versions/index.md | 19 +- docs/aws-docs/providers/aws/lex/bots/index.md | 17 +- .../aws/lex/resource_policies/index.md | 17 +- .../aws/lex/resource_policy/index.md | 27 +-- .../aws/licensemanager/grant/index.md | 35 ++-- .../aws/licensemanager/grants/index.md | 17 +- .../aws/licensemanager/license/index.md | 45 ++--- .../aws/licensemanager/licenses/index.md | 17 +- .../providers/aws/lightsail/alarm/index.md | 45 ++--- .../providers/aws/lightsail/alarms/index.md | 17 +- .../providers/aws/lightsail/bucket/index.md | 39 ++-- .../providers/aws/lightsail/buckets/index.md | 17 +- .../aws/lightsail/certificate/index.md | 31 +-- .../aws/lightsail/certificates/index.md | 17 +- .../aws/lightsail/container/index.md | 41 ++-- .../aws/lightsail/containers/index.md | 17 +- .../providers/aws/lightsail/database/index.md | 51 ++--- .../aws/lightsail/databases/index.md | 17 +- .../aws/lightsail/distribution/index.md | 45 ++--- .../aws/lightsail/distributions/index.md | 17 +- .../providers/aws/lightsail/instance/index.md | 59 +++--- .../aws/lightsail/instances/index.md | 17 +- .../aws/lightsail/load_balancer/index.md | 39 ++-- .../load_balancer_tls_certificate/index.md | 35 ++-- .../load_balancer_tls_certificates/index.md | 19 +- .../aws/lightsail/load_balancers/index.md | 17 +- .../aws/lightsail/static_ip/index.md | 29 +-- .../aws/lightsail/static_ips/index.md | 17 +- .../providers/aws/location/api_key/index.md | 43 +++-- .../providers/aws/location/api_keys/index.md | 17 +- .../aws/location/geofence_collection/index.md | 39 ++-- .../location/geofence_collections/index.md | 17 +- .../providers/aws/location/map/index.md | 37 ++-- .../providers/aws/location/maps/index.md | 17 +- .../aws/location/place_index/index.md | 39 ++-- .../aws/location/place_indices/index.md | 17 +- .../aws/location/route_calculator/index.md | 37 ++-- .../aws/location/route_calculators/index.md | 17 +- .../providers/aws/location/tracker/index.md | 45 ++--- .../aws/location/tracker_consumer/index.md | 19 +- .../aws/location/tracker_consumers/index.md | 19 +- .../providers/aws/location/trackers/index.md | 17 +- .../aws/logs/account_policies/index.md | 21 ++- .../aws/logs/account_policy/index.md | 31 +-- .../providers/aws/logs/deliveries/index.md | 17 +- .../providers/aws/logs/delivery/index.md | 31 +-- .../aws/logs/delivery_destination/index.md | 31 +-- .../aws/logs/delivery_destinations/index.md | 17 +- .../aws/logs/delivery_source/index.md | 33 ++-- .../aws/logs/delivery_sources/index.md | 17 +- .../providers/aws/logs/destination/index.md | 29 +-- .../providers/aws/logs/destinations/index.md | 17 +- .../aws/logs/log_anomaly_detector/index.md | 41 ++-- .../aws/logs/log_anomaly_detectors/index.md | 17 +- .../providers/aws/logs/log_stream/index.md | 19 +- .../providers/aws/logs/log_streams/index.md | 19 +- .../providers/aws/logs/metric_filter/index.md | 27 +-- .../aws/logs/metric_filters/index.md | 19 +- .../aws/logs/query_definition/index.md | 27 +-- .../aws/logs/query_definitions/index.md | 17 +- .../aws/logs/resource_policies/index.md | 17 +- .../aws/logs/resource_policy/index.md | 23 ++- .../aws/logs/subscription_filter/index.md | 31 +-- .../aws/logs/subscription_filters/index.md | 19 +- .../inference_scheduler/index.md | 39 ++-- .../inference_schedulers/index.md | 17 +- .../aws/lookoutmetrics/alert/index.md | 27 +-- .../aws/lookoutmetrics/alerts/index.md | 17 +- .../lookoutmetrics/anomaly_detector/index.md | 31 +-- .../lookoutmetrics/anomaly_detectors/index.md | 17 +- .../aws/lookoutvision/project/index.md | 23 ++- .../aws/lookoutvision/projects/index.md | 17 +- .../providers/aws/m2/application/index.md | 37 ++-- .../providers/aws/m2/applications/index.md | 17 +- .../providers/aws/m2/environment/index.md | 49 ++--- .../providers/aws/m2/environments/index.md | 17 +- .../providers/aws/macie/allow_list/index.md | 33 ++-- .../providers/aws/macie/allow_lists/index.md | 17 +- .../aws/macie/custom_data_identifier/index.md | 37 ++-- .../macie/custom_data_identifiers/index.md | 17 +- .../aws/macie/findings_filter/index.md | 35 ++-- .../aws/macie/findings_filters/index.md | 17 +- .../providers/aws/macie/session/index.md | 27 +-- .../providers/aws/macie/sessions/index.md | 17 +- .../aws/managedblockchain/accessor/index.md | 35 ++-- .../aws/managedblockchain/accessors/index.md | 17 +- .../aws/mediaconnect/bridge/index.md | 37 ++-- .../aws/mediaconnect/bridge_output/index.md | 25 +-- .../aws/mediaconnect/bridge_outputs/index.md | 19 +- .../aws/mediaconnect/bridge_source/index.md | 27 +-- .../aws/mediaconnect/bridge_sources/index.md | 19 +- .../aws/mediaconnect/bridges/index.md | 17 +- .../providers/aws/mediaconnect/flow/index.md | 31 +-- .../mediaconnect/flow_entitlement/index.md | 35 ++-- .../mediaconnect/flow_entitlements/index.md | 17 +- .../aws/mediaconnect/flow_output/index.md | 49 ++--- .../aws/mediaconnect/flow_outputs/index.md | 17 +- .../aws/mediaconnect/flow_source/index.md | 61 +++--- .../aws/mediaconnect/flow_sources/index.md | 17 +- .../mediaconnect/flow_vpc_interface/index.md | 31 +-- .../mediaconnect/flow_vpc_interfaces/index.md | 19 +- .../providers/aws/mediaconnect/flows/index.md | 17 +- .../aws/mediaconnect/gateway/index.md | 25 +-- .../aws/mediaconnect/gateways/index.md | 17 +- .../aws/medialive/multiplex/index.md | 39 ++-- .../aws/medialive/multiplexes/index.md | 17 +- .../aws/medialive/multiplexprogram/index.md | 33 ++-- .../aws/medialive/multiplexprograms/index.md | 19 +- .../providers/aws/mediapackage/asset/index.md | 33 ++-- .../aws/mediapackage/assets/index.md | 17 +- .../aws/mediapackage/channel/index.md | 33 ++-- .../aws/mediapackage/channels/index.md | 17 +- .../aws/mediapackage/origin_endpoint/index.md | 51 ++--- .../mediapackage/origin_endpoints/index.md | 17 +- .../packaging_configuration/index.md | 31 +-- .../packaging_configurations/index.md | 17 +- .../aws/mediapackage/packaging_group/index.md | 31 +-- .../mediapackage/packaging_groups/index.md | 17 +- .../aws/mediapackagev2/channel/index.md | 35 ++-- .../aws/mediapackagev2/channel_group/index.md | 33 ++-- .../mediapackagev2/channel_groups/index.md | 17 +- .../mediapackagev2/channel_policies/index.md | 19 +- .../mediapackagev2/channel_policy/index.md | 25 +-- .../aws/mediapackagev2/channels/index.md | 17 +- .../mediapackagev2/origin_endpoint/index.md | 45 ++--- .../origin_endpoint_policies/index.md | 21 ++- .../origin_endpoint_policy/index.md | 27 +-- .../mediapackagev2/origin_endpoints/index.md | 17 +- .../aws/mediatailor/channel/index.md | 39 ++-- .../aws/mediatailor/channel_policies/index.md | 17 +- .../aws/mediatailor/channel_policy/index.md | 23 ++- .../aws/mediatailor/channels/index.md | 17 +- .../aws/mediatailor/live_source/index.md | 29 +-- .../aws/mediatailor/live_sources/index.md | 19 +- .../playback_configuration/index.md | 55 +++--- .../playback_configurations/index.md | 17 +- .../aws/mediatailor/source_location/index.md | 33 ++-- .../aws/mediatailor/source_locations/index.md | 17 +- .../aws/mediatailor/vod_source/index.md | 29 +-- .../aws/mediatailor/vod_sources/index.md | 19 +- .../providers/aws/memorydb/acl/index.md | 29 +-- .../providers/aws/memorydb/acls/index.md | 17 +- .../providers/aws/memorydb/cluster/index.md | 75 ++++---- .../providers/aws/memorydb/clusters/index.md | 17 +- .../aws/memorydb/parameter_group/index.md | 31 +-- .../aws/memorydb/parameter_groups/index.md | 17 +- .../aws/memorydb/subnet_group/index.md | 29 +-- .../aws/memorydb/subnet_groups/index.md | 17 +- .../providers/aws/memorydb/user/index.md | 31 +-- .../providers/aws/memorydb/users/index.md | 17 +- .../aws/msk/batch_scram_secret/index.md | 23 ++- .../aws/msk/batch_scram_secrets/index.md | 17 +- .../providers/aws/msk/cluster/index.md | 47 ++--- .../aws/msk/cluster_policies/index.md | 17 +- .../providers/aws/msk/cluster_policy/index.md | 25 +-- .../providers/aws/msk/clusters/index.md | 17 +- .../providers/aws/msk/configuration/index.md | 31 +-- .../providers/aws/msk/configurations/index.md | 17 +- .../providers/aws/msk/replicator/index.md | 35 ++-- .../providers/aws/msk/replicators/index.md | 17 +- .../aws/msk/serverless_cluster/index.md | 25 +-- .../aws/msk/serverless_clusters/index.md | 17 +- .../providers/aws/msk/vpc_connection/index.md | 33 ++-- .../aws/msk/vpc_connections/index.md | 17 +- .../providers/aws/mwaa/environment/index.md | 75 ++++---- .../providers/aws/mwaa/environments/index.md | 17 +- .../providers/aws/neptune/db_cluster/index.md | 77 ++++---- .../aws/neptune/db_clusters/index.md | 17 +- .../providers/aws/neptunegraph/graph/index.md | 39 ++-- .../aws/neptunegraph/graphs/index.md | 17 +- .../private_graph_endpoint/index.md | 31 +-- .../private_graph_endpoints/index.md | 17 +- .../aws/networkfirewall/firewall/index.md | 43 +++-- .../firewall_policies/index.md | 17 +- .../networkfirewall/firewall_policy/index.md | 31 +-- .../aws/networkfirewall/firewalls/index.md | 17 +- .../logging_configuration/index.md | 25 +-- .../logging_configurations/index.md | 17 +- .../aws/networkfirewall/rule_group/index.md | 35 ++-- .../aws/networkfirewall/rule_groups/index.md | 17 +- .../tls_inspection_configuration/index.md | 31 +-- .../tls_inspection_configurations/index.md | 17 +- .../connect_attachment/index.md | 51 ++--- .../connect_attachments/index.md | 17 +- .../aws/networkmanager/connect_peer/index.md | 45 ++--- .../aws/networkmanager/connect_peers/index.md | 17 +- .../aws/networkmanager/core_network/index.md | 41 ++-- .../aws/networkmanager/core_networks/index.md | 17 +- .../customer_gateway_association/index.md | 23 ++- .../customer_gateway_associations/index.md | 19 +- .../aws/networkmanager/device/index.md | 47 ++--- .../aws/networkmanager/devices/index.md | 19 +- .../networkmanager/global_network/index.md | 31 +-- .../networkmanager/global_networks/index.md | 17 +- .../aws/networkmanager/link/index.md | 41 ++-- .../networkmanager/link_association/index.md | 21 ++- .../networkmanager/link_associations/index.md | 21 ++- .../aws/networkmanager/links/index.md | 19 +- .../aws/networkmanager/site/index.md | 35 ++-- .../site_to_site_vpn_attachment/index.md | 49 ++--- .../site_to_site_vpn_attachments/index.md | 17 +- .../aws/networkmanager/sites/index.md | 19 +- .../transit_gateway_peering/index.md | 43 +++-- .../transit_gateway_peerings/index.md | 17 +- .../transit_gateway_registration/index.md | 19 +- .../transit_gateway_registrations/index.md | 19 +- .../index.md | 51 ++--- .../index.md | 17 +- .../networkmanager/vpc_attachment/index.md | 53 +++--- .../networkmanager/vpc_attachments/index.md | 17 +- .../aws/nimblestudio/launch_profile/index.md | 37 ++-- .../aws/nimblestudio/launch_profiles/index.md | 19 +- .../aws/nimblestudio/streaming_image/index.md | 39 ++-- .../nimblestudio/streaming_images/index.md | 19 +- .../aws/nimblestudio/studio/index.md | 39 ++-- .../nimblestudio/studio_component/index.md | 45 ++--- .../nimblestudio/studio_components/index.md | 19 +- .../aws/nimblestudio/studios/index.md | 17 +- docs/aws-docs/providers/aws/oam/link/index.md | 33 ++-- .../aws-docs/providers/aws/oam/links/index.md | 17 +- docs/aws-docs/providers/aws/oam/sink/index.md | 27 +-- .../aws-docs/providers/aws/oam/sinks/index.md | 17 +- .../aws/omics/annotation_store/index.md | 47 ++--- .../aws/omics/annotation_stores/index.md | 17 +- .../aws/omics/reference_store/index.md | 29 +-- .../aws/omics/reference_stores/index.md | 17 +- .../providers/aws/omics/run_group/index.md | 37 ++-- .../providers/aws/omics/run_groups/index.md | 17 +- .../aws/omics/sequence_store/index.md | 31 +-- .../aws/omics/sequence_stores/index.md | 17 +- .../aws/omics/variant_store/index.md | 43 +++-- .../aws/omics/variant_stores/index.md | 17 +- .../providers/aws/omics/workflow/index.md | 47 ++--- .../providers/aws/omics/workflows/index.md | 17 +- .../access_policies/index.md | 19 +- .../access_policy/index.md | 27 +-- .../opensearchserverless/collection/index.md | 37 ++-- .../opensearchserverless/collections/index.md | 17 +- .../lifecycle_policies/index.md | 19 +- .../lifecycle_policy/index.md | 27 +-- .../security_config/index.md | 29 +-- .../security_configs/index.md | 17 +- .../security_policies/index.md | 19 +- .../security_policy/index.md | 27 +-- .../vpc_endpoint/index.md | 29 +-- .../vpc_endpoints/index.md | 17 +- .../aws/opensearchservice/domain/index.md | 69 +++---- .../aws/opensearchservice/domains/index.md | 17 +- .../providers/aws/opsworkscm/server/index.md | 65 ++++--- .../providers/aws/opsworkscm/servers/index.md | 17 +- .../aws/organizations/account/index.md | 39 ++-- .../aws/organizations/accounts/index.md | 17 +- .../aws/organizations/organization/index.md | 33 ++-- .../organizational_unit/index.md | 29 +-- .../organizational_units/index.md | 17 +- .../aws/organizations/organizations/index.md | 17 +- .../aws/organizations/policies/index.md | 17 +- .../aws/organizations/policy/index.md | 37 ++-- .../organizations/resource_policies/index.md | 17 +- .../organizations/resource_policy/index.md | 27 +-- .../providers/aws/osis/pipeline/index.md | 43 +++-- .../providers/aws/osis/pipelines/index.md | 17 +- .../panorama/application_instance/index.md | 51 ++--- .../panorama/application_instances/index.md | 17 +- .../providers/aws/panorama/package/index.md | 31 +-- .../aws/panorama/package_version/index.md | 43 +++-- .../aws/panorama/package_versions/index.md | 21 ++- .../providers/aws/panorama/packages/index.md | 17 +- .../aws/pcaconnectorad/connector/index.md | 29 +-- .../aws/pcaconnectorad/connectors/index.md | 17 +- .../directory_registration/index.md | 25 +-- .../directory_registrations/index.md | 17 +- .../service_principal_name/index.md | 19 +- .../service_principal_names/index.md | 19 +- .../aws/pcaconnectorad/template/index.md | 31 +-- .../index.md | 19 +- .../index.md | 27 +-- .../aws/pcaconnectorad/templates/index.md | 17 +- .../aws/personalize/dataset/index.md | 31 +-- .../aws/personalize/dataset_group/index.md | 25 +-- .../aws/personalize/dataset_groups/index.md | 17 +- .../aws/personalize/datasets/index.md | 17 +- .../providers/aws/personalize/schema/index.md | 23 ++- .../aws/personalize/schemata/index.md | 17 +- .../aws/personalize/solution/index.md | 31 +-- .../aws/personalize/solutions/index.md | 17 +- .../aws/pinpoint/in_app_template/index.md | 33 ++-- .../aws/pinpoint/in_app_templates/index.md | 17 +- .../providers/aws/pipes/pipe/index.md | 53 +++--- .../providers/aws/pipes/pipes/index.md | 17 +- .../environment_account_connection/index.md | 39 ++-- .../environment_account_connections/index.md | 17 +- .../aws/proton/environment_template/index.md | 33 ++-- .../aws/proton/environment_templates/index.md | 17 +- .../aws/proton/service_template/index.md | 33 ++-- .../aws/proton/service_templates/index.md | 17 +- .../providers/aws/qldb/qldb_stream/index.md | 37 ++-- .../providers/aws/qldb/streams/index.md | 19 +- .../aws/quicksight/analyses/index.md | 19 +- .../aws/quicksight/analysis/index.md | 53 +++--- .../aws/quicksight/dashboard/index.md | 57 +++--- .../aws/quicksight/dashboards/index.md | 19 +- .../aws/quicksight/data_set/index.md | 63 ++++--- .../aws/quicksight/data_sets/index.md | 19 +- .../aws/quicksight/data_source/index.md | 51 ++--- .../aws/quicksight/data_sources/index.md | 19 +- .../aws/quicksight/refresh_schedule/index.md | 27 +-- .../aws/quicksight/refresh_schedules/index.md | 21 ++- .../aws/quicksight/template/index.md | 45 ++--- .../aws/quicksight/templates/index.md | 19 +- .../providers/aws/quicksight/theme/index.md | 45 ++--- .../providers/aws/quicksight/themes/index.md | 19 +- .../providers/aws/quicksight/topic/index.md | 33 ++-- .../providers/aws/quicksight/topics/index.md | 19 +- .../aws/quicksight/vpc_connection/index.md | 49 ++--- .../aws/quicksight/vpc_connections/index.md | 19 +- .../providers/aws/ram/permission/index.md | 35 ++-- .../providers/aws/ram/permissions/index.md | 17 +- .../aws/rds/customdb_engine_version/index.md | 45 ++--- .../aws/rds/customdb_engine_versions/index.md | 19 +- .../providers/aws/rds/db_cluster/index.md | 137 +++++++------- .../rds/db_cluster_parameter_group/index.md | 29 +-- .../rds/db_cluster_parameter_groups/index.md | 17 +- .../providers/aws/rds/db_clusters/index.md | 17 +- .../providers/aws/rds/db_instance/index.md | 177 +++++++++--------- .../providers/aws/rds/db_instances/index.md | 17 +- .../aws/rds/db_parameter_group/index.md | 29 +-- .../aws/rds/db_parameter_groups/index.md | 17 +- .../providers/aws/rds/db_proxies/index.md | 17 +- .../providers/aws/rds/db_proxy/index.md | 45 ++--- .../aws/rds/db_proxy_endpoint/index.md | 39 ++-- .../aws/rds/db_proxy_endpoints/index.md | 17 +- .../aws/rds/db_proxy_target_group/index.md | 31 +-- .../aws/rds/db_proxy_target_groups/index.md | 17 +- .../aws/rds/db_subnet_group/index.md | 27 +-- .../aws/rds/db_subnet_groups/index.md | 17 +- .../aws/rds/event_subscription/index.md | 33 ++-- .../aws/rds/event_subscriptions/index.md | 17 +- .../providers/aws/rds/global_cluster/index.md | 31 +-- .../aws/rds/global_clusters/index.md | 17 +- .../providers/aws/rds/integration/index.md | 39 ++-- .../providers/aws/rds/integrations/index.md | 17 +- .../providers/aws/rds/option_group/index.md | 31 +-- .../providers/aws/rds/option_groups/index.md | 17 +- .../providers/aws/redshift/cluster/index.md | 129 ++++++------- .../redshift/cluster_parameter_group/index.md | 29 +-- .../cluster_parameter_groups/index.md | 17 +- .../redshift/cluster_subnet_group/index.md | 27 +-- .../redshift/cluster_subnet_groups/index.md | 17 +- .../providers/aws/redshift/clusters/index.md | 17 +- .../aws/redshift/endpoint_access/index.md | 41 ++-- .../aws/redshift/endpoint_accesses/index.md | 17 +- .../redshift/endpoint_authorization/index.md | 43 +++-- .../redshift/endpoint_authorizations/index.md | 19 +- .../aws/redshift/event_subscription/index.md | 47 ++--- .../aws/redshift/event_subscriptions/index.md | 17 +- .../aws/redshift/scheduled_action/index.md | 39 ++-- .../aws/redshift/scheduled_actions/index.md | 17 +- .../aws/redshiftserverless/namespace/index.md | 53 +++--- .../redshiftserverless/namespaces/index.md | 17 +- .../aws/redshiftserverless/workgroup/index.md | 43 +++-- .../redshiftserverless/workgroups/index.md | 17 +- .../aws/refactorspaces/application/index.md | 43 +++-- .../aws/refactorspaces/applications/index.md | 19 +- .../aws/refactorspaces/environment/index.md | 29 +-- .../aws/refactorspaces/environments/index.md | 17 +- .../aws/refactorspaces/route/index.md | 39 ++-- .../aws/refactorspaces/routes/index.md | 21 ++- .../aws/refactorspaces/service/index.md | 37 ++-- .../aws/refactorspaces/services/index.md | 21 ++- .../aws/rekognition/collection/index.md | 25 +-- .../aws/rekognition/collections/index.md | 17 +- .../aws/rekognition/project/index.md | 23 ++- .../aws/rekognition/projects/index.md | 17 +- .../aws/rekognition/stream_processor/index.md | 51 ++--- .../rekognition/stream_processors/index.md | 17 +- .../providers/aws/resiliencehub/app/index.md | 41 ++-- .../providers/aws/resiliencehub/apps/index.md | 17 +- .../resiliency_policies/index.md | 17 +- .../resiliencehub/resiliency_policy/index.md | 33 ++-- .../default_view_association/index.md | 23 ++- .../default_view_associations/index.md | 17 +- .../aws/resourceexplorer2/index/index.md | 27 +-- .../aws/resourceexplorer2/indices/index.md | 17 +- .../aws/resourceexplorer2/view/index.md | 31 +-- .../aws/resourceexplorer2/views/index.md | 17 +- .../aws/resourcegroups/group/index.md | 33 ++-- .../aws/resourcegroups/groups/index.md | 17 +- .../providers/aws/robomaker/fleet/index.md | 25 +-- .../providers/aws/robomaker/fleets/index.md | 17 +- .../providers/aws/robomaker/robot/index.md | 31 +-- .../aws/robomaker/robot_application/index.md | 33 ++-- .../robot_application_version/index.md | 23 ++- .../robot_application_versions/index.md | 17 +- .../aws/robomaker/robot_applications/index.md | 17 +- .../providers/aws/robomaker/robots/index.md | 17 +- .../robomaker/simulation_application/index.md | 37 ++-- .../simulation_application_version/index.md | 23 ++- .../simulation_application_versions/index.md | 17 +- .../simulation_applications/index.md | 17 +- .../providers/aws/rolesanywhere/crl/index.md | 31 +-- .../providers/aws/rolesanywhere/crls/index.md | 17 +- .../aws/rolesanywhere/profile/index.md | 39 ++-- .../aws/rolesanywhere/profiles/index.md | 17 +- .../aws/rolesanywhere/trust_anchor/index.md | 33 ++-- .../aws/rolesanywhere/trust_anchors/index.md | 17 +- .../aws/route53/cidr_collection/index.md | 27 +-- .../aws/route53/cidr_collections/index.md | 17 +- .../providers/aws/route53/dnssec/index.md | 17 +- .../providers/aws/route53/dnssecs/index.md | 17 +- .../aws/route53/health_check/index.md | 25 +-- .../aws/route53/health_checks/index.md | 17 +- .../aws/route53/hosted_zone/index.md | 33 ++-- .../aws/route53/hosted_zones/index.md | 17 +- .../aws/route53/key_signing_key/index.md | 27 +-- .../aws/route53/key_signing_keys/index.md | 19 +- .../route53recoverycontrol/cluster/index.md | 25 +-- .../route53recoverycontrol/clusters/index.md | 17 +- .../control_panel/index.md | 33 ++-- .../control_panels/index.md | 17 +- .../routing_control/index.md | 29 +-- .../routing_controls/index.md | 17 +- .../safety_rule/index.md | 35 ++-- .../safety_rules/index.md | 17 +- .../route53recoveryreadiness/cell/index.md | 29 +-- .../route53recoveryreadiness/cells/index.md | 17 +- .../readiness_check/index.md | 27 +-- .../readiness_checks/index.md | 17 +- .../recovery_group/index.md | 27 +-- .../recovery_groups/index.md | 17 +- .../resource_set/index.md | 29 +-- .../resource_sets/index.md | 17 +- .../firewall_domain_list/index.md | 45 ++--- .../firewall_domain_lists/index.md | 17 +- .../firewall_rule_group/index.md | 45 ++--- .../firewall_rule_group_association/index.md | 47 ++--- .../firewall_rule_group_associations/index.md | 17 +- .../firewall_rule_groups/index.md | 17 +- .../route53resolver/outpost_resolver/index.md | 43 +++-- .../outpost_resolvers/index.md | 17 +- .../route53resolver/resolver_config/index.md | 25 +-- .../route53resolver/resolver_configs/index.md | 17 +- .../resolver_query_logging_config/index.md | 35 ++-- .../index.md | 29 +-- .../index.md | 17 +- .../resolver_query_logging_configs/index.md | 17 +- .../route53resolver/resolver_rule/index.md | 35 ++-- .../resolver_rule_association/index.md | 23 ++- .../resolver_rule_associations/index.md | 17 +- .../route53resolver/resolver_rules/index.md | 17 +- .../resolverdnssec_config/index.md | 23 ++- .../resolverdnssec_configs/index.md | 17 +- .../providers/aws/rum/app_monitor/index.md | 33 ++-- .../providers/aws/rum/app_monitors/index.md | 17 +- .../providers/aws/s3/access_grant/index.md | 39 ++-- .../providers/aws/s3/access_grants/index.md | 17 +- .../aws/s3/access_grants_instance/index.md | 27 +-- .../aws/s3/access_grants_instances/index.md | 17 +- .../aws/s3/access_grants_location/index.md | 29 +-- .../aws/s3/access_grants_locations/index.md | 17 +- .../providers/aws/s3/access_point/index.md | 37 ++-- .../providers/aws/s3/access_points/index.md | 17 +- .../aws-docs/providers/aws/s3/bucket/index.md | 69 +++---- .../providers/aws/s3/bucket_policies/index.md | 17 +- .../providers/aws/s3/bucket_policy/index.md | 23 ++- .../providers/aws/s3/buckets/index.md | 17 +- .../aws/s3/multi_region_access_point/index.md | 25 +-- .../index.md | 17 +- .../multi_region_access_point_policy/index.md | 25 +-- .../s3/multi_region_access_points/index.md | 17 +- .../providers/aws/s3/storage_lens/index.md | 23 ++- .../aws/s3/storage_lens_group/index.md | 27 +-- .../aws/s3/storage_lens_groups/index.md | 17 +- .../aws/s3express/bucket_policies/index.md | 17 +- .../aws/s3express/bucket_policy/index.md | 23 ++- .../aws/s3express/directory_bucket/index.md | 23 ++- .../aws/s3express/directory_buckets/index.md | 17 +- .../aws/s3objectlambda/access_point/index.md | 33 ++-- .../access_point_policies/index.md | 17 +- .../access_point_policy/index.md | 23 ++- .../aws/s3objectlambda/access_points/index.md | 17 +- .../aws/s3outposts/access_point/index.md | 29 +-- .../aws/s3outposts/access_points/index.md | 17 +- .../providers/aws/s3outposts/bucket/index.md | 29 +-- .../aws/s3outposts/bucket_policies/index.md | 17 +- .../aws/s3outposts/bucket_policy/index.md | 23 ++- .../providers/aws/s3outposts/buckets/index.md | 17 +- .../aws/s3outposts/endpoint/index.md | 39 ++-- .../aws/s3outposts/endpoints/index.md | 17 +- .../providers/aws/sagemaker/app/index.md | 29 +-- .../aws/sagemaker/app_image_config/index.md | 31 +-- .../aws/sagemaker/app_image_configs/index.md | 17 +- .../providers/aws/sagemaker/apps/index.md | 23 ++- .../data_quality_job_definition/index.md | 41 ++-- .../data_quality_job_definitions/index.md | 17 +- .../providers/aws/sagemaker/device/index.md | 25 +-- .../aws/sagemaker/device_fleet/index.md | 29 +-- .../aws/sagemaker/device_fleets/index.md | 17 +- .../providers/aws/sagemaker/devices/index.md | 17 +- .../aws/sagemaker/feature_group/index.md | 43 +++-- .../aws/sagemaker/feature_groups/index.md | 17 +- .../providers/aws/sagemaker/image/index.md | 31 +-- .../aws/sagemaker/image_version/index.md | 49 ++--- .../aws/sagemaker/image_versions/index.md | 17 +- .../providers/aws/sagemaker/images/index.md | 17 +- .../sagemaker/inference_component/index.md | 43 +++-- .../sagemaker/inference_components/index.md | 17 +- .../sagemaker/inference_experiment/index.md | 55 +++--- .../sagemaker/inference_experiments/index.md | 17 +- .../model_bias_job_definition/index.md | 41 ++-- .../model_bias_job_definitions/index.md | 17 +- .../aws/sagemaker/model_card/index.md | 43 +++-- .../aws/sagemaker/model_cards/index.md | 17 +- .../index.md | 41 ++-- .../index.md | 17 +- .../aws/sagemaker/model_package/index.md | 73 ++++---- .../sagemaker/model_package_group/index.md | 33 ++-- .../sagemaker/model_package_groups/index.md | 17 +- .../aws/sagemaker/model_packages/index.md | 17 +- .../model_quality_job_definition/index.md | 41 ++-- .../model_quality_job_definitions/index.md | 17 +- .../sagemaker/monitoring_schedule/index.md | 39 ++-- .../sagemaker/monitoring_schedules/index.md | 17 +- .../providers/aws/sagemaker/pipeline/index.md | 33 ++-- .../aws/sagemaker/pipelines/index.md | 17 +- .../providers/aws/sagemaker/project/index.md | 37 ++-- .../providers/aws/sagemaker/projects/index.md | 17 +- .../providers/aws/sagemaker/space/index.md | 37 ++-- .../providers/aws/sagemaker/spaces/index.md | 19 +- .../aws/sagemaker/user_profile/index.md | 33 ++-- .../aws/sagemaker/user_profiles/index.md | 19 +- .../providers/aws/scheduler/schedule/index.md | 43 +++-- .../aws/scheduler/schedule_group/index.md | 31 +-- .../aws/scheduler/schedule_groups/index.md | 17 +- .../aws/scheduler/schedules/index.md | 17 +- .../aws/secretsmanager/secret/index.md | 35 ++-- .../aws/secretsmanager/secrets/index.md | 17 +- .../aws/securityhub/automation_rule/index.md | 43 +++-- .../aws/securityhub/automation_rules/index.md | 17 +- .../aws/securityhub/delegated_admin/index.md | 21 ++- .../aws/securityhub/delegated_admins/index.md | 17 +- .../providers/aws/securityhub/hub/index.md | 31 +-- .../providers/aws/securityhub/hubs/index.md | 17 +- .../aws/securityhub/insight/index.md | 27 +-- .../aws/securityhub/insights/index.md | 17 +- .../securityhub/product_subscription/index.md | 19 +- .../product_subscriptions/index.md | 17 +- .../aws/securityhub/standard/index.md | 25 +-- .../aws/securityhub/standards/index.md | 17 +- .../aws/securitylake/data_lake/index.md | 33 ++-- .../aws/securitylake/data_lakes/index.md | 17 +- .../aws/securitylake/subscriber/index.md | 43 +++-- .../aws/securitylake/subscribers/index.md | 17 +- .../index.md | 51 ++--- .../index.md | 17 +- .../servicecatalog/service_action/index.md | 31 +-- .../service_action_association/index.md | 21 ++- .../service_action_associations/index.md | 21 ++- .../servicecatalog/service_actions/index.md | 17 +- .../application/index.md | 35 ++-- .../applications/index.md | 17 +- .../attribute_group/index.md | 31 +-- .../attribute_group_association/index.md | 23 ++- .../attribute_group_associations/index.md | 19 +- .../attribute_groups/index.md | 17 +- .../resource_association/index.md | 25 +-- .../resource_associations/index.md | 21 ++- .../aws/ses/configuration_set/index.md | 33 ++-- .../index.md | 25 +-- .../index.md | 17 +- .../aws/ses/configuration_sets/index.md | 17 +- .../providers/aws/ses/contact_list/index.md | 27 +-- .../providers/aws/ses/contact_lists/index.md | 17 +- .../aws/ses/dedicated_ip_pool/index.md | 23 ++- .../aws/ses/dedicated_ip_pools/index.md | 17 +- .../aws/ses/email_identities/index.md | 17 +- .../providers/aws/ses/email_identity/index.md | 43 +++-- .../providers/aws/ses/template/index.md | 23 ++- .../providers/aws/ses/templates/index.md | 17 +- .../providers/aws/ses/vdm_attributes/index.md | 25 +-- .../providers/aws/shield/drt_access/index.md | 25 +-- .../aws/shield/drt_accesses/index.md | 17 +- .../aws/shield/proactive_engagement/index.md | 25 +-- .../aws/shield/proactive_engagements/index.md | 17 +- .../providers/aws/shield/protection/index.md | 33 ++-- .../aws/shield/protection_group/index.md | 33 ++-- .../aws/shield/protection_groups/index.md | 17 +- .../providers/aws/shield/protections/index.md | 17 +- .../aws/signer/profile_permission/index.md | 25 +-- .../aws/signer/profile_permissions/index.md | 19 +- .../aws/signer/signing_profile/index.md | 33 ++-- .../aws/signer/signing_profiles/index.md | 17 +- .../aws/simspaceweaver/simulation/index.md | 31 +-- .../aws/simspaceweaver/simulations/index.md | 17 +- .../aws-docs/providers/aws/sns/topic/index.md | 45 ++--- .../aws/sns/topic_inline_policies/index.md | 17 +- .../aws/sns/topic_inline_policy/index.md | 23 ++- .../providers/aws/sns/topics/index.md | 17 +- .../aws-docs/providers/aws/sqs/queue/index.md | 55 +++--- .../aws/sqs/queue_inline_policies/index.md | 17 +- .../aws/sqs/queue_inline_policy/index.md | 23 ++- .../providers/aws/sqs/queues/index.md | 17 +- .../providers/aws/ssm/association/index.md | 55 +++--- .../providers/aws/ssm/associations/index.md | 17 +- .../providers/aws/ssm/document/index.md | 39 ++-- .../providers/aws/ssm/documents/index.md | 17 +- .../providers/aws/ssm/parameter/index.md | 37 ++-- .../providers/aws/ssm/parameters/index.md | 17 +- .../providers/aws/ssm/patch_baseline/index.md | 49 ++--- .../aws/ssm/patch_baselines/index.md | 17 +- .../aws/ssm/resource_data_sync/index.md | 37 ++-- .../aws/ssm/resource_data_syncs/index.md | 17 +- .../aws/ssm/resource_policies/index.md | 19 +- .../aws/ssm/resource_policy/index.md | 27 +-- .../aws/ssmcontacts/contact/index.md | 29 +-- .../aws/ssmcontacts/contact_channel/index.md | 31 +-- .../aws/ssmcontacts/contact_channels/index.md | 17 +- .../aws/ssmcontacts/contacts/index.md | 17 +- .../providers/aws/ssmcontacts/plan/index.md | 27 +-- .../providers/aws/ssmcontacts/plans/index.md | 17 +- .../aws/ssmcontacts/rotation/index.md | 33 ++-- .../aws/ssmcontacts/rotations/index.md | 17 +- .../aws/ssmincidents/replication_set/index.md | 27 +-- .../ssmincidents/replication_sets/index.md | 17 +- .../aws/ssmincidents/response_plan/index.md | 37 ++-- .../aws/ssmincidents/response_plans/index.md | 17 +- .../providers/aws/sso/assignment/index.md | 27 +-- .../providers/aws/sso/assignments/index.md | 27 +-- .../index.md | 25 +-- .../index.md | 17 +- .../providers/aws/sso/permission_set/index.md | 41 ++-- .../aws/sso/permission_sets/index.md | 19 +- .../aws/stepfunctions/activities/index.md | 17 +- .../aws/stepfunctions/activity/index.md | 25 +-- .../aws/stepfunctions/state_machine/index.md | 45 ++--- .../state_machine_alias/index.md | 29 +-- .../state_machine_aliases/index.md | 17 +- .../state_machine_version/index.md | 23 ++- .../state_machine_versions/index.md | 17 +- .../aws/stepfunctions/state_machines/index.md | 17 +- .../aws/supportapp/account_alias/index.md | 23 ++- .../aws/supportapp/account_aliases/index.md | 17 +- .../slack_channel_configuration/index.md | 35 ++-- .../slack_channel_configurations/index.md | 19 +- .../slack_workspace_configuration/index.md | 23 ++- .../slack_workspace_configurations/index.md | 17 +- .../aws/synthetics/canaries/index.md | 17 +- .../providers/aws/synthetics/canary/index.md | 53 +++--- .../providers/aws/synthetics/group/index.md | 27 +-- .../providers/aws/synthetics/groups/index.md | 17 +- .../systemsmanagersap/application/index.md | 35 ++-- .../systemsmanagersap/applications/index.md | 17 +- .../aws/timestream/database/index.md | 27 +-- .../aws/timestream/databases/index.md | 17 +- .../aws/timestream/influxdb_instance/index.md | 63 ++++--- .../timestream/influxdb_instances/index.md | 17 +- .../aws/timestream/scheduled_queries/index.md | 17 +- .../aws/timestream/scheduled_query/index.md | 57 +++--- .../providers/aws/timestream/table/index.md | 35 ++-- .../providers/aws/timestream/tables/index.md | 19 +- .../providers/aws/transfer/agreement/index.md | 39 ++-- .../aws/transfer/agreements/index.md | 19 +- .../aws/transfer/certificate/index.md | 49 ++--- .../aws/transfer/certificates/index.md | 17 +- .../providers/aws/transfer/connector/index.md | 35 ++-- .../aws/transfer/connectors/index.md | 17 +- .../providers/aws/transfer/profile/index.md | 31 +-- .../providers/aws/transfer/profiles/index.md | 17 +- .../providers/aws/transfer/workflow/index.md | 31 +-- .../providers/aws/transfer/workflows/index.md | 17 +- .../identity_source/index.md | 29 +-- .../identity_sources/index.md | 19 +- .../aws/verifiedpermissions/policies/index.md | 19 +- .../aws/verifiedpermissions/policy/index.md | 27 +-- .../verifiedpermissions/policy_store/index.md | 29 +-- .../policy_stores/index.md | 17 +- .../policy_template/index.md | 27 +-- .../policy_templates/index.md | 19 +- .../providers/aws/voiceid/domain/index.md | 29 +-- .../providers/aws/voiceid/domains/index.md | 17 +- .../access_log_subscription/index.md | 33 ++-- .../access_log_subscriptions/index.md | 17 +- .../aws/vpclattice/auth_policies/index.md | 17 +- .../aws/vpclattice/auth_policy/index.md | 25 +-- .../aws/vpclattice/listener/index.md | 39 ++-- .../aws/vpclattice/listeners/index.md | 17 +- .../aws/vpclattice/resource_policies/index.md | 17 +- .../aws/vpclattice/resource_policy/index.md | 23 ++- .../providers/aws/vpclattice/rule/index.md | 37 ++-- .../providers/aws/vpclattice/rules/index.md | 17 +- .../providers/aws/vpclattice/service/index.md | 41 ++-- .../aws/vpclattice/service_network/index.md | 33 ++-- .../index.md | 47 ++--- .../index.md | 17 +- .../service_network_vpc_association/index.md | 43 +++-- .../service_network_vpc_associations/index.md | 17 +- .../aws/vpclattice/service_networks/index.md | 17 +- .../aws/vpclattice/services/index.md | 17 +- .../aws/vpclattice/target_group/index.md | 39 ++-- .../aws/vpclattice/target_groups/index.md | 17 +- .../providers/aws/wafv2/ip_set/index.md | 35 ++-- .../providers/aws/wafv2/ip_sets/index.md | 21 ++- .../aws/wafv2/logging_configuration/index.md | 29 +-- .../aws/wafv2/logging_configurations/index.md | 17 +- .../aws/wafv2/regex_pattern_set/index.md | 33 ++-- .../aws/wafv2/regex_pattern_sets/index.md | 21 ++- .../providers/aws/wafv2/rule_group/index.md | 45 ++--- .../providers/aws/wafv2/rule_groups/index.md | 21 ++- .../providers/aws/wafv2/web_acl/index.md | 51 ++--- .../providers/aws/wafv2/web_acls/index.md | 21 ++- .../aws/wafv2/webacl_association/index.md | 23 ++- .../aws/wafv2/webacl_associations/index.md | 19 +- .../providers/aws/wisdom/assistant/index.md | 33 ++-- .../aws/wisdom/assistant_association/index.md | 33 ++-- .../wisdom/assistant_associations/index.md | 19 +- .../providers/aws/wisdom/assistants/index.md | 17 +- .../aws/wisdom/knowledge_base/index.md | 37 ++-- .../aws/wisdom/knowledge_bases/index.md | 17 +- .../aws/workspaces/connection_alias/index.md | 25 +-- .../workspaces/connection_aliases/index.md | 17 +- .../workspacesthinclient/environment/index.md | 57 +++--- .../environments/index.md | 17 +- .../workspacesweb/browser_settings/index.md | 31 +-- .../workspacesweb/identity_provider/index.md | 29 +-- .../workspacesweb/identity_providers/index.md | 17 +- .../workspacesweb/ip_access_settings/index.md | 37 ++-- .../workspacesweb/network_settings/index.md | 31 +-- .../aws/workspacesweb/portal/index.md | 57 +++--- .../aws/workspacesweb/portals/index.md | 17 +- .../aws/workspacesweb/trust_store/index.md | 27 +-- .../aws/workspacesweb/trust_stores/index.md | 17 +- .../user_access_logging_settings/index.md | 27 +-- .../aws/workspacesweb/user_settings/index.md | 45 ++--- .../providers/aws/xray/group/index.md | 29 +-- .../providers/aws/xray/groups/index.md | 17 +- .../aws/xray/resource_policies/index.md | 17 +- .../aws/xray/resource_policy/index.md | 25 +-- .../providers/aws/xray/sampling_rule/index.md | 31 +-- .../aws/xray/sampling_rules/index.md | 17 +- package.json | 1 + src/components/CopyableCode/CopyableCode.js | 29 +++ src/css/global.css | 19 +- yarn.lock | 31 +++ 1920 files changed, 28504 insertions(+), 22681 deletions(-) create mode 100644 src/components/CopyableCode/CopyableCode.js diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 8a3b600b12..f36466116a 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -16,11 +16,11 @@ jobs: - name: Get changed files id: changed-files - uses: tj-actions/changed-files@v35 + uses: tj-actions/changed-files@v44.3.0 - name: find updated providers id: provider-to-deploy - uses: actions/github-script@v6 + uses: actions/github-script@v7.0.1 env: CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} with: @@ -43,7 +43,7 @@ jobs: - name: Send Slack message id: slack - uses: slackapi/slack-github-action@v1.23.0 + uses: slackapi/slack-github-action@v1.26.0 with: payload-file-path: slack-message.json env: @@ -105,7 +105,7 @@ jobs: - name: Send Slack message id: slack - uses: slackapi/slack-github-action@v1.23.0 + uses: slackapi/slack-github-action@v1.26.0 with: payload-file-path: slack-message.json env: diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md index 238a49fcf1..743db6f906 100644 --- a/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual analyzer resource, use analyzers to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual analyzer resource, use anal Nameanalyzer TypeResource DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account -Idaws.accessanalyzer.analyzer +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
analyzer_namestringAnalyzer name
archive_rulesarray
arnstringAmazon Resource Name (ARN) of the analyzer
tagsarrayAn array of key-value pairs to apply to this resource.
typestringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
analyzer_configurationobjectThe configuration for the analyzer
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual analyzer resource, use anal Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md index 43bafe4df2..31a1f7f522 100644 --- a/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of analyzers in a region or create a analyzers resource, use analyzer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of analyzers in a region or create a Nameanalyzers TypeResource DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account -Idaws.accessanalyzer.analyzers +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the analyzer
regionstringAWS region.
stringAmazon Resource Name (ARN) of the analyzer
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of analyzers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate/index.md b/docs/aws-docs/providers/aws/acmpca/certificate/index.md index 3067eb3a53..56c54ee4b8 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate resource, use certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual certificate resource, use c Namecertificate TypeResource DescriptionThe ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action. -Idaws.acmpca.certificate +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
api_passthroughobjectSpecifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored.
certificate_authority_arnstringThe Amazon Resource Name (ARN) for the private CA issues the certificate.
certificate_signing_requeststringThe certificate signing request (CSR) for the certificate.
signing_algorithmstringThe name of the algorithm that will be used to sign the certificate to be issued. <br/> This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.<br/> The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
template_arnstringSpecifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).
validityobjectThe period of time during which the certificate will be valid.
validity_not_beforeobjectInformation describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.<br/> By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value. <br/> Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.<br/> The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.
certificatestring
arnstring
regionstringAWS region.
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. <br/> This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.<br/> The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
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.<br/> By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value. <br/> Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.<br/> The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual certificate resource, use c Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md index 30f6e2ddc6..4b3f7207c7 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificate_authorities in a region or create a certificate_authorities resource, use certificate_authority to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificate_authorities in a region or c Namecertificate_authorities TypeResource DescriptionPrivate certificate authority. -Idaws.acmpca.certificate_authorities +Id ## Fields - - + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the certificate authority.
regionstringAWS region.
undefinedThe Amazon Resource Name (ARN) of the certificate authority.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificate_authorities in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md index a66c8fb15c..a5527150c1 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate_authority resource, use certificate_authorities to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual certificate_authority resource, u Namecertificate_authority TypeResource DescriptionPrivate certificate authority. -Idaws.acmpca.certificate_authority +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the certificate authority.
typestringThe type of the certificate authority.
key_algorithmstringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
signing_algorithmstringAlgorithm your CA uses to sign certificate requests.
subjectobjectStructure that contains X.500 distinguished name information for your CA.
revocation_configurationobjectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
tagsarray
certificate_signing_requeststringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
csr_extensionsobjectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
key_storage_security_standardstringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
usage_modestringUsage mode of the ceritificate authority.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual certificate_authority resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md index 1169ac9da0..14dddc7d81 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate_authority_activation resource, use certificate_authority_activations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual certificate_authority_activation Namecertificate_authority_activation TypeResource DescriptionUsed to install the certificate authority certificate and update the certificate authority status. -Idaws.acmpca.certificate_authority_activation +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
certificate_authority_arnstringArn of the Certificate Authority.
certificatestringCertificate Authority certificate that will be installed in the Certificate Authority.
certificate_chainstringCertificate chain for the Certificate Authority certificate.
statusstringThe status of the Certificate Authority.
complete_certificate_chainstringThe complete certificate chain, including the Certificate Authority certificate.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual certificate_authority_activation Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md index 50371f76b0..2a44f2fb06 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificate_authority_activations in a region or create a certificate_authority_activations resource, use certificate_authority_activation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificate_authority_activations in a r Namecertificate_authority_activations TypeResource DescriptionUsed to install the certificate authority certificate and update the certificate authority status. -Idaws.acmpca.certificate_authority_activations +Id ## Fields - - + +
NameDatatypeDescription
certificate_authority_arnstringArn of the Certificate Authority.
regionstringAWS region.
stringArn of the Certificate Authority.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificate_authority_activations in a r Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/acmpca/certificates/index.md b/docs/aws-docs/providers/aws/acmpca/certificates/index.md index fa1dcf5388..2e650f9643 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificates/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificates in a region or create a certificates resource, use certificate to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of certificates in a region or create a Namecertificates TypeResource DescriptionThe ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action. -Idaws.acmpca.certificates +Id ## Fields - - - + + +
NameDatatypeDescription
arnundefined
certificate_authority_arnundefinedThe Amazon Resource Name (ARN) for the private CA issues the certificate.
regionstringAWS region.
undefined
undefinedThe Amazon Resource Name (ARN) for the private CA issues the certificate.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of certificates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/acmpca/permission/index.md b/docs/aws-docs/providers/aws/acmpca/permission/index.md index 33d1534bda..26be293648 100644 --- a/docs/aws-docs/providers/aws/acmpca/permission/index.md +++ b/docs/aws-docs/providers/aws/acmpca/permission/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual permission resource, use permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual permission resource, use pe Namepermission TypeResource DescriptionPermission set on private certificate authority -Idaws.acmpca.permission +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
actionsarrayThe actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.
certificate_authority_arnstringThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principalstringThe AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
source_accountstringThe ID of the calling account.
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual permission resource, use pe Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/acmpca/permissions/index.md b/docs/aws-docs/providers/aws/acmpca/permissions/index.md index c601afa08a..39a6cdae63 100644 --- a/docs/aws-docs/providers/aws/acmpca/permissions/index.md +++ b/docs/aws-docs/providers/aws/acmpca/permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of permissions in a region or create a permissions resource, use permission to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of permissions in a region or create a Namepermissions TypeResource DescriptionPermission set on private certificate authority -Idaws.acmpca.permissions +Id ## Fields - - - + + +
NameDatatypeDescription
certificate_authority_arnstringThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principalstringThe AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
regionstringAWS region.
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.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of permissions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplify/app/index.md b/docs/aws-docs/providers/aws/amplify/app/index.md index 6d9faaea0b..413568ab5f 100644 --- a/docs/aws-docs/providers/aws/amplify/app/index.md +++ b/docs/aws-docs/providers/aws/amplify/app/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app resource, use apps to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual app resource, use appsNameapp TypeResource DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches. -Idaws.amplify.app +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
access_tokenstring
app_idstring
app_namestring
arnstring
auto_branch_creation_configobject
basic_auth_configobject
build_specstring
custom_headersstring
custom_rulesarray
default_domainstring
descriptionstring
enable_branch_auto_deletionboolean
environment_variablesarray
iam_service_rolestring
namestring
oauth_tokenstring
platformstring
repositorystring
tagsarray
regionstringAWS region.
string
string
string
string
object
object
string
string
array
string
string
boolean
array
string
string
string
string
string
array
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual app resource, use appsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplify/apps/index.md b/docs/aws-docs/providers/aws/amplify/apps/index.md index d88d66dca1..3df5a46715 100644 --- a/docs/aws-docs/providers/aws/amplify/apps/index.md +++ b/docs/aws-docs/providers/aws/amplify/apps/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of apps in a region or create a apps resource, use app to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of apps in a region or create a apps< Nameapps TypeResource DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches. -Idaws.amplify.apps +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of apps in a region or create a apps< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplify/branch/index.md b/docs/aws-docs/providers/aws/amplify/branch/index.md index 467f3d9fe3..71c5f2e2ce 100644 --- a/docs/aws-docs/providers/aws/amplify/branch/index.md +++ b/docs/aws-docs/providers/aws/amplify/branch/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual branch resource, use branches to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual branch resource, use branch Namebranch TypeResource DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app. -Idaws.amplify.branch +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
arnstring
basic_auth_configobject
backendobject
branch_namestring
build_specstring
descriptionstring
enable_auto_buildboolean
enable_performance_modeboolean
enable_pull_request_previewboolean
environment_variablesarray
frameworkstring
pull_request_environment_namestring
stagestring
tagsarray
regionstringAWS region.
string
string
object
object
string
string
string
boolean
boolean
boolean
array
string
string
string
array
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual branch resource, use branch Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplify/branches/index.md b/docs/aws-docs/providers/aws/amplify/branches/index.md index 4c7476817a..2ad4333e8d 100644 --- a/docs/aws-docs/providers/aws/amplify/branches/index.md +++ b/docs/aws-docs/providers/aws/amplify/branches/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of branches in a region or create a branches resource, use branch to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of branches in a region or create a b Namebranches TypeResource DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app. -Idaws.amplify.branches +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of branches in a region or create a b Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplify/domain/index.md b/docs/aws-docs/providers/aws/amplify/domain/index.md index c7fec39d1a..08a921bbc9 100644 --- a/docs/aws-docs/providers/aws/amplify/domain/index.md +++ b/docs/aws-docs/providers/aws/amplify/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app. -Idaws.amplify.domain +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
arnstring
auto_sub_domain_creation_patternsarray
auto_sub_domain_iam_rolestring
certificate_recordstring
certificateobject
certificate_settingsobject
domain_namestring
domain_statusstring
update_statusstring
enable_auto_sub_domainboolean
status_reasonstring
sub_domain_settingsarray
regionstringAWS region.
string
string
array
string
string
object
object
string
string
string
boolean
string
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplify/domains/index.md b/docs/aws-docs/providers/aws/amplify/domains/index.md index 8d806534c4..fe3b751ba2 100644 --- a/docs/aws-docs/providers/aws/amplify/domains/index.md +++ b/docs/aws-docs/providers/aws/amplify/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app. -Idaws.amplify.domains +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md index 4f8fd2189f..30c780a39f 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual component resource, use components to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual component resource, use com Namecomponent TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type -Idaws.amplifyuibuilder.component +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
binding_propertiesobject
childrenarray
collection_propertiesobject
component_typestring
created_atstring
environment_namestring
eventsobject
idstring
modified_atstring
namestring
overridesobject
propertiesobject
schema_versionstring
source_idstring
tagsobject
variantsarray
regionstringAWS region.
string
object
array
object
string
string
string
object
string
string
string
object
object
string
string
object
array
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual component resource, use com Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md index 74e1c9f1fe..6051f8ec81 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of components in a region or create a components resource, use component to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of components in a region or create a Namecomponents TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type -Idaws.amplifyuibuilder.components +Id ## Fields - - - - + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of components in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md index e763c7e99b..249c2abe68 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual form resource, use forms to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual form resource, use formsNameform TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type -Idaws.amplifyuibuilder.form +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
ctaobject
data_typeobject
environment_namestring
fieldsobject
form_action_typestring
idstring
label_decoratorstring
namestring
schema_versionstring
sectional_elementsobject
styleobject
tagsobject
regionstringAWS region.
string
object
object
string
object
string
string
string
string
string
object
object
object
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual form resource, use formsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md index 5a73b4558f..b9185ff051 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of forms in a region or create a forms resource, use form to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of forms in a region or create a form Nameforms TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type -Idaws.amplifyuibuilder.forms +Id ## Fields - - - - + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of forms in a region or create a form Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md index 46b25e295d..57b57b0eed 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual theme resource, use themes to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual theme resource, use themes< Nametheme TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type -Idaws.amplifyuibuilder.theme +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
app_idstring
created_atstring
environment_namestring
idstring
modified_atstring
namestring
overridesarray
tagsobject
valuesarray
regionstringAWS region.
string
string
string
string
string
string
array
object
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual theme resource, use themes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md index bc4076717d..7f54e907b9 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of themes in a region or create a themes resource, use theme to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of themes in a region or create a the Namethemes TypeResource DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type -Idaws.amplifyuibuilder.themes +Id ## Fields - - - - + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of themes in a region or create a the Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/account/index.md b/docs/aws-docs/providers/aws/apigateway/account/index.md index 3ef88b52d6..ad90402814 100644 --- a/docs/aws-docs/providers/aws/apigateway/account/index.md +++ b/docs/aws-docs/providers/aws/apigateway/account/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account resource, use accounts to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual account resource, use accou Nameaccount TypeResource DescriptionThe ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account. -Idaws.apigateway.account +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
cloud_watch_role_arnstringThe ARN of an Amazon CloudWatch role for the current Account.
regionstringAWS region.
string
stringThe ARN of an Amazon CloudWatch role for the current Account.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual account resource, use accou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/accounts/index.md b/docs/aws-docs/providers/aws/apigateway/accounts/index.md index 982c334f22..d59a1f2ef7 100644 --- a/docs/aws-docs/providers/aws/apigateway/accounts/index.md +++ b/docs/aws-docs/providers/aws/apigateway/accounts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of accounts in a region or create a accounts resource, use account to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of accounts in a region or create a a Nameaccounts TypeResource DescriptionThe ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account. -Idaws.apigateway.accounts +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of accounts in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/api_key/index.md b/docs/aws-docs/providers/aws/apigateway/api_key/index.md index 79dcb1a132..3ba61bdc8b 100644 --- a/docs/aws-docs/providers/aws/apigateway/api_key/index.md +++ b/docs/aws-docs/providers/aws/apigateway/api_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual api_key resource, use api_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual api_key resource, use api_k Nameapi_key TypeResource DescriptionThe ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key. -Idaws.apigateway.api_key +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
api_key_idstring
customer_idstringAn MKT customer identifier, when integrating with the AWS SaaS Marketplace.
descriptionstringThe description of the ApiKey.
enabledbooleanSpecifies whether the ApiKey can be used by callers.
generate_distinct_idbooleanSpecifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
namestringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stage_keysarrayDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
tagsarrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
valuestringSpecifies a value of the API key.
regionstringAWS region.
string
stringAn MKT customer identifier, when integrating with the AWS SaaS Marketplace.
stringThe description of the ApiKey.
booleanSpecifies whether the ApiKey can be used by callers.
booleanSpecifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
arrayDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
arrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
stringSpecifies a value of the API key.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual api_key resource, use api_k Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/api_keys/index.md b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md index 23013df608..a4cba4248a 100644 --- a/docs/aws-docs/providers/aws/apigateway/api_keys/index.md +++ b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of api_keys in a region or create a api_keys resource, use api_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of api_keys in a region or create a a Nameapi_keys TypeResource DescriptionThe ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key. -Idaws.apigateway.api_keys +Id ## Fields - - + +
NameDatatypeDescription
api_key_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of api_keys in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/authorizer/index.md b/docs/aws-docs/providers/aws/apigateway/authorizer/index.md index 92780e679d..4687fb3ae7 100644 --- a/docs/aws-docs/providers/aws/apigateway/authorizer/index.md +++ b/docs/aws-docs/providers/aws/apigateway/authorizer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual authorizer resource, use authorizers to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual authorizer resource, use au Nameauthorizer TypeResource DescriptionThe ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. -Idaws.apigateway.authorizer +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
authorizer_idstring
auth_typestringOptional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_credentialsstringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
authorizer_result_ttl_in_secondsintegerThe TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
authorizer_uristringSpecifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
identity_sourcestringThe identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
identity_validation_expressionstringA validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
namestringThe name of the authorizer.
provider_arnsarrayA list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
typestringThe authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
regionstringAWS region.
stringThe string identifier of the associated RestApi.
string
stringOptional customer-defined field, used in OpenAPI imports and exports without functional impact.
stringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
integerThe TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
stringSpecifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
stringThe identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
stringA validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
stringThe name of the authorizer.
arrayA list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
stringThe authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual authorizer resource, use au Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/authorizers/index.md b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md index 37d4521048..6fb30dff43 100644 --- a/docs/aws-docs/providers/aws/apigateway/authorizers/index.md +++ b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of authorizers in a region or create a authorizers resource, use authorizer to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of authorizers in a region or create a Nameauthorizers TypeResource DescriptionThe ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. -Idaws.apigateway.authorizers +Id ## Fields - - - + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
authorizer_idstring
regionstringAWS region.
stringThe string identifier of the associated RestApi.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of authorizers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md index a059e05bdf..6b98bd69e7 100644 --- a/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual base_path_mapping resource, use base_path_mappings to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual base_path_mapping resource, use < Namebase_path_mapping TypeResource DescriptionThe ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL. -Idaws.apigateway.base_path_mapping +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
base_pathstringThe base path name that callers of the API must provide as part of the URL after the domain name.
domain_namestringThe domain name of the BasePathMapping resource to be described.
rest_api_idstringThe string identifier of the associated RestApi.
stagestringThe name of the associated stage.
regionstringAWS region.
stringThe base path name that callers of the API must provide as part of the URL after the domain name.
stringThe domain name of the BasePathMapping resource to be described.
stringThe string identifier of the associated RestApi.
stringThe name of the associated stage.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual base_path_mapping resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md index 65b43c9db1..ebf39acced 100644 --- a/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of base_path_mappings in a region or create a base_path_mappings resource, use base_path_mapping to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of base_path_mappings in a region or create Namebase_path_mappings TypeResource DescriptionThe ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL. -Idaws.apigateway.base_path_mappings +Id ## Fields - - - + + +
NameDatatypeDescription
domain_namestringThe domain name of the BasePathMapping resource to be described.
base_pathstringThe base path name that callers of the API must provide as part of the URL after the domain name.
regionstringAWS region.
stringThe domain name of the BasePathMapping resource to be described.
stringThe base path name that callers of the API must provide as part of the URL after the domain name.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of base_path_mappings in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md index dc5f953311..252ee64e77 100644 --- a/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md +++ b/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual client_certificate resource, use client_certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual client_certificate resource, use Nameclient_certificate TypeResource DescriptionThe ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint. -Idaws.apigateway.client_certificate +Id ## Fields - - - - + + + +
NameDatatypeDescription
client_certificate_idstring
descriptionstringThe description of the client certificate.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
regionstringAWS region.
string
stringThe description of the client certificate.
arrayThe collection of tags. Each tag element is associated with a given resource.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual client_certificate resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md index 676b38e3c8..907e56fc31 100644 --- a/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md +++ b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of client_certificates in a region or create a client_certificates resource, use client_certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of client_certificates in a region or creat Nameclient_certificates TypeResource DescriptionThe ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint. -Idaws.apigateway.client_certificates +Id ## Fields - - + +
NameDatatypeDescription
client_certificate_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of client_certificates in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/deployment/index.md b/docs/aws-docs/providers/aws/apigateway/deployment/index.md index a89ee45c3b..f3270277c2 100644 --- a/docs/aws-docs/providers/aws/apigateway/deployment/index.md +++ b/docs/aws-docs/providers/aws/apigateway/deployment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual deployment resource, use deployments to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual deployment resource, use de Namedeployment TypeResource DescriptionThe ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment. -Idaws.apigateway.deployment +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
deployment_idstring
deployment_canary_settingsobjectThe input configuration for a canary deployment.
descriptionstringThe description for the Deployment resource to create.
rest_api_idstringThe string identifier of the associated RestApi.
stage_descriptionobjectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stage_namestringThe name of the Stage resource for the Deployment resource to create.
regionstringAWS region.
string
objectThe input configuration for a canary deployment.
stringThe description for the Deployment resource to create.
stringThe string identifier of the associated RestApi.
objectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stringThe name of the Stage resource for the Deployment resource to create.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual deployment resource, use de Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/deployments/index.md b/docs/aws-docs/providers/aws/apigateway/deployments/index.md index 8e2e785cde..6cff660bfd 100644 --- a/docs/aws-docs/providers/aws/apigateway/deployments/index.md +++ b/docs/aws-docs/providers/aws/apigateway/deployments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of deployments in a region or create a deployments resource, use deployment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of deployments in a region or create a Namedeployments TypeResource DescriptionThe ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment. -Idaws.apigateway.deployments +Id ## Fields - - - + + +
NameDatatypeDescription
deployment_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
string
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of deployments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md index b0f284eb33..4216626057 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual documentation_part resource, use documentation_parts to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual documentation_part resource, use Namedocumentation_part TypeResource DescriptionThe ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.documentation_part +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
documentation_part_idstring
locationobjectThe location of the targeted API entity of the to-be-created documentation part.
propertiesstringThe new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
string
objectThe location of the targeted API entity of the to-be-created documentation part.
stringThe new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual documentation_part resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md index a2b48de597..bba2122f31 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of documentation_parts in a region or create a documentation_parts resource, use documentation_part to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of documentation_parts in a region or creat Namedocumentation_parts TypeResource DescriptionThe ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.documentation_parts +Id ## Fields - - - + + +
NameDatatypeDescription
documentation_part_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
string
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of documentation_parts in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md index af45258b45..470830fcf4 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual documentation_version resource, use documentation_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual documentation_version resource, u Namedocumentation_version TypeResource DescriptionThe ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.documentation_version +Id ## Fields - - - - + + + +
NameDatatypeDescription
descriptionstringA description about the new documentation snapshot.
documentation_versionstringThe version identifier of the to-be-updated documentation version.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
stringA description about the new documentation snapshot.
stringThe version identifier of the to-be-updated documentation version.
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual documentation_version resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md index a1fa687448..1eacae6e60 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of documentation_versions in a region or create a documentation_versions resource, use documentation_version to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of documentation_versions in a region or cr Namedocumentation_versions TypeResource DescriptionThe ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.documentation_versions +Id ## Fields - - - + + +
NameDatatypeDescription
documentation_versionstringThe version identifier of the to-be-updated documentation version.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
stringThe version identifier of the to-be-updated documentation version.
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of documentation_versions in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_name/index.md b/docs/aws-docs/providers/aws/apigateway/domain_name/index.md index e999620764..5a5eb85f6b 100644 --- a/docs/aws-docs/providers/aws/apigateway/domain_name/index.md +++ b/docs/aws-docs/providers/aws/apigateway/domain_name/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain_name resource, use domain_names to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual domain_name resource, use d Namedomain_name TypeResource DescriptionResource Type definition for AWS::ApiGateway::DomainName. -Idaws.apigateway.domain_name +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestring
distribution_domain_namestring
distribution_hosted_zone_idstring
endpoint_configurationobject
mutual_tls_authenticationobject
regional_domain_namestring
regional_hosted_zone_idstring
certificate_arnstring
regional_certificate_arnstring
ownership_verification_certificate_arnstring
security_policystring
tagsarray
regionstringAWS region.
string
string
string
object
object
string
string
string
string
string
string
array
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual domain_name resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_names/index.md b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md index e91e6409ee..5b33922f44 100644 --- a/docs/aws-docs/providers/aws/apigateway/domain_names/index.md +++ b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domain_names in a region or create a domain_names resource, use domain_name to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domain_names in a region or create a Namedomain_names TypeResource DescriptionResource Type definition for AWS::ApiGateway::DomainName. -Idaws.apigateway.domain_names +Id ## Fields - - + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domain_names in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/method/index.md b/docs/aws-docs/providers/aws/apigateway/method/index.md index bb200d78f9..42b4c3a2ea 100644 --- a/docs/aws-docs/providers/aws/apigateway/method/index.md +++ b/docs/aws-docs/providers/aws/apigateway/method/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual method resource, use methods to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual method resource, use method Namemethod TypeResource DescriptionThe ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests. -Idaws.apigateway.method +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
api_key_requiredbooleanA boolean flag specifying whether a valid ApiKey is required to invoke this method.
authorization_scopesarrayA list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_typestringThe method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.<br/> If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.
authorizer_idstringThe identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
http_methodstringThe method's HTTP verb.
integrationobjectRepresents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
method_responsesarrayGets a method response associated with a given HTTP status code.
operation_namestringA human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example.
request_modelsobjectA key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
request_parametersobjectA key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
request_validator_idstringThe identifier of a RequestValidator for request validation.
resource_idstringThe Resource identifier for the MethodResponse resource.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
booleanA boolean flag specifying whether a valid ApiKey is required to invoke this method.
arrayA list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
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*.<br/> If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.
stringThe identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
stringThe method's HTTP verb.
objectRepresents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
arrayGets a method response associated with a given HTTP status code.
stringA human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example.
objectA key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
objectA key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
stringThe identifier of a RequestValidator for request validation.
stringThe Resource identifier for the MethodResponse resource.
stringThe string identifier of the associated RestApi.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual method resource, use method Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/methods/index.md b/docs/aws-docs/providers/aws/apigateway/methods/index.md index 70beeb48d6..bd1acbba45 100644 --- a/docs/aws-docs/providers/aws/apigateway/methods/index.md +++ b/docs/aws-docs/providers/aws/apigateway/methods/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of methods in a region or create a methods resource, use method to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of methods in a region or create a me Namemethods TypeResource DescriptionThe ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests. -Idaws.apigateway.methods +Id ## Fields - - - - + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
resource_idstringThe Resource identifier for the MethodResponse resource.
http_methodstringThe method's HTTP verb.
regionstringAWS region.
stringThe string identifier of the associated RestApi.
stringThe Resource identifier for the MethodResponse resource.
stringThe method's HTTP verb.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of methods in a region or create a me Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/model/index.md b/docs/aws-docs/providers/aws/apigateway/model/index.md index ec1a078c2c..348ec33950 100644 --- a/docs/aws-docs/providers/aws/apigateway/model/index.md +++ b/docs/aws-docs/providers/aws/apigateway/model/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model resource, use models to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual model resource, use models< Namemodel TypeResource DescriptionThe ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method. -Idaws.apigateway.model +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
content_typestringThe content-type for the model.
descriptionstringThe description of the model.
namestringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
rest_api_idstringThe string identifier of the associated RestApi.
schemaobjectThe schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
regionstringAWS region.
stringThe content-type for the model.
stringThe description of the model.
stringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe string identifier of the associated RestApi.
objectThe schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual model resource, use models< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/models/index.md b/docs/aws-docs/providers/aws/apigateway/models/index.md index 8ac9ee559f..3948649025 100644 --- a/docs/aws-docs/providers/aws/apigateway/models/index.md +++ b/docs/aws-docs/providers/aws/apigateway/models/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of models in a region or create a models resource, use model to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of models in a region or create a mod Namemodels TypeResource DescriptionThe ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method. -Idaws.apigateway.models +Id ## Fields - - - + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
namestringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
stringThe string identifier of the associated RestApi.
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).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of models in a region or create a mod Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/request_validator/index.md b/docs/aws-docs/providers/aws/apigateway/request_validator/index.md index c16660d2e0..cc753e03f7 100644 --- a/docs/aws-docs/providers/aws/apigateway/request_validator/index.md +++ b/docs/aws-docs/providers/aws/apigateway/request_validator/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual request_validator resource, use request_validators to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual request_validator resource, use < Namerequest_validator TypeResource DescriptionThe ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.request_validator +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
request_validator_idstring
namestringThe name of this RequestValidator
rest_api_idstringThe string identifier of the associated RestApi.
validate_request_bodybooleanA Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parametersbooleanA Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).
regionstringAWS region.
string
stringThe name of this RequestValidator
stringThe string identifier of the associated RestApi.
booleanA Boolean flag to indicate whether to validate a request body according to the configured Model schema.
booleanA Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual request_validator resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/request_validators/index.md b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md index 65d6078b43..18dba30399 100644 --- a/docs/aws-docs/providers/aws/apigateway/request_validators/index.md +++ b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of request_validators in a region or create a request_validators resource, use request_validator to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of request_validators in a region or create Namerequest_validators TypeResource DescriptionThe ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*. -Idaws.apigateway.request_validators +Id ## Fields - - - + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
request_validator_idstring
regionstringAWS region.
stringThe string identifier of the associated RestApi.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of request_validators in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/resource/index.md b/docs/aws-docs/providers/aws/apigateway/resource/index.md index e8d891b702..45a8251a76 100644 --- a/docs/aws-docs/providers/aws/apigateway/resource/index.md +++ b/docs/aws-docs/providers/aws/apigateway/resource/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource resource, use resources to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource resource, use reso Nameresource TypeResource DescriptionThe ``AWS::ApiGateway::Resource`` resource creates a resource in an API. -Idaws.apigateway.resource +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
resource_idstring
rest_api_idstringThe string identifier of the associated RestApi.
parent_idstringThe parent resource's identifier.
path_partstringThe last path segment for this resource.
regionstringAWS region.
string
stringThe string identifier of the associated RestApi.
stringThe parent resource's identifier.
stringThe last path segment for this resource.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource resource, use reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/resources/index.md b/docs/aws-docs/providers/aws/apigateway/resources/index.md index d43662169c..0c615309b5 100644 --- a/docs/aws-docs/providers/aws/apigateway/resources/index.md +++ b/docs/aws-docs/providers/aws/apigateway/resources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resources in a region or create a resources resource, use resource to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of resources in a region or create a Nameresources TypeResource DescriptionThe ``AWS::ApiGateway::Resource`` resource creates a resource in an API. -Idaws.apigateway.resources +Id ## Fields - - - + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
resource_idstring
regionstringAWS region.
stringThe string identifier of the associated RestApi.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of resources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_api/index.md b/docs/aws-docs/providers/aws/apigateway/rest_api/index.md index c47b528bac..061c264ab2 100644 --- a/docs/aws-docs/providers/aws/apigateway/rest_api/index.md +++ b/docs/aws-docs/providers/aws/apigateway/rest_api/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rest_api resource, use rest_apis to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual rest_api resource, use rest Namerest_api TypeResource DescriptionThe ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.<br/> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. -Idaws.apigateway.rest_api +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
rest_api_idstring
root_resource_idstring
api_key_source_typestringThe source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.
binary_media_typesarrayThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
bodyobjectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
body_s3_locationobjectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
clone_fromstringThe ID of the RestApi that you want to clone from.
endpoint_configurationobjectA list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
descriptionstringThe description of the RestApi.
disable_execute_api_endpointbooleanSpecifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
fail_on_warningsbooleanA query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
namestringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
minimum_compression_sizeintegerA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
modestringThis property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.<br/> Valid values are ``overwrite`` or ``merge``. <br/> For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.<br/> For ``merge``, the new API definition is merged with the existing API.<br/> If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. <br/> Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
policyobjectA policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``.
parametersobjectCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.
tagsarrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
regionstringAWS region.
string
string
stringThe source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.
arrayThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
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.
objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
stringThe ID of the RestApi that you want to clone from.
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.
stringThe description of the RestApi.
booleanSpecifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
booleanA query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
integerA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
stringThis property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.<br/> Valid values are ``overwrite`` or ``merge``. <br/> For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.<br/> For ``merge``, the new API definition is merged with the existing API.<br/> If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. <br/> Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
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 ``"*"``.
objectCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.
arrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual rest_api resource, use rest Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md index 70c83f8277..3ecc11e648 100644 --- a/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md +++ b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rest_apis in a region or create a rest_apis resource, use rest_api to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rest_apis in a region or create a Namerest_apis TypeResource DescriptionThe ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.<br/> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. -Idaws.apigateway.rest_apis +Id ## Fields - - + +
NameDatatypeDescription
rest_api_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rest_apis in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/stage/index.md b/docs/aws-docs/providers/aws/apigateway/stage/index.md index bebd3b6746..02e8cd1d7a 100644 --- a/docs/aws-docs/providers/aws/apigateway/stage/index.md +++ b/docs/aws-docs/providers/aws/apigateway/stage/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stage resource, use stages to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual stage resource, use stages< Namestage TypeResource DescriptionThe ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment. -Idaws.apigateway.stage +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
access_log_settingobjectAccess log settings, including the access log format and access log destination ARN.
cache_cluster_enabledbooleanSpecifies whether a cache cluster is enabled for the stage.
cache_cluster_sizestringThe stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
canary_settingobjectSettings for the canary deployment in this stage.
client_certificate_idstringThe identifier of a client certificate for an API stage.
deployment_idstringThe identifier of the Deployment that the stage points to.
descriptionstringThe stage's description.
documentation_versionstringThe version of the associated API documentation.
method_settingsarrayA map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\*/\*`` for overriding all methods in the stage.
rest_api_idstringThe string identifier of the associated RestApi.
stage_namestringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
tracing_enabledbooleanSpecifies whether active tracing with X-ray is enabled for the Stage.
variablesobjectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.
regionstringAWS region.
objectAccess log settings, including the access log format and access log destination ARN.
booleanSpecifies whether a cache cluster is enabled for the stage.
stringThe stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
objectSettings for the canary deployment in this stage.
stringThe identifier of a client certificate for an API stage.
stringThe identifier of the Deployment that the stage points to.
stringThe stage's description.
stringThe version of the associated API documentation.
arrayA map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\*/\*`` for overriding all methods in the stage.
stringThe string identifier of the associated RestApi.
stringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
arrayThe collection of tags. Each tag element is associated with a given resource.
booleanSpecifies whether active tracing with X-ray is enabled for the Stage.
objectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual stage resource, use stages< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/stages/index.md b/docs/aws-docs/providers/aws/apigateway/stages/index.md index b019974654..e803f6da72 100644 --- a/docs/aws-docs/providers/aws/apigateway/stages/index.md +++ b/docs/aws-docs/providers/aws/apigateway/stages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stages in a region or create a stages resource, use stage to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of stages in a region or create a sta Namestages TypeResource DescriptionThe ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment. -Idaws.apigateway.stages +Id ## Fields - - - + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
stage_namestringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
regionstringAWS region.
stringThe string identifier of the associated RestApi.
stringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of stages in a region or create a sta Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md index 4094786f33..8476205cf1 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual usage_plan resource, use usage_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual usage_plan resource, use us Nameusage_plan TypeResource DescriptionThe ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.<br/> In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests. -Idaws.apigateway.usage_plan +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
api_stagesarrayThe associated API stages of a usage plan.
descriptionstringThe description of a usage plan.
quotaobjectThe target maximum number of permitted requests per a given unit time interval.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
throttleobjectA map containing method level throttling information for API stage in a usage plan.
usage_plan_namestringThe name of a usage plan.
regionstringAWS region.
string
arrayThe associated API stages of a usage plan.
stringThe description of a usage plan.
objectThe target maximum number of permitted requests per a given unit time interval.
arrayThe collection of tags. Each tag element is associated with a given resource.
objectA map containing method level throttling information for API stage in a usage plan.
stringThe name of a usage plan.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual usage_plan resource, use us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md index a33e57da0a..7e781dd7ad 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual usage_plan_key resource, use usage_plan_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual usage_plan_key resource, use Nameusage_plan_key TypeResource DescriptionThe ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to. -Idaws.apigateway.usage_plan_key +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
key_idstringThe Id of the UsagePlanKey resource.
key_typestringThe type of a UsagePlanKey resource for a plan customer.
usage_plan_idstringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
idstring
regionstringAWS region.
stringThe Id of the UsagePlanKey resource.
stringThe type of a UsagePlanKey resource for a plan customer.
stringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual usage_plan_key resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md index fa3b8b50cc..3699c1f271 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of usage_plan_keys in a region or create a usage_plan_keys resource, use usage_plan_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of usage_plan_keys in a region or create a Nameusage_plan_keys TypeResource DescriptionThe ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to. -Idaws.apigateway.usage_plan_keys +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of usage_plan_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md index 5a58a09b05..579eea6c6e 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of usage_plans in a region or create a usage_plans resource, use usage_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of usage_plans in a region or create a Nameusage_plans TypeResource DescriptionThe ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.<br/> In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests. -Idaws.apigateway.usage_plans +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of usage_plans in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md index e1aadaa675..50e9db0860 100644 --- a/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md +++ b/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_link resource, use vpc_links to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual vpc_link resource, use vpc_ Namevpc_link TypeResource DescriptionSchema for AWS ApiGateway VpcLink -Idaws.apigateway.vpc_link +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringA name for the VPC link.
descriptionstringA description of the VPC link.
tagsarrayAn array of arbitrary tags (key-value pairs) to associate with the stage.
target_arnsarrayThe ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
vpc_link_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.
stringA name for the VPC link.
stringA description of the VPC link.
arrayAn array of arbitrary tags (key-value pairs) to associate with the stage.
arrayThe ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
stringThe ID of the instance that backs VPC link.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual vpc_link resource, use vpc_ Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md index e369434105..215a7db0b1 100644 --- a/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md +++ b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_links in a region or create a vpc_links resource, use vpc_link to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_links in a region or create a Namevpc_links TypeResource DescriptionSchema for AWS ApiGateway VpcLink -Idaws.apigateway.vpc_links +Id ## Fields - - + +
NameDatatypeDescription
vpc_link_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.
stringThe ID of the instance that backs VPC link.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_links in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api/index.md index 1a749e9b6e..f149b85c59 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/api/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/api/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual api resource, use apis to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual api resource, use apisNameapi TypeResource DescriptionThe ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.* -Idaws.apigatewayv2.api +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
route_selection_expressionstringThe route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
body_s3_locationobjectThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
descriptionstringThe description of the API.
api_endpointstring
base_pathstringSpecifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
fail_on_warningsbooleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
disable_execute_api_endpointbooleanSpecifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disable_schema_validationbooleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
namestringThe name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
targetstringThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
credentials_arnstringThis property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
cors_configurationobjectA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
versionstringA version identifier for the API.
protocol_typestringThe API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
route_keystringThis property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
api_idstring
bodyobjectThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
tagsobjectThe collection of tags. Each tag element is associated with a given resource.
api_key_selection_expressionstringAn API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
regionstringAWS region.
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.
@@ -59,19 +62,19 @@ Gets or operates on an individual api resource, use apisRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md index 93c793357e..4260df2a98 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual api_mapping resource, use api_mappings to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual api_mapping resource, use a Nameapi_mapping TypeResource DescriptionThe ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*. -Idaws.apigatewayv2.api_mapping +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
api_mapping_idstring
domain_namestringThe domain name.
stagestringThe API stage.
api_mapping_keystringThe API mapping key.
api_idstringThe identifier of the API.
regionstringAWS region.
string
stringThe domain name.
stringThe API stage.
stringThe API mapping key.
stringThe identifier of the API.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual api_mapping resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md index 4b96361d8e..afc29a52bc 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of api_mappings in a region or create a api_mappings resource, use api_mapping to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of api_mappings in a region or create a Nameapi_mappings TypeResource DescriptionThe ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*. -Idaws.apigatewayv2.api_mappings +Id ## Fields - - - + + +
NameDatatypeDescription
api_mapping_idstring
domain_namestringThe domain name.
regionstringAWS region.
string
stringThe domain name.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of api_mappings in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md index a24e150f76..57f227a9c4 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of apis in a region or create a apis resource, use api to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of apis in a region or create a apis< Nameapis TypeResource DescriptionThe ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.* -Idaws.apigatewayv2.apis +Id ## Fields - - + +
NameDatatypeDescription
api_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of apis in a region or create a apis< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md index 351c258111..e44ac8862b 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual authorizer resource, use authorizers to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual authorizer resource, use au Nameauthorizer TypeResource DescriptionThe ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.authorizer +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
identity_validation_expressionstringThis parameter is not used.
authorizer_uristringThe authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
authorizer_credentials_arnstringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.
authorizer_typestringThe authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).
jwt_configurationobjectThe ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
authorizer_result_ttl_in_secondsintegerThe time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
identity_sourcearrayThe identity source for which authorization is requested.<br/> For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).<br/> For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
authorizer_payload_format_versionstringSpecifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
api_idstringThe API identifier.
enable_simple_responsesbooleanSpecifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
authorizer_idstring
namestringThe name of the authorizer.
regionstringAWS region.
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.<br/> For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).<br/> For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual authorizer resource, use au Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md index 31f619c9b7..40696f81cd 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of authorizers in a region or create a authorizers resource, use authorizer to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of authorizers in a region or create a Nameauthorizers TypeResource DescriptionThe ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.authorizers +Id ## Fields - - - + + +
NameDatatypeDescription
authorizer_idstring
api_idstringThe API identifier.
regionstringAWS region.
string
stringThe API identifier.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of authorizers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md index 06df94e006..f44d528e99 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual deployment resource, use deployments to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual deployment resource, use de Namedeployment TypeResource DescriptionThe ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API. -Idaws.apigatewayv2.deployment +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
deployment_idstring
descriptionstringThe description for the deployment resource.
stage_namestringThe name of an existing stage to associate with the deployment.
api_idstringThe API identifier.
regionstringAWS region.
string
stringThe description for the deployment resource.
stringThe name of an existing stage to associate with the deployment.
stringThe API identifier.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual deployment resource, use de Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md index 30f41b92ab..b0bd5328ca 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of deployments in a region or create a deployments resource, use deployment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of deployments in a region or create a Namedeployments TypeResource DescriptionThe ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API. -Idaws.apigatewayv2.deployments +Id ## Fields - - - + + +
NameDatatypeDescription
api_idstringThe API identifier.
deployment_idstring
regionstringAWS region.
stringThe API identifier.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of deployments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md index 0d4517bcf7..c77a4ce6a1 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain_name resource, use domain_names to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual domain_name resource, use d Namedomain_name TypeResource DescriptionThe ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). <br/> You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.domain_name +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
mutual_tls_authenticationobjectThe mutual TLS authentication configuration for a custom domain name.
regional_hosted_zone_idstring
regional_domain_namestring
domain_namestringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
domain_name_configurationsarrayThe domain name configurations.
tagsobjectThe collection of tags associated with a domain name.
regionstringAWS region.
objectThe mutual TLS authentication configuration for a custom domain name.
string
string
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
arrayThe domain name configurations.
objectThe collection of tags associated with a domain name.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual domain_name resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md index f2d8561faf..3b514f2ffa 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domain_names in a region or create a domain_names resource, use domain_name to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domain_names in a region or create a Namedomain_names TypeResource DescriptionThe ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). <br/> You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.domain_names +Id ## Fields - - + +
NameDatatypeDescription
domain_namestringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
regionstringAWS region.
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domain_names in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md index 65a61745fe..8bd6c71f60 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual integration_response resource, use integration_responses to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual integration_response resource, us Nameintegration_response TypeResource DescriptionThe ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.integration_response +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
integration_response_idstring
response_templatesobjectThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
template_selection_expressionstringThe template selection expression for the integration response. Supported only for WebSocket APIs.
response_parametersobjectA key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.
content_handling_strategystringSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:<br/> ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.<br/> ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.<br/> If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
integration_idstringThe integration ID.
integration_response_keystringThe integration response key.
api_idstringThe API identifier.
regionstringAWS region.
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:<br/> ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.<br/> ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.<br/> If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
stringThe integration ID.
stringThe integration response key.
stringThe API identifier.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual integration_response resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md index c85e55938e..cdcc821c46 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of integration_responses in a region or create a integration_responses resource, use integration_response to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of integration_responses in a region or cre Nameintegration_responses TypeResource DescriptionThe ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.integration_responses +Id ## Fields - - - - + + + +
NameDatatypeDescription
api_idstringThe API identifier.
integration_idstringThe integration ID.
integration_response_idstring
regionstringAWS region.
stringThe API identifier.
stringThe integration ID.
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of integration_responses in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/model/index.md b/docs/aws-docs/providers/aws/apigatewayv2/model/index.md index 31230a616d..d23deabb49 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/model/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/model/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model resource, use models to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual model resource, use models< Namemodel TypeResource DescriptionThe ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.model +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
model_idstring
descriptionstringThe description of the model.
content_typestringThe content-type for the model, for example, "application/json".
schemaobjectThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
api_idstringThe API identifier.
namestringThe name of the model.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual model resource, use models< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/models/index.md b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md index ee79f29f83..6c591d0f6a 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/models/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of models in a region or create a models resource, use model to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of models in a region or create a mod Namemodels TypeResource DescriptionThe ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.models +Id ## Fields - - - + + +
NameDatatypeDescription
api_idstringThe API identifier.
model_idstring
regionstringAWS region.
stringThe API identifier.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of models in a region or create a mod Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route/index.md index 328eddb418..053613fd54 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/route/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/route/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route resource, use routes to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual route resource, use routes< Nameroute TypeResource DescriptionThe ``AWS::ApiGatewayV2::Route`` resource creates a route for an API. -Idaws.apigatewayv2.route +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
route_idstring
route_response_selection_expressionstringThe route response selection expression for the route. Supported only for WebSocket APIs.
request_modelsobjectThe request models for the route. Supported only for WebSocket APIs.
operation_namestringThe operation name for the route.
authorization_scopesarrayThe authorization scopes supported by this route.
api_key_requiredbooleanSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
route_keystringThe route key for the route. For HTTP APIs, the route key can be either ``$default``, or a combination of an HTTP method and resource path, for example, ``GET /pets``.
authorization_typestringThe authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer.
model_selection_expressionstringThe model selection expression for the route. Supported only for WebSocket APIs.
api_idstringThe API identifier.
request_parametersobjectThe request parameters for the route. Supported only for WebSocket APIs.
targetstringThe target for the route.
authorizer_idstringThe identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual route resource, use routes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md index a5f1f54fdc..7a7e6d6210 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route_response resource, use route_responses to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual route_response resource, use Nameroute_response TypeResource DescriptionThe ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.route_response +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
route_response_keystringThe route response key.
response_parametersundefinedThe route response parameters.
route_idstringThe route ID.
model_selection_expressionstringThe model selection expression for the route response. Supported only for WebSocket APIs.
api_idstringThe API identifier.
response_modelsobjectThe response models for the route response.
route_response_idstring
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual route_response resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md index ca78bbece4..c35bcbf8f2 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of route_responses in a region or create a route_responses resource, use route_response to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of route_responses in a region or create a Nameroute_responses TypeResource DescriptionThe ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.route_responses +Id ## Fields - - - - + + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstringThe route ID.
route_response_idstring
regionstringAWS region.
stringThe API identifier.
stringThe route ID.
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of route_responses in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md index 2fac5131f1..6b14ffc437 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of routes in a region or create a routes resource, use route to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of routes in a region or create a rou Nameroutes TypeResource DescriptionThe ``AWS::ApiGatewayV2::Route`` resource creates a route for an API. -Idaws.apigatewayv2.routes +Id ## Fields - - - + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstring
regionstringAWS region.
stringThe API identifier.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of routes in a region or create a rou Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md index 5a6192ce4d..750643ce9f 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_link resource, use vpc_links to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual vpc_link resource, use vpc_ Namevpc_link TypeResource DescriptionThe ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.vpc_link +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
vpc_link_idstring
subnet_idsarrayA list of subnet IDs to include in the VPC link.
security_group_idsarrayA list of security group IDs for the VPC link.
tagsobjectThe collection of tags. Each tag element is associated with a given resource.
namestringThe name of the VPC link.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual vpc_link resource, use vpc_ Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md index b257f18f04..d289567eaf 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_links in a region or create a vpc_links resource, use vpc_link to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_links in a region or create a Namevpc_links TypeResource DescriptionThe ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*. -Idaws.apigatewayv2.vpc_links +Id ## Fields - - + +
NameDatatypeDescription
vpc_link_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_links in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/application/index.md b/docs/aws-docs/providers/aws/appconfig/application/index.md index b167f51cb6..ca1d84a3d0 100644 --- a/docs/aws-docs/providers/aws/appconfig/application/index.md +++ b/docs/aws-docs/providers/aws/appconfig/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource Type definition for AWS::AppConfig::Application -Idaws.appconfig.application +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringA description of the application.
application_idstringThe application Id
tagsarrayMetadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
namestringA name for the application.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/applications/index.md b/docs/aws-docs/providers/aws/appconfig/applications/index.md index c9d8a4558d..50c1e31276 100644 --- a/docs/aws-docs/providers/aws/appconfig/applications/index.md +++ b/docs/aws-docs/providers/aws/appconfig/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource Type definition for AWS::AppConfig::Application -Idaws.appconfig.applications +Id ## Fields - - + +
NameDatatypeDescription
application_idstringThe application Id
regionstringAWS region.
stringThe application Id
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md index bb3248513e..7c5d91a223 100644 --- a/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration_profile resource, use configuration_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual configuration_profile resource, u Nameconfiguration_profile TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appconfig.configuration_profile +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
configuration_profile_idstringThe configuration profile ID
location_uristringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
typestringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
kms_key_identifierstringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
descriptionstringA description of the configuration profile.
kms_key_arnstringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
validatorsarrayA list of methods for validating the configuration.
retrieval_role_arnstringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
application_idstringThe application ID.
tagsarrayMetadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
namestringA name for the configuration profile.
regionstringAWS region.
stringThe configuration profile ID
stringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
stringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the configuration profile.
stringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
arrayA list of methods for validating the configuration.
stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
stringThe application ID.
arrayMetadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the configuration profile.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual configuration_profile resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md index 646299ce04..16cd81a861 100644 --- a/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configuration_profiles in a region or create a configuration_profiles resource, use configuration_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of configuration_profiles in a region or cr Nameconfiguration_profiles TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appconfig.configuration_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID
regionstringAWS region.
stringThe application ID.
stringThe configuration profile ID
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of configuration_profiles in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/environment/index.md b/docs/aws-docs/providers/aws/appconfig/environment/index.md index b490821c90..b7c6e7e5ed 100644 --- a/docs/aws-docs/providers/aws/appconfig/environment/index.md +++ b/docs/aws-docs/providers/aws/appconfig/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionResource Type definition for AWS::AppConfig::Environment -Idaws.appconfig.environment +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
environment_idstringThe environment ID.
descriptionstringA description of the environment.
monitorsarrayAmazon CloudWatch alarms to monitor during the deployment process.
application_idstringThe application ID.
tagsarrayMetadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
namestringA name for the environment.
regionstringAWS region.
stringThe environment ID.
stringA description of the environment.
arrayAmazon CloudWatch alarms to monitor during the deployment process.
stringThe application ID.
arrayMetadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the environment.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/environments/index.md b/docs/aws-docs/providers/aws/appconfig/environments/index.md index c6604708ae..8ab5ce5896 100644 --- a/docs/aws-docs/providers/aws/appconfig/environments/index.md +++ b/docs/aws-docs/providers/aws/appconfig/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionResource Type definition for AWS::AppConfig::Environment -Idaws.appconfig.environments +Id ## Fields - - - + + +
NameDatatypeDescription
application_idstringThe application ID.
environment_idstringThe environment ID.
regionstringAWS region.
stringThe application ID.
stringThe environment ID.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/extension/index.md b/docs/aws-docs/providers/aws/appconfig/extension/index.md index ce6653e7d8..c34c1d8cbf 100644 --- a/docs/aws-docs/providers/aws/appconfig/extension/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extension/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual extension resource, use extensions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual extension resource, use ext Nameextension TypeResource DescriptionResource Type definition for AWS::AppConfig::Extension -Idaws.appconfig.extension +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
version_numberinteger
namestringName of the extension.
descriptionstringDescription of the extension.
actionsobject
parametersobject
latest_version_numberinteger
tagsarrayAn array of key-value tags to apply to this resource.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual extension resource, use ext Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_association/index.md b/docs/aws-docs/providers/aws/appconfig/extension_association/index.md index 685f9e6c9c..fea9e1cda0 100644 --- a/docs/aws-docs/providers/aws/appconfig/extension_association/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extension_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual extension_association resource, use extension_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual extension_association resource, u Nameextension_association TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appconfig.extension_association +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
extension_arnstring
resource_arnstring
extension_identifierstring
resource_identifierstring
extension_version_numberinteger
parametersobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
string
string
integer
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual extension_association resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md index 1f1790500d..0fd0f3cfd7 100644 --- a/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of extension_associations in a region or create a extension_associations resource, use extension_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of extension_associations in a region or cr Nameextension_associations TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appconfig.extension_associations +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of extension_associations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/extensions/index.md b/docs/aws-docs/providers/aws/appconfig/extensions/index.md index 4e2a09cf93..58f0d8749b 100644 --- a/docs/aws-docs/providers/aws/appconfig/extensions/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extensions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of extensions in a region or create a extensions resource, use extension to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of extensions in a region or create a Nameextensions TypeResource DescriptionResource Type definition for AWS::AppConfig::Extension -Idaws.appconfig.extensions +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of extensions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md index bdd15e3a8b..4e2697d036 100644 --- a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hosted_configuration_version resource, use hosted_configuration_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual hosted_configuration_version reso Namehosted_configuration_version TypeResource DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion -Idaws.appconfig.hosted_configuration_version +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
configuration_profile_idstringThe configuration profile ID.
descriptionstringA description of the hosted configuration version.
content_typestringA standard MIME type describing the format of the configuration content.
latest_version_numberintegerAn optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
contentstringThe content of the configuration or the configuration data.
version_labelstringA user-defined label for an AWS AppConfig hosted configuration version.
application_idstringThe application ID.
version_numberstringCurrent version number of hosted configuration version.
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual hosted_configuration_version reso Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md index ce3414b200..88270ed0ed 100644 --- a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hosted_configuration_versions in a region or create a hosted_configuration_versions resource, use hosted_configuration_version to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of hosted_configuration_versions in a regio Namehosted_configuration_versions TypeResource DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion -Idaws.appconfig.hosted_configuration_versions +Id ## Fields - - - - + + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID.
version_numberstringCurrent version number of hosted configuration version.
regionstringAWS region.
stringThe application ID.
stringThe configuration profile ID.
stringCurrent version number of hosted configuration version.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of hosted_configuration_versions in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appflow/connector/index.md b/docs/aws-docs/providers/aws/appflow/connector/index.md index 00ea9c696d..9fc5e14007 100644 --- a/docs/aws-docs/providers/aws/appflow/connector/index.md +++ b/docs/aws-docs/providers/aws/appflow/connector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connector resource, use connectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual connector resource, use con Nameconnector TypeResource DescriptionResource schema for AWS::AppFlow::Connector -Idaws.appflow.connector +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
connector_labelstring The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
connector_arnstring The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.
connector_provisioning_typestringThe provisioning type of the connector. Currently the only supported value is LAMBDA.
connector_provisioning_configobjectContains information about the configuration of the connector being registered.
descriptionstringA description about the connector that's being registered.
regionstringAWS region.
string The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
string The 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.
@@ -45,19 +48,19 @@ Gets or operates on an individual connector resource, use con Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appflow/connector_profile/index.md b/docs/aws-docs/providers/aws/appflow/connector_profile/index.md index 55743f0002..68c39b0f5c 100644 --- a/docs/aws-docs/providers/aws/appflow/connector_profile/index.md +++ b/docs/aws-docs/providers/aws/appflow/connector_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connector_profile resource, use connector_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual connector_profile resource, use < Nameconnector_profile TypeResource DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile -Idaws.appflow.connector_profile +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
connector_profile_arnstringUnique identifier for connector profile resources
connector_labelstringThe label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
connector_profile_namestringThe maximum number of items to retrieve in a single batch.
kms_arnstringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
connector_typestringList of Saas providers that need connector profile to be created
connection_modestringMode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular
connector_profile_configobjectConnector specific configurations needed to create connector profile
credentials_arnstringA unique Arn for Connector-Profile resource
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual connector_profile resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md index fd9b246b16..a91d0d440b 100644 --- a/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md +++ b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connector_profiles in a region or create a connector_profiles resource, use connector_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connector_profiles in a region or create Nameconnector_profiles TypeResource DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile -Idaws.appflow.connector_profiles +Id ## Fields - - + +
NameDatatypeDescription
connector_profile_namestringThe maximum number of items to retrieve in a single batch.
regionstringAWS region.
stringThe maximum number of items to retrieve in a single batch.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connector_profiles in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appflow/connectors/index.md b/docs/aws-docs/providers/aws/appflow/connectors/index.md index ca0775e967..41588e6322 100644 --- a/docs/aws-docs/providers/aws/appflow/connectors/index.md +++ b/docs/aws-docs/providers/aws/appflow/connectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connectors in a region or create a connectors resource, use connector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connectors in a region or create a Nameconnectors TypeResource DescriptionResource schema for AWS::AppFlow::Connector -Idaws.appflow.connectors +Id ## Fields - - + +
NameDatatypeDescription
connector_labelstring The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
regionstringAWS region.
string The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appflow/flow/index.md b/docs/aws-docs/providers/aws/appflow/flow/index.md index eb2e8b2f89..7ca0f36e6b 100644 --- a/docs/aws-docs/providers/aws/appflow/flow/index.md +++ b/docs/aws-docs/providers/aws/appflow/flow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow resource, use flows to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual flow resource, use flowsNameflow TypeResource DescriptionResource schema for AWS::AppFlow::Flow. -Idaws.appflow.flow +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringARN identifier of the flow.
flow_namestringName of the flow.
descriptionstringDescription of the flow.
kms_arnstringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
trigger_configobjectTrigger settings of the flow.
flow_statusstringFlow activation status for Scheduled- and Event-triggered flows
source_flow_configobjectConfigurations of Source connector of the flow.
destination_flow_config_listarrayList of Destination connectors of the flow.
tasksarrayList of tasks for the flow.
tagsarrayList of Tags.
metadata_catalog_configobjectConfigurations of metadata catalog of the flow.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual flow resource, use flowsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appflow/flows/index.md b/docs/aws-docs/providers/aws/appflow/flows/index.md index a326c317df..d6a9e489e4 100644 --- a/docs/aws-docs/providers/aws/appflow/flows/index.md +++ b/docs/aws-docs/providers/aws/appflow/flows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flows in a region or create a flows resource, use flow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flows in a region or create a flow Nameflows TypeResource DescriptionResource schema for AWS::AppFlow::Flow. -Idaws.appflow.flows +Id ## Fields - - + +
NameDatatypeDescription
flow_namestringName of the flow.
regionstringAWS region.
stringName of the flow.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flows in a region or create a flow Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appintegrations/application/index.md b/docs/aws-docs/providers/aws/appintegrations/application/index.md index fc5bda9b72..224bfb5cdf 100644 --- a/docs/aws-docs/providers/aws/appintegrations/application/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource Type definition for AWS:AppIntegrations::Application -Idaws.appintegrations.application +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name of the application.
idstringThe id of the application.
namespacestringThe namespace of the application.
descriptionstringThe application description.
application_arnstringThe Amazon Resource Name (ARN) of the application.
application_source_configobjectApplication source config
permissionsarrayThe configuration of events or requests that the application has access to.
tagsarrayThe tags (keys and values) associated with the application.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appintegrations/applications/index.md b/docs/aws-docs/providers/aws/appintegrations/applications/index.md index 1fc8f5ac77..4f3ad7e067 100644 --- a/docs/aws-docs/providers/aws/appintegrations/applications/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource Type definition for AWS:AppIntegrations::Application -Idaws.appintegrations.applications +Id ## Fields - - + +
NameDatatypeDescription
application_arnstringThe Amazon Resource Name (ARN) of the application.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the application.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md index 9a080f2ea8..54821fdafb 100644 --- a/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_integration resource, use data_integrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual data_integration resource, use Namedata_integration TypeResource DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration -Idaws.appintegrations.data_integration +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe data integration description.
idstringThe unique identifer of the data integration.
data_integration_arnstringThe Amazon Resource Name (ARN) of the data integration.
namestringThe name of the data integration.
kms_keystringThe KMS key of the data integration.
schedule_configobjectThe name of the data and how often it should be pulled from the source.
source_uristringThe URI of the data source.
tagsarrayThe tags (keys and values) associated with the data integration.
file_configurationobjectThe configuration for what files should be pulled from the source.
object_configurationobjectThe configuration for what data should be pulled from the source.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual data_integration resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md index c96a27e72a..d92f6d2325 100644 --- a/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_integrations in a region or create a data_integrations resource, use data_integration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_integrations in a region or create Namedata_integrations TypeResource DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration -Idaws.appintegrations.data_integrations +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique identifer of the data integration.
regionstringAWS region.
stringThe unique identifer of the data integration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_integrations in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md index f55462ab32..7b630cd000 100644 --- a/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_integration resource, use event_integrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual event_integration resource, use < Nameevent_integration TypeResource DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration -Idaws.appintegrations.event_integration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
descriptionstringThe event integration description.
event_integration_arnstringThe Amazon Resource Name (ARN) of the event integration.
namestringThe name of the event integration.
event_bridge_busstringThe Amazon Eventbridge bus for the event integration.
event_filterobjectThe EventFilter (source) associated with the event integration.
tagsarrayThe tags (keys and values) associated with the event integration.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual event_integration resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md index fb4fc41db6..10d3d0cefb 100644 --- a/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_integrations in a region or create a event_integrations resource, use event_integration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_integrations in a region or create Nameevent_integrations TypeResource DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration -Idaws.appintegrations.event_integrations +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the event integration.
regionstringAWS region.
stringThe name of the event integration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_integrations in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md index 8086d4a349..9d2c377452 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scalable_target resource, use scalable_targets to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual scalable_target resource, use Namescalable_target TypeResource DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalableTarget -Idaws.applicationautoscaling.scalable_target +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
idstringThis value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
max_capacityintegerThe maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand
min_capacityintegerThe minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand
resource_idstringThe identifier of the resource associated with the scalable target
role_arnstringSpecify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf.
scalable_dimensionstringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
scheduled_actionsarrayThe scheduled actions for the scalable target. Duplicates aren't allowed.
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource
suspended_stateobjectAn embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
regionstringAWS region.
stringThis value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
integerThe maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand
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
stringThe identifier of the resource associated with the scalable target
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.
stringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
arrayThe scheduled actions for the scalable target. Duplicates aren't allowed.
stringThe namespace of the AWS service that provides the resource, or a custom-resource
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.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual scalable_target resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md index 4b1cdfbc86..97fe035e3b 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scalable_targets in a region or create a scalable_targets resource, use scalable_target to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of scalable_targets in a region or create a Namescalable_targets TypeResource DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalableTarget -Idaws.applicationautoscaling.scalable_targets +Id ## Fields - - - - + + + +
NameDatatypeDescription
resource_idstringThe identifier of the resource associated with the scalable target
scalable_dimensionstringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource
regionstringAWS region.
stringThe identifier of the resource associated with the scalable target
stringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
stringThe namespace of the AWS service that provides the resource, or a custom-resource
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of scalable_targets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md index 322994a8e6..9a9bae0d2e 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scaling_policies in a region or create a scaling_policies resource, use scaling_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of scaling_policies in a region or create a Namescaling_policies TypeResource DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy -Idaws.applicationautoscaling.scaling_policies +Id ## Fields - - - + + +
NameDatatypeDescription
arnstringARN is a read only property for the resource.
scalable_dimensionstringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
regionstringAWS region.
stringARN is a read only property for the resource.
stringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of scaling_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md index 930a20fbf7..973626387f 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scaling_policy resource, use scaling_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual scaling_policy resource, use Namescaling_policy TypeResource DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy -Idaws.applicationautoscaling.scaling_policy +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the scaling policy.<br/><br/>Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
policy_typestringThe scaling policy type.<br/><br/>The following policy types are supported:<br/><br/>TargetTrackingScaling Not supported for Amazon EMR<br/><br/>StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
resource_idstringThe identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
scalable_dimensionstringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
scaling_target_idstringThe CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource.
step_scaling_policy_configurationobjectA step scaling policy.
target_tracking_scaling_policy_configurationobjectA target tracking scaling policy.
arnstringARN is a read only property for the resource.
regionstringAWS region.
stringThe name of the scaling policy.<br/><br/>Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
stringThe scaling policy type.<br/><br/>The following policy types are supported:<br/><br/>TargetTrackingScaling Not supported for Amazon EMR<br/><br/>StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
stringThe identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
stringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
stringThe CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
objectA step scaling policy.
objectA target tracking scaling policy.
stringARN is a read only property for the resource.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual scaling_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/applicationinsights/application/index.md b/docs/aws-docs/providers/aws/applicationinsights/application/index.md index 81f1a91e9d..24d03cf21b 100644 --- a/docs/aws-docs/providers/aws/applicationinsights/application/index.md +++ b/docs/aws-docs/providers/aws/applicationinsights/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource schema for AWS::ApplicationInsights::Application -Idaws.applicationinsights.application +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
resource_group_namestringThe name of the resource group.
application_arnstringThe ARN of the ApplicationInsights application.
cwe_monitor_enabledbooleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
ops_center_enabledbooleanWhen set to true, creates opsItems for any problems detected on an application.
ops_item_sns_topic_arnstringThe SNS topic provided to Application Insights that is associated to the created opsItem.
tagsarrayThe tags of Application Insights application.
custom_componentsarrayThe custom grouped components.
log_pattern_setsarrayThe log pattern sets.
auto_configuration_enabledbooleanIf set to true, application will be configured with recommended monitoring configuration.
component_monitoring_settingsarrayThe monitoring settings of the components.
grouping_typestringThe grouping type of the application
attach_missing_permissionbooleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
regionstringAWS region.
stringThe name of the resource group.
stringThe ARN of the ApplicationInsights application.
booleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
booleanWhen set to true, creates opsItems for any problems detected on an application.
stringThe SNS topic provided to Application Insights that is associated to the created opsItem.
arrayThe tags of Application Insights application.
arrayThe custom grouped components.
arrayThe log pattern sets.
booleanIf set to true, application will be configured with recommended monitoring configuration.
arrayThe monitoring settings of the components.
stringThe grouping type of the application
booleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/applicationinsights/applications/index.md b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md index e89035b801..f36af451fa 100644 --- a/docs/aws-docs/providers/aws/applicationinsights/applications/index.md +++ b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource schema for AWS::ApplicationInsights::Application -Idaws.applicationinsights.applications +Id ## Fields - - + +
NameDatatypeDescription
application_arnstringThe ARN of the ApplicationInsights application.
regionstringAWS region.
stringThe ARN of the ApplicationInsights application.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md index 32dd503fb7..c4efbb0302 100644 --- a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual auto_scaling_configuration resource, use auto_scaling_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual auto_scaling_configuration resour Nameauto_scaling_configuration TypeResource DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services. -Idaws.apprunner.auto_scaling_configuration +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
auto_scaling_configuration_arnstringThe Amazon Resource Name (ARN) of this auto scaling configuration.
auto_scaling_configuration_namestringThe customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.
auto_scaling_configuration_revisionintegerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
max_concurrencyintegerThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.
max_sizeintegerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
min_sizeintegerThe minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
latestbooleanIt's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
tagsarrayA list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual auto_scaling_configuration resour Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md index d49968b490..974d933492 100644 --- a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of auto_scaling_configurations in a region or create a auto_scaling_configurations resource, use auto_scaling_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of auto_scaling_configurations in a region Nameauto_scaling_configurations TypeResource DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services. -Idaws.apprunner.auto_scaling_configurations +Id ## Fields - - + +
NameDatatypeDescription
auto_scaling_configuration_arnstringThe Amazon Resource Name (ARN) of this auto scaling configuration.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of auto_scaling_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md index 1dca3c318c..5a61e15678 100644 --- a/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md +++ b/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual observability_configuration resource, use observability_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual observability_configuration resou Nameobservability_configuration TypeResource DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration -Idaws.apprunner.observability_configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
observability_configuration_arnstringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
observability_configuration_namestringA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
observability_configuration_revisionintegerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
latestbooleanIt's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
trace_configurationobjectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
tagsarrayA list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual observability_configuration resou Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md index 405f4b5f55..1ae89c9287 100644 --- a/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md +++ b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of observability_configurations in a region or create a observability_configurations resource, use observability_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of observability_configurations in a region Nameobservability_configurations TypeResource DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration -Idaws.apprunner.observability_configurations +Id ## Fields - - + +
NameDatatypeDescription
observability_configuration_arnstringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of observability_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apprunner/service/index.md b/docs/aws-docs/providers/aws/apprunner/service/index.md index b2e0756fb4..d707d1914a 100644 --- a/docs/aws-docs/providers/aws/apprunner/service/index.md +++ b/docs/aws-docs/providers/aws/apprunner/service/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service resource, use services to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual service resource, use servi Nameservice TypeResource DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service. -Idaws.apprunner.service +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
service_namestringThe AppRunner Service Name.
service_idstringThe AppRunner Service Id
service_arnstringThe Amazon Resource Name (ARN) of the AppRunner Service.
service_urlstringThe Service Url of the AppRunner Service.
statusstringAppRunner Service status.
source_configurationobject
instance_configurationobject
tagsarray
encryption_configurationobject
health_check_configurationobject
observability_configurationobject
auto_scaling_configuration_arnstringAutoscaling configuration ARN
network_configurationobject
regionstringAWS region.
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.
object
object
array
object
object
object
stringAutoscaling configuration ARN
object
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual service resource, use servi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apprunner/services/index.md b/docs/aws-docs/providers/aws/apprunner/services/index.md index 63aeb0b80a..03ac25bfed 100644 --- a/docs/aws-docs/providers/aws/apprunner/services/index.md +++ b/docs/aws-docs/providers/aws/apprunner/services/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of services in a region or create a services resource, use service to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of services in a region or create a s Nameservices TypeResource DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service. -Idaws.apprunner.services +Id ## Fields - - + +
NameDatatypeDescription
service_arnstringThe Amazon Resource Name (ARN) of the AppRunner Service.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of services in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md index d6cfdb834a..a06b733378 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_connector resource, use vpc_connectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual vpc_connector resource, use Namevpc_connector TypeResource DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector. -Idaws.apprunner.vpc_connector +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
vpc_connector_namestringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
vpc_connector_arnstringThe Amazon Resource Name (ARN) of this VPC connector.
vpc_connector_revisionintegerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
subnetsarrayA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
security_groupsarrayA list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
tagsarrayA list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual vpc_connector resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md index fec5983e36..07faf28e13 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_connectors in a region or create a vpc_connectors resource, use vpc_connector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_connectors in a region or create a < Namevpc_connectors TypeResource DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector. -Idaws.apprunner.vpc_connectors +Id ## Fields - - + +
NameDatatypeDescription
vpc_connector_arnstringThe Amazon Resource Name (ARN) of this VPC connector.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of this VPC connector.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_connectors in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md index 8047239dac..ebfdd011ed 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_ingress_connection resource, use vpc_ingress_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual vpc_ingress_connection resource, Namevpc_ingress_connection TypeResource DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection. -Idaws.apprunner.vpc_ingress_connection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
vpc_ingress_connection_arnstringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
vpc_ingress_connection_namestringThe customer-provided Vpc Ingress Connection name.
service_arnstringThe Amazon Resource Name (ARN) of the service.
statusstringThe current status of the VpcIngressConnection.
domain_namestringThe Domain name associated with the VPC Ingress Connection.
ingress_vpc_configurationobject
tagsarray
regionstringAWS region.
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.
object
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual vpc_ingress_connection resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md index a0c6bd418f..3359c20b62 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_ingress_connections in a region or create a vpc_ingress_connections resource, use vpc_ingress_connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_ingress_connections in a region or c Namevpc_ingress_connections TypeResource DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection. -Idaws.apprunner.vpc_ingress_connections +Id ## Fields - - + +
NameDatatypeDescription
vpc_ingress_connection_arnstringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_ingress_connections in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/app_block/index.md b/docs/aws-docs/providers/aws/appstream/app_block/index.md index da4d0302db..f232bf556a 100644 --- a/docs/aws-docs/providers/aws/appstream/app_block/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_block/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app_block resource, use app_blocks to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual app_block resource, use app Nameapp_block TypeResource DescriptionResource Type definition for AWS::AppStream::AppBlock -Idaws.appstream.app_block +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
descriptionstring
display_namestring
source_s3_locationobject
setup_script_detailsobject
tagsarray
created_timestring
packaging_typestring
post_setup_script_detailsobject
regionstringAWS region.
string
string
string
string
object
object
array
string
string
object
stringAWS region.
@@ -50,14 +53,14 @@ Gets or operates on an individual app_block resource, use app Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md index 87bbf178c9..000e3433f6 100644 --- a/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app_block_builder resource, use app_block_builders to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual app_block_builder resource, use < Nameapp_block_builder TypeResource DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder. -Idaws.appstream.app_block_builder +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
descriptionstring
display_namestring
platformstring
access_endpointsarray
tagsarray
vpc_configobject
enable_default_internet_accessboolean
iam_role_arnstring
created_timestring
instance_typestring
app_block_arnsarray
regionstringAWS region.
string
string
string
string
string
array
array
object
boolean
string
string
string
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual app_block_builder resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md index fedc32a3d8..00f17b6f89 100644 --- a/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of app_block_builders in a region or create a app_block_builders resource, use app_block_builder to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of app_block_builders in a region or create Nameapp_block_builders TypeResource DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder. -Idaws.appstream.app_block_builders +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of app_block_builders in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/app_blocks/index.md b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md index 17564911c1..2e6f38535e 100644 --- a/docs/aws-docs/providers/aws/appstream/app_blocks/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of app_blocks in a region or create a app_blocks resource, use app_block to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of app_blocks in a region or create a Nameapp_blocks TypeResource DescriptionResource Type definition for AWS::AppStream::AppBlock -Idaws.appstream.app_blocks +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of app_blocks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/application/index.md b/docs/aws-docs/providers/aws/appstream/application/index.md index 0a90ffffb0..3bfdc878bf 100644 --- a/docs/aws-docs/providers/aws/appstream/application/index.md +++ b/docs/aws-docs/providers/aws/appstream/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource Type definition for AWS::AppStream::Application -Idaws.appstream.application +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
display_namestring
descriptionstring
launch_pathstring
launch_parametersstring
working_directorystring
instance_familiesarray
icon_s3_locationobject
arnstring
app_block_arnstring
platformsarray
tagsarray
attributes_to_deletearray
created_timestring
regionstringAWS region.
string
string
string
string
string
string
array
object
string
string
array
array
array
string
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md b/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md index e51741ca0d..5f9ea14cda 100644 --- a/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application_entitlement_association resource, use application_entitlement_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual application_entitlement_associationNameapplication_entitlement_association TypeResource DescriptionResource Type definition for AWS::AppStream::ApplicationEntitlementAssociation -Idaws.appstream.application_entitlement_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual application_entitlement_associationRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md index f8fd3eca4b..860586fbda 100644 --- a/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of application_entitlement_associations in a region or create a application_entitlement_associations resource, use application_entitlement_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of application_entitlement_associations in Nameapplication_entitlement_associations TypeResource DescriptionResource Type definition for AWS::AppStream::ApplicationEntitlementAssociation -Idaws.appstream.application_entitlement_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of application_entitlement_associations in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md b/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md index 195ef81c8e..d72566288c 100644 --- a/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application_fleet_association resource, use application_fleet_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual application_fleet_association res Nameapplication_fleet_association TypeResource DescriptionResource Type definition for AWS::AppStream::ApplicationFleetAssociation -Idaws.appstream.application_fleet_association +Id ## Fields - - - + + +
NameDatatypeDescription
fleet_namestring
application_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual application_fleet_association res Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md index 00b656734d..d01e537c0c 100644 --- a/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of application_fleet_associations in a region or create a application_fleet_associations resource, use application_fleet_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of application_fleet_associations in a regi Nameapplication_fleet_associations TypeResource DescriptionResource Type definition for AWS::AppStream::ApplicationFleetAssociation -Idaws.appstream.application_fleet_associations +Id ## Fields - - - + + +
NameDatatypeDescription
fleet_namestring
application_arnundefined
regionstringAWS region.
string
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of application_fleet_associations in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/applications/index.md b/docs/aws-docs/providers/aws/appstream/applications/index.md index 59677e40de..74f03c1ffd 100644 --- a/docs/aws-docs/providers/aws/appstream/applications/index.md +++ b/docs/aws-docs/providers/aws/appstream/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource Type definition for AWS::AppStream::Application -Idaws.appstream.applications +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/directory_config/index.md b/docs/aws-docs/providers/aws/appstream/directory_config/index.md index b59f53a258..53023a4b27 100644 --- a/docs/aws-docs/providers/aws/appstream/directory_config/index.md +++ b/docs/aws-docs/providers/aws/appstream/directory_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual directory_config resource, use directory_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual directory_config resource, use Namedirectory_config TypeResource DescriptionResource Type definition for AWS::AppStream::DirectoryConfig -Idaws.appstream.directory_config +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
organizational_unit_distinguished_namesarray
service_account_credentialsobject
directory_namestring
certificate_based_auth_propertiesobject
regionstringAWS region.
array
object
string
object
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual directory_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/directory_configs/index.md b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md index 1e1fddfd76..ccb57bf13a 100644 --- a/docs/aws-docs/providers/aws/appstream/directory_configs/index.md +++ b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of directory_configs in a region or create a directory_configs resource, use directory_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of directory_configs in a region or create Namedirectory_configs TypeResource DescriptionResource Type definition for AWS::AppStream::DirectoryConfig -Idaws.appstream.directory_configs +Id ## Fields - - + +
NameDatatypeDescription
directory_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of directory_configs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/entitlement/index.md b/docs/aws-docs/providers/aws/appstream/entitlement/index.md index 7c24e971bd..a199896a5c 100644 --- a/docs/aws-docs/providers/aws/appstream/entitlement/index.md +++ b/docs/aws-docs/providers/aws/appstream/entitlement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual entitlement resource, use entitlements to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual entitlement resource, use e Nameentitlement TypeResource DescriptionResource Type definition for AWS::AppStream::Entitlement -Idaws.appstream.entitlement +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestring
stack_namestring
descriptionstring
app_visibilitystring
attributesarray
created_timestring
last_modified_timestring
regionstringAWS region.
string
string
string
string
array
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual entitlement resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/entitlements/index.md b/docs/aws-docs/providers/aws/appstream/entitlements/index.md index d5fc56640c..96604ea7b9 100644 --- a/docs/aws-docs/providers/aws/appstream/entitlements/index.md +++ b/docs/aws-docs/providers/aws/appstream/entitlements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of entitlements in a region or create a entitlements resource, use entitlement to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of entitlements in a region or create a Nameentitlements TypeResource DescriptionResource Type definition for AWS::AppStream::Entitlement -Idaws.appstream.entitlements +Id ## Fields - - - + + +
NameDatatypeDescription
stack_namestring
namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of entitlements in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appstream/image_builder/index.md b/docs/aws-docs/providers/aws/appstream/image_builder/index.md index 26de20951e..2be0d9f02b 100644 --- a/docs/aws-docs/providers/aws/appstream/image_builder/index.md +++ b/docs/aws-docs/providers/aws/appstream/image_builder/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image_builder resource, use image_builders to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual image_builder resource, use Nameimage_builder TypeResource DescriptionResource Type definition for AWS::AppStream::ImageBuilder -Idaws.appstream.image_builder +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
vpc_configobject
enable_default_internet_accessboolean
domain_join_infoobject
appstream_agent_versionstring
namestring
image_namestring
display_namestring
iam_role_arnstring
instance_typestring
tagsarray
streaming_urlstring
image_arnstring
access_endpointsarray
regionstringAWS region.
string
object
boolean
object
string
string
string
string
string
string
array
string
string
array
stringAWS region.
@@ -54,14 +57,14 @@ Gets or operates on an individual image_builder resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appstream/image_builders/index.md b/docs/aws-docs/providers/aws/appstream/image_builders/index.md index 43ceb81363..479a0dade9 100644 --- a/docs/aws-docs/providers/aws/appstream/image_builders/index.md +++ b/docs/aws-docs/providers/aws/appstream/image_builders/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of image_builders in a region or create a image_builders resource, use image_builder to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of image_builders in a region or create a < Nameimage_builders TypeResource DescriptionResource Type definition for AWS::AppStream::ImageBuilder -Idaws.appstream.image_builders +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of image_builders in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appsync/domain_name/index.md b/docs/aws-docs/providers/aws/appsync/domain_name/index.md index d9b4c4a7b1..e041252ad5 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_name/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_name/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain_name resource, use domain_names to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual domain_name resource, use d Namedomain_name TypeResource DescriptionResource Type definition for AWS::AppSync::DomainName -Idaws.appsync.domain_name +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
domain_namestring
descriptionstring
certificate_arnstring
app_sync_domain_namestring
hosted_zone_idstring
regionstringAWS region.
string
string
string
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual domain_name resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md b/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md index c1e4985674..eb565e1eeb 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain_name_api_association resource, use domain_name_api_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual domain_name_api_association resou Namedomain_name_api_association TypeResource DescriptionResource Type definition for AWS::AppSync::DomainNameApiAssociation -Idaws.appsync.domain_name_api_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
domain_namestring
api_idstring
api_association_identifierstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual domain_name_api_association resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md index 97e575fe59..4e46e4348a 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domain_name_api_associations in a region or create a domain_name_api_associations resource, use domain_name_api_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domain_name_api_associations in a region Namedomain_name_api_associations TypeResource DescriptionResource Type definition for AWS::AppSync::DomainNameApiAssociation -Idaws.appsync.domain_name_api_associations +Id ## Fields - - + +
NameDatatypeDescription
api_association_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domain_name_api_associations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appsync/domain_names/index.md b/docs/aws-docs/providers/aws/appsync/domain_names/index.md index 8b68161f4f..9816e5a1e4 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_names/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_names/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domain_names in a region or create a domain_names resource, use domain_name to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domain_names in a region or create a Namedomain_names TypeResource DescriptionResource Type definition for AWS::AppSync::DomainName -Idaws.appsync.domain_names +Id ## Fields - - + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domain_names in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appsync/function_configuration/index.md b/docs/aws-docs/providers/aws/appsync/function_configuration/index.md index 4604c5bef0..dde53819fe 100644 --- a/docs/aws-docs/providers/aws/appsync/function_configuration/index.md +++ b/docs/aws-docs/providers/aws/appsync/function_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual function_configuration resource, use function_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual function_configuration resource, Namefunction_configuration TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appsync.function_configuration +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
function_idstringThe unique identifier for the function generated by the service
function_arnstringThe ARN for the function generated by the service
api_idstringThe AWS AppSync GraphQL API that you want to attach using this function.
codestringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
code_s3_locationstringThe Amazon S3 endpoint (where the code is located??).
data_source_namestringThe name of data source this function will attach.
descriptionstringThe function description.
function_versionstringThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
max_batch_sizeintegerThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
namestringThe name of the function.
request_mapping_templatestringThe Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
request_mapping_template_s3_locationstringDescribes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.
response_mapping_templatestringThe Function response mapping template.
response_mapping_template_s3_locationstringThe location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
runtimeobjectDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
sync_configobjectDescribes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
regionstringAWS region.
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual function_configuration resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appsync/function_configurations/index.md b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md index f13c5307b4..e82d2748a2 100644 --- a/docs/aws-docs/providers/aws/appsync/function_configurations/index.md +++ b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of function_configurations in a region or create a function_configurations resource, use function_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of function_configurations in a region or c Namefunction_configurations TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.appsync.function_configurations +Id ## Fields - - + +
NameDatatypeDescription
function_arnstringThe ARN for the function generated by the service
regionstringAWS region.
stringThe ARN for the function generated by the service
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of function_configurations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appsync/resolver/index.md b/docs/aws-docs/providers/aws/appsync/resolver/index.md index d505915494..941f9a0a27 100644 --- a/docs/aws-docs/providers/aws/appsync/resolver/index.md +++ b/docs/aws-docs/providers/aws/appsync/resolver/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver resource, use resolvers to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual resolver resource, use reso Nameresolver TypeResource DescriptionThe ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).<br/> When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.<br/> See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*. -Idaws.appsync.resolver +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
api_idstringThe APSYlong GraphQL API to which you want to attach this resolver.
caching_configobjectThe caching configuration for the resolver.
codestringThe ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.
code_s3_locationstringThe Amazon S3 endpoint.
data_source_namestringThe resolver data source name.
field_namestringThe GraphQL field on a type that invokes the resolver.
kindstringThe resolver type.<br/> + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.<br/> + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
max_batch_sizeintegerThe maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.
pipeline_configobjectFunctions linked with the pipeline resolver.
request_mapping_templatestringThe request mapping template.<br/> Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
request_mapping_template_s3_locationstringThe location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
resolver_arnstring
response_mapping_templatestringThe response mapping template.
response_mapping_template_s3_locationstringThe location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
runtimeobjectDescribes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
sync_configobjectThe ``SyncConfig`` for a resolver attached to a versioned data source.
type_namestringThe GraphQL type that invokes this resolver.
metrics_configstringEnables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.
regionstringAWS region.
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.<br/> + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.<br/> + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
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.<br/> 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.
@@ -58,19 +61,19 @@ Gets or operates on an individual resolver resource, use reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appsync/resolvers/index.md b/docs/aws-docs/providers/aws/appsync/resolvers/index.md index 5fb38fe69c..d1d0dbc2d1 100644 --- a/docs/aws-docs/providers/aws/appsync/resolvers/index.md +++ b/docs/aws-docs/providers/aws/appsync/resolvers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolvers in a region or create a resolvers resource, use resolver to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolvers in a region or create a Nameresolvers TypeResource DescriptionThe ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).<br/> When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.<br/> See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*. -Idaws.appsync.resolvers +Id ## Fields - - + +
NameDatatypeDescription
resolver_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolvers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/appsync/source_api_association/index.md b/docs/aws-docs/providers/aws/appsync/source_api_association/index.md index 88de8be89d..ae50314d68 100644 --- a/docs/aws-docs/providers/aws/appsync/source_api_association/index.md +++ b/docs/aws-docs/providers/aws/appsync/source_api_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual source_api_association resource, use source_api_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual source_api_association resource, Namesource_api_association TypeResource DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation -Idaws.appsync.source_api_association +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
source_api_identifierstringIdentifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
merged_api_identifierstringIdentifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
descriptionstringDescription of the SourceApiAssociation.
source_api_association_configundefinedCustomized configuration for SourceApiAssociation.
association_idstringId of the SourceApiAssociation.
association_arnstringARN of the SourceApiAssociation.
source_api_idstringGraphQLApiId of the source API in the association.
source_api_arnstringARN of the source API in the association.
merged_api_idstringGraphQLApiId of the Merged API in the association.
merged_api_arnstringARN of the Merged API in the association.
source_api_association_statusstringCurrent status of SourceApiAssociation.
source_api_association_status_detailstringCurrent SourceApiAssociation status details.
last_successful_merge_datestringDate of last schema successful merge.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual source_api_association resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md index c1097ce03c..73499f637d 100644 --- a/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md +++ b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of source_api_associations in a region or create a source_api_associations resource, use source_api_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of source_api_associations in a region or c Namesource_api_associations TypeResource DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation -Idaws.appsync.source_api_associations +Id ## Fields - - + +
NameDatatypeDescription
association_arnstringARN of the SourceApiAssociation.
regionstringAWS region.
stringARN of the SourceApiAssociation.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of source_api_associations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md index 590f03769d..0ad50e7fb4 100644 --- a/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule_groups_namespace resource, use rule_groups_namespaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual rule_groups_namespace resource, u Namerule_groups_namespace TypeResource DescriptionRuleGroupsNamespace schema for cloudformation. -Idaws.aps.rule_groups_namespace +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
workspacestringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
namestringThe RuleGroupsNamespace name.
datastringThe RuleGroupsNamespace data.
arnstringThe RuleGroupsNamespace ARN.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual rule_groups_namespace resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md index 4d58d8f0b2..baa3ab57da 100644 --- a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rule_groups_namespaces in a region or create a rule_groups_namespaces resource, use rule_groups_namespace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rule_groups_namespaces in a region or cr Namerule_groups_namespaces TypeResource DescriptionRuleGroupsNamespace schema for cloudformation. -Idaws.aps.rule_groups_namespaces +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe RuleGroupsNamespace ARN.
regionstringAWS region.
stringThe RuleGroupsNamespace ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rule_groups_namespaces in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/aps/scraper/index.md b/docs/aws-docs/providers/aws/aps/scraper/index.md index a2d374b080..e5e4000d48 100644 --- a/docs/aws-docs/providers/aws/aps/scraper/index.md +++ b/docs/aws-docs/providers/aws/aps/scraper/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scraper resource, use scrapers to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual scraper resource, use scrap Namescraper TypeResource DescriptionResource Type definition for AWS::APS::Scraper -Idaws.aps.scraper +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
scraper_idstringRequired to identify a specific scraper.
aliasstringScraper alias.
arnstringScraper ARN.
role_arnstringIAM role ARN for the scraper.
scrape_configurationobject
sourceobject
destinationobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringRequired to identify a specific scraper.
stringScraper alias.
stringScraper ARN.
stringIAM role ARN for the scraper.
object
object
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual scraper resource, use scrap Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/aps/scrapers/index.md b/docs/aws-docs/providers/aws/aps/scrapers/index.md index 5f4ce14ab1..46ffa04260 100644 --- a/docs/aws-docs/providers/aws/aps/scrapers/index.md +++ b/docs/aws-docs/providers/aws/aps/scrapers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scrapers in a region or create a scrapers resource, use scraper to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scrapers in a region or create a s Namescrapers TypeResource DescriptionResource Type definition for AWS::APS::Scraper -Idaws.aps.scrapers +Id ## Fields - - + +
NameDatatypeDescription
arnstringScraper ARN.
regionstringAWS region.
stringScraper ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scrapers in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/aps/workspace/index.md b/docs/aws-docs/providers/aws/aps/workspace/index.md index b235939deb..ae9e154245 100644 --- a/docs/aws-docs/providers/aws/aps/workspace/index.md +++ b/docs/aws-docs/providers/aws/aps/workspace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workspace resource, use workspaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual workspace resource, use wor Nameworkspace TypeResource DescriptionResource Type definition for AWS::APS::Workspace -Idaws.aps.workspace +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
workspace_idstringRequired to identify a specific APS Workspace.
aliasstringAMP Workspace alias.
arnstringWorkspace arn.
alert_manager_definitionstringThe AMP Workspace alert manager definition data
prometheus_endpointstringAMP Workspace prometheus endpoint
logging_configurationobject
kms_key_arnstringKMS Key ARN used to encrypt and decrypt AMP workspace data.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringRequired to identify a specific APS Workspace.
stringAMP Workspace alias.
stringWorkspace arn.
stringThe AMP Workspace alert manager definition data
stringAMP Workspace prometheus endpoint
object
stringKMS Key ARN used to encrypt and decrypt AMP workspace data.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual workspace resource, use wor Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/aps/workspaces/index.md b/docs/aws-docs/providers/aws/aps/workspaces/index.md index 777e83de73..fd3175d814 100644 --- a/docs/aws-docs/providers/aws/aps/workspaces/index.md +++ b/docs/aws-docs/providers/aws/aps/workspaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workspaces in a region or create a workspaces resource, use workspace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workspaces in a region or create a Nameworkspaces TypeResource DescriptionResource Type definition for AWS::APS::Workspace -Idaws.aps.workspaces +Id ## Fields - - + +
NameDatatypeDescription
arnstringWorkspace arn.
regionstringAWS region.
stringWorkspace arn.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workspaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md index 497b454c89..3aeb113e48 100644 --- a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual zonal_autoshift_configuration resource, use zonal_autoshift_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual zonal_autoshift_configuration res Namezonal_autoshift_configuration TypeResource DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type -Idaws.arczonalshift.zonal_autoshift_configuration +Id ## Fields - - - - + + + +
NameDatatypeDescription
zonal_autoshift_statusstring
practice_run_configurationobject
resource_identifierstring
regionstringAWS region.
string
object
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual zonal_autoshift_configuration res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md index 14a36fe567..e258ce5861 100644 --- a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of zonal_autoshift_configurations in a region or create a zonal_autoshift_configurations resource, use zonal_autoshift_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of zonal_autoshift_configurations in a regi Namezonal_autoshift_configurations TypeResource DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type -Idaws.arczonalshift.zonal_autoshift_configurations +Id ## Fields - - + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of zonal_autoshift_configurations in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md index bd50a4be9e..40d138663a 100644 --- a/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md +++ b/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual capacity_reservation resource, use capacity_reservations to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual capacity_reservation resource, us Namecapacity_reservation TypeResource DescriptionResource schema for AWS::Athena::CapacityReservation -Idaws.athena.capacity_reservation +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe reservation name.
statusstringThe status of the reservation.
target_dpusintegerThe number of DPUs to request to be allocated to the reservation.
allocated_dpusintegerThe number of DPUs Athena has provisioned and allocated for the reservation
capacity_assignment_configurationobject
creation_timestringThe date and time the reservation was created.
last_successful_allocation_timestringThe timestamp when the last successful allocated was made
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
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
object
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual capacity_reservation resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md index de4674880d..618c3332de 100644 --- a/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md +++ b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of capacity_reservations in a region or create a capacity_reservations resource, use capacity_reservation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of capacity_reservations in a region or cre Namecapacity_reservations TypeResource DescriptionResource schema for AWS::Athena::CapacityReservation -Idaws.athena.capacity_reservations +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of capacity_reservations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/athena/data_catalog/index.md b/docs/aws-docs/providers/aws/athena/data_catalog/index.md index 7615a54049..f3edf94348 100644 --- a/docs/aws-docs/providers/aws/athena/data_catalog/index.md +++ b/docs/aws-docs/providers/aws/athena/data_catalog/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_catalog resource, use data_catalogs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual data_catalog resource, use Namedata_catalog TypeResource DescriptionResource schema for AWS::Athena::DataCatalog -Idaws.athena.data_catalog +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
descriptionstringA description of the data catalog to be created.
parametersobjectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
tagsarrayA list of comma separated tags to add to the data catalog that is created.
typestringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual data_catalog resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/athena/data_catalogs/index.md b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md index 502ffb612a..79bdc0d2b3 100644 --- a/docs/aws-docs/providers/aws/athena/data_catalogs/index.md +++ b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_catalogs in a region or create a data_catalogs resource, use data_catalog to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_catalogs in a region or create a Namedata_catalogs TypeResource DescriptionResource schema for AWS::Athena::DataCatalog -Idaws.athena.data_catalogs +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_catalogs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/athena/named_queries/index.md b/docs/aws-docs/providers/aws/athena/named_queries/index.md index 292cb3a834..cd73212688 100644 --- a/docs/aws-docs/providers/aws/athena/named_queries/index.md +++ b/docs/aws-docs/providers/aws/athena/named_queries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of named_queries in a region or create a named_queries resource, use named_query to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of named_queries in a region or create a Namenamed_queries TypeResource DescriptionResource schema for AWS::Athena::NamedQuery -Idaws.athena.named_queries +Id ## Fields - - + +
NameDatatypeDescription
named_query_idstringThe unique ID of the query.
regionstringAWS region.
stringThe unique ID of the query.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of named_queries in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/athena/named_query/index.md b/docs/aws-docs/providers/aws/athena/named_query/index.md index f39b4238c4..9ee299c9b2 100644 --- a/docs/aws-docs/providers/aws/athena/named_query/index.md +++ b/docs/aws-docs/providers/aws/athena/named_query/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual named_query resource, use named_queries to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual named_query resource, use n Namenamed_query TypeResource DescriptionResource schema for AWS::Athena::NamedQuery -Idaws.athena.named_query +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe query name.
databasestringThe database to which the query belongs.
descriptionstringThe query description.
query_stringstringThe contents of the query with all query statements.
work_groupstringThe name of the workgroup that contains the named query.
named_query_idstringThe unique ID of the query.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual named_query resource, use n Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/athena/prepared_statement/index.md b/docs/aws-docs/providers/aws/athena/prepared_statement/index.md index 82cdcd1ad5..46d4430c37 100644 --- a/docs/aws-docs/providers/aws/athena/prepared_statement/index.md +++ b/docs/aws-docs/providers/aws/athena/prepared_statement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual prepared_statement resource, use prepared_statements to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual prepared_statement resource, use Nameprepared_statement TypeResource DescriptionResource schema for AWS::Athena::PreparedStatement -Idaws.athena.prepared_statement +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
statement_namestringThe name of the prepared statement.
work_groupstringThe name of the workgroup to which the prepared statement belongs.
descriptionstringThe description of the prepared statement.
query_statementstringThe query string for the prepared statement.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual prepared_statement resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/athena/prepared_statements/index.md b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md index 029d7b8ef3..5243eb707c 100644 --- a/docs/aws-docs/providers/aws/athena/prepared_statements/index.md +++ b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of prepared_statements in a region or create a prepared_statements resource, use prepared_statement to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of prepared_statements in a region or creat Nameprepared_statements TypeResource DescriptionResource schema for AWS::Athena::PreparedStatement -Idaws.athena.prepared_statements +Id ## Fields - - - + + +
NameDatatypeDescription
statement_namestringThe name of the prepared statement.
work_groupstringThe name of the workgroup to which the prepared statement belongs.
regionstringAWS region.
stringThe name of the prepared statement.
stringThe name of the workgroup to which the prepared statement belongs.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of prepared_statements in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/athena/work_group/index.md b/docs/aws-docs/providers/aws/athena/work_group/index.md index e3b9ff1bc5..39b08c4b50 100644 --- a/docs/aws-docs/providers/aws/athena/work_group/index.md +++ b/docs/aws-docs/providers/aws/athena/work_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual work_group resource, use work_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual work_group resource, use wo Namework_group TypeResource DescriptionResource schema for AWS::Athena::WorkGroup -Idaws.athena.work_group +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe workGroup name.
descriptionstringThe workgroup description.
tagsarrayOne or more tags, separated by commas, that you want to attach to the workgroup as you create it
work_group_configurationobjectThe workgroup configuration
work_group_configuration_updatesobjectThe workgroup configuration update object
creation_timestringThe date and time the workgroup was created.
statestringThe state of the workgroup: ENABLED or DISABLED.
recursive_delete_optionbooleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual work_group resource, use wo Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/athena/work_groups/index.md b/docs/aws-docs/providers/aws/athena/work_groups/index.md index e6f752d4f9..c5769b1595 100644 --- a/docs/aws-docs/providers/aws/athena/work_groups/index.md +++ b/docs/aws-docs/providers/aws/athena/work_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of work_groups in a region or create a work_groups resource, use work_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of work_groups in a region or create a Namework_groups TypeResource DescriptionResource schema for AWS::Athena::WorkGroup -Idaws.athena.work_groups +Id ## Fields - - + +
NameDatatypeDescription
namestringThe workGroup name.
regionstringAWS region.
stringThe workGroup name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of work_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessment/index.md b/docs/aws-docs/providers/aws/auditmanager/assessment/index.md index 3be6a50b8b..bd89a9946e 100644 --- a/docs/aws-docs/providers/aws/auditmanager/assessment/index.md +++ b/docs/aws-docs/providers/aws/auditmanager/assessment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assessment resource, use assessments to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual assessment resource, use as Nameassessment TypeResource DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager. -Idaws.auditmanager.assessment +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
framework_idstring
assessment_idstring
aws_accountobject
arnstring
tagsarrayThe tags associated with the assessment.
delegationsarrayThe list of delegations.
rolesarrayThe list of roles for the specified assessment.
scopeobject
assessment_reports_destinationobject
statusstring
creation_timenumber
namestring
descriptionstring
regionstringAWS region.
string
string
object
string
arrayThe tags associated with the assessment.
arrayThe list of delegations.
arrayThe list of roles for the specified assessment.
object
object
string
number
string
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual assessment resource, use as Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessments/index.md b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md index c5d31a3b02..6b0ed3f610 100644 --- a/docs/aws-docs/providers/aws/auditmanager/assessments/index.md +++ b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assessments in a region or create a assessments resource, use assessment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assessments in a region or create a Nameassessments TypeResource DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager. -Idaws.auditmanager.assessments +Id ## Fields - - + +
NameDatatypeDescription
assessment_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assessments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md index dc4987148f..b4b2258e28 100644 --- a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual auto_scaling_group resource, use auto_scaling_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,43 +24,43 @@ Gets or operates on an individual auto_scaling_group resource, use Nameauto_scaling_group TypeResource DescriptionThe ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. <br/> For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). <br/> Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*. -Idaws.autoscaling.auto_scaling_group +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
lifecycle_hook_specification_listarrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
load_balancer_namesarrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.
launch_configuration_namestringThe name of the launch configuration to use to launch instances.<br/> Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.
service_linked_role_arnstringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
target_group_arnsarrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
cooldownstring*Only needed if you use simple scaling policies.* <br/> The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Default: ``300`` seconds
notification_configurationsarrayConfigures an Auto Scaling group to send notifications when specified events take place.
desired_capacitystringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.<br/> The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.<br/> CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
health_check_grace_periodintegerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Default: ``0`` seconds
default_instance_warmupintegerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. <br/> During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.<br/> Default: None
new_instances_protected_from_scale_inbooleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
launch_templateobjectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``.
mixed_instances_policyobjectAn embedded object that specifies a mixed instances policy.<br/> The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.<br/> For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
vpc_zone_identifierarrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.<br/> If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).<br/> When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).<br/> Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.
tagsarrayOne or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
contextstringReserved.
capacity_rebalancebooleanIndicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
instance_idstringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.
availability_zonesarrayA list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
notification_configurationobject
metrics_collectionarrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
instance_maintenance_policyobjectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
max_sizestringThe maximum size of the group.<br/> With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
min_sizestringThe minimum size of the group.
termination_policiesarrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``
auto_scaling_group_namestringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
desired_capacity_typestringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.<br/> Valid values: ``units`` | ``vcpu`` | ``memory-mib``
placement_groupstringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.<br/> A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
health_check_typestringA comma-separated value string of one or more health check types.<br/> The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Only specify ``EC2`` if you must clear a value that was previously set.
max_instance_lifetimeintegerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
regionstringAWS region.
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.<br/> Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.
stringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
string*Only needed if you use simple scaling policies.* <br/> The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Default: ``300`` seconds
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.<br/> The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.<br/> CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
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*.<br/> 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. <br/> During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.<br/> Default: None
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 [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
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*.<br/> If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``.
objectAn embedded object that specifies a mixed instances policy.<br/> The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.<br/> For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.<br/> If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).<br/> When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).<br/> Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.
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*.<br/> 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.
object
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.<br/> With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
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 [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``
stringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
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 [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.<br/> Valid values: ``units`` | ``vcpu`` | ``memory-mib``
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*.<br/> A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
stringA comma-separated value string of one or more health check types.<br/> The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Only specify ``EC2`` if you must clear a value that was previously set.
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 [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringAWS region.
@@ -70,19 +73,19 @@ Gets or operates on an individual auto_scaling_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md index 589b43f67d..f22a5ee26f 100644 --- a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of auto_scaling_groups in a region or create a auto_scaling_groups resource, use auto_scaling_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of auto_scaling_groups in a region or creat Nameauto_scaling_groups TypeResource DescriptionThe ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. <br/> For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). <br/> Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*. -Idaws.autoscaling.auto_scaling_groups +Id ## Fields - - + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
regionstringAWS region.
stringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of auto_scaling_groups in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md index 84cd890e23..5b424953d6 100644 --- a/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual launch_configuration resource, use launch_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual launch_configuration resource, us Namelaunch_configuration TypeResource DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances. -Idaws.autoscaling.launch_configuration +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
associate_public_ip_addressbooleanFor Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.
block_device_mappingsarraySpecifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
classic_link_vpc_idstringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
classic_link_vpc_security_groupsarrayThe IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
ebs_optimizedbooleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).
iam_instance_profilestringProvides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
image_idstringProvides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
instance_idstringThe ID of the Amazon EC2 instance you want to use to create the launch configuration.
instance_monitoringbooleanControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
instance_typestringSpecifies the instance type of the EC2 instance.
kernel_idstringProvides the ID of the kernel associated with the EC2 AMI.
key_namestringProvides the name of the EC2 key pair.
launch_configuration_namestringThe name of the launch configuration. This name must be unique per Region per account.
metadata_optionsobjectThe metadata options for the instances.
placement_tenancystringThe tenancy of the instance, either default or dedicated.
ram_disk_idstringThe ID of the RAM disk to select.
security_groupsarrayA list that contains the security groups to assign to the instances in the Auto Scaling group.
spot_pricestringThe maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
user_datastringThe Base64-encoded user data to make available to the launched EC2 instances.
regionstringAWS region.
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.
arraySpecifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
stringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
arrayThe IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
booleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).
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 unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
stringThe ID of the Amazon EC2 instance you want to use to create the launch configuration.
booleanControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
stringSpecifies the instance type of the EC2 instance.
stringProvides the ID of the kernel associated with the EC2 AMI.
stringProvides the name of the EC2 key pair.
stringThe name of the launch configuration. This name must be unique per Region per account.
objectThe metadata options for the instances.
stringThe tenancy of the instance, either default or dedicated.
stringThe ID of the RAM disk to select.
arrayA list that contains the security groups to assign to the instances in the Auto Scaling group.
stringThe maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
stringThe Base64-encoded user data to make available to the launched EC2 instances.
stringAWS region.
@@ -59,14 +62,14 @@ Gets or operates on an individual launch_configuration resource, us Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md index e9d2915934..80344cbe37 100644 --- a/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of launch_configurations in a region or create a launch_configurations resource, use launch_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of launch_configurations in a region or cre Namelaunch_configurations TypeResource DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances. -Idaws.autoscaling.launch_configurations +Id ## Fields - - + +
NameDatatypeDescription
launch_configuration_namestringThe name of the launch configuration. This name must be unique per Region per account.
regionstringAWS region.
stringThe name of the launch configuration. This name must be unique per Region per account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of launch_configurations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md index 10cdedf552..655f033abe 100644 --- a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual lifecycle_hook resource, use lifecycle_hooks to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual lifecycle_hook resource, use Namelifecycle_hook TypeResource DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook -Idaws.autoscaling.lifecycle_hook +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group for the lifecycle hook.
default_resultstringThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).
heartbeat_timeoutintegerThe maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.
lifecycle_hook_namestringThe name of the lifecycle hook.
lifecycle_transitionstringThe instance state to which you want to attach the lifecycle hook.
notification_metadatastringAdditional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
notification_target_arnstringThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.
role_arnstringThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual lifecycle_hook resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md index aab3ca51e9..c685a1a6e6 100644 --- a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of lifecycle_hooks in a region or create a lifecycle_hooks resource, use lifecycle_hook to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of lifecycle_hooks in a region or create a Namelifecycle_hooks TypeResource DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook -Idaws.autoscaling.lifecycle_hooks +Id ## Fields - - - + + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group for the lifecycle hook.
lifecycle_hook_namestringThe name of the lifecycle hook.
regionstringAWS region.
stringThe name of the Auto Scaling group for the lifecycle hook.
stringThe name of the lifecycle hook.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of lifecycle_hooks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md index 17182285fd..8ac509967b 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scaling_policies in a region or create a scaling_policies resource, use scaling_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scaling_policies in a region or create a Namescaling_policies TypeResource DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application. -Idaws.autoscaling.scaling_policies +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the AutoScaling scaling policy
regionstringAWS region.
stringThe ARN of the AutoScaling scaling policy
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scaling_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md index 369312a4c8..e47b12f43a 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scaling_policy resource, use scaling_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual scaling_policy resource, use Namescaling_policy TypeResource DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application. -Idaws.autoscaling.scaling_policy +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
metric_aggregation_typestringThe aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
policy_namestring
policy_typestringOne of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
predictive_scaling_configurationobjectA predictive scaling policy. Includes support for predefined metrics only.
scaling_adjustmentintegerThe amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
cooldownstringThe duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
step_adjustmentsarrayA set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
auto_scaling_group_namestringThe name of the Auto Scaling group.
min_adjustment_magnitudeintegerThe minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
target_tracking_configurationobjectA target tracking scaling policy. Includes support for predefined or customized metrics.
estimated_instance_warmupintegerThe estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
adjustment_typestringSpecifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
arnstringThe ARN of the AutoScaling scaling policy
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual scaling_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md index 25231929af..3e30eb420b 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scheduled_action resource, use scheduled_actions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual scheduled_action resource, use Namescheduled_action TypeResource DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes. -Idaws.autoscaling.scheduled_action +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
scheduled_action_namestringAuto-generated unique identifier
min_sizeintegerThe minimum size of the Auto Scaling group.
recurrencestringThe recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
time_zonestringThe time zone for the cron expression.
end_timestringThe latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
auto_scaling_group_namestringThe name of the Auto Scaling group.
start_timestringThe earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
desired_capacityintegerThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
max_sizeintegerThe minimum size of the Auto Scaling group.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual scheduled_action resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md index 69e768e198..e7469394a4 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scheduled_actions in a region or create a scheduled_actions resource, use scheduled_action to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of scheduled_actions in a region or create Namescheduled_actions TypeResource DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes. -Idaws.autoscaling.scheduled_actions +Id ## Fields - - - + + +
NameDatatypeDescription
scheduled_action_namestringAuto-generated unique identifier
auto_scaling_group_namestringThe name of the Auto Scaling group.
regionstringAWS region.
stringAuto-generated unique identifier
stringThe name of the Auto Scaling group.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of scheduled_actions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md b/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md index 0736f4ace9..ccb617767c 100644 --- a/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual warm_pool resource, use warm_pools to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual warm_pool resource, use war Namewarm_pool TypeResource DescriptionResource schema for AWS::AutoScaling::WarmPool. -Idaws.autoscaling.warm_pool +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
max_group_prepared_capacityinteger
min_sizeinteger
pool_statestring
instance_reuse_policyobject
regionstringAWS region.
string
integer
integer
string
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual warm_pool resource, use war Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md index ec4951643c..43892ab99e 100644 --- a/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of warm_pools in a region or create a warm_pools resource, use warm_pool to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of warm_pools in a region or create a Namewarm_pools TypeResource DescriptionResource schema for AWS::AutoScaling::WarmPool. -Idaws.autoscaling.warm_pools +Id ## Fields - - + +
NameDatatypeDescription
auto_scaling_group_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of warm_pools in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/b2bi/capabilities/index.md b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md index dde146be3f..1b91fdd9e7 100644 --- a/docs/aws-docs/providers/aws/b2bi/capabilities/index.md +++ b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of capabilities in a region or create a capabilities resource, use capability to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of capabilities in a region or create a Namecapabilities TypeResource DescriptionDefinition of AWS::B2BI::Capability Resource Type -Idaws.b2bi.capabilities +Id ## Fields - - + +
NameDatatypeDescription
capability_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of capabilities in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/b2bi/capability/index.md b/docs/aws-docs/providers/aws/b2bi/capability/index.md index cf9fd5e962..7c1ce60836 100644 --- a/docs/aws-docs/providers/aws/b2bi/capability/index.md +++ b/docs/aws-docs/providers/aws/b2bi/capability/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual capability resource, use capabilities to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual capability resource, use ca Namecapability TypeResource DescriptionDefinition of AWS::B2BI::Capability Resource Type -Idaws.b2bi.capability +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
capability_arnstring
capability_idstring
configurationundefined
created_atstring
instructions_documentsarray
modified_atstring
namestring
tagsarray
typestring
regionstringAWS region.
string
string
undefined
string
array
string
string
array
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual capability resource, use ca Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/b2bi/partnership/index.md b/docs/aws-docs/providers/aws/b2bi/partnership/index.md index f1fcfcc448..3279eb37f9 100644 --- a/docs/aws-docs/providers/aws/b2bi/partnership/index.md +++ b/docs/aws-docs/providers/aws/b2bi/partnership/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual partnership resource, use partnerships to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual partnership resource, use p Namepartnership TypeResource DescriptionDefinition of AWS::B2BI::Partnership Resource Type -Idaws.b2bi.partnership +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesarray
created_atstring
emailstring
modified_atstring
namestring
partnership_arnstring
partnership_idstring
phonestring
profile_idstring
tagsarray
trading_partner_idstring
regionstringAWS region.
array
string
string
string
string
string
string
string
string
array
string
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual partnership resource, use p Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/b2bi/partnerships/index.md b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md index 73e8a4153d..b815da1acc 100644 --- a/docs/aws-docs/providers/aws/b2bi/partnerships/index.md +++ b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of partnerships in a region or create a partnerships resource, use partnership to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of partnerships in a region or create a Namepartnerships TypeResource DescriptionDefinition of AWS::B2BI::Partnership Resource Type -Idaws.b2bi.partnerships +Id ## Fields - - + +
NameDatatypeDescription
partnership_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of partnerships in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/b2bi/profile/index.md b/docs/aws-docs/providers/aws/b2bi/profile/index.md index e24b302c3f..5782706231 100644 --- a/docs/aws-docs/providers/aws/b2bi/profile/index.md +++ b/docs/aws-docs/providers/aws/b2bi/profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual profile resource, use profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual profile resource, use profi Nameprofile TypeResource DescriptionDefinition of AWS::B2BI::Profile Resource Type -Idaws.b2bi.profile +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
business_namestring
created_atstring
emailstring
log_group_namestring
loggingstring
modified_atstring
namestring
phonestring
profile_arnstring
profile_idstring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual profile resource, use profi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/b2bi/profiles/index.md b/docs/aws-docs/providers/aws/b2bi/profiles/index.md index 0c06056961..4d5c76ae98 100644 --- a/docs/aws-docs/providers/aws/b2bi/profiles/index.md +++ b/docs/aws-docs/providers/aws/b2bi/profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of profiles in a region or create a profiles resource, use profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of profiles in a region or create a p Nameprofiles TypeResource DescriptionDefinition of AWS::B2BI::Profile Resource Type -Idaws.b2bi.profiles +Id ## Fields - - + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of profiles in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/b2bi/transformer/index.md b/docs/aws-docs/providers/aws/b2bi/transformer/index.md index 1721541a27..a8c80e3fc3 100644 --- a/docs/aws-docs/providers/aws/b2bi/transformer/index.md +++ b/docs/aws-docs/providers/aws/b2bi/transformer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transformer resource, use transformers to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual transformer resource, use t Nametransformer TypeResource DescriptionDefinition of AWS::B2BI::Transformer Resource Type -Idaws.b2bi.transformer +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
created_atstring
edi_typeundefined
file_formatstring
mapping_templatestring
modified_atstring
namestring
sample_documentstring
statusstring
tagsarray
transformer_arnstring
transformer_idstring
regionstringAWS region.
string
undefined
string
string
string
string
string
string
array
string
string
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual transformer resource, use t Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/b2bi/transformers/index.md b/docs/aws-docs/providers/aws/b2bi/transformers/index.md index 168a3d5045..8434c7be18 100644 --- a/docs/aws-docs/providers/aws/b2bi/transformers/index.md +++ b/docs/aws-docs/providers/aws/b2bi/transformers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transformers in a region or create a transformers resource, use transformer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transformers in a region or create a Nametransformers TypeResource DescriptionDefinition of AWS::B2BI::Transformer Resource Type -Idaws.b2bi.transformers +Id ## Fields - - + +
NameDatatypeDescription
transformer_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transformers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/backup_plan/index.md b/docs/aws-docs/providers/aws/backup/backup_plan/index.md index 0f7deec7e8..35a868bb4b 100644 --- a/docs/aws-docs/providers/aws/backup/backup_plan/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual backup_plan resource, use backup_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual backup_plan resource, use b Namebackup_plan TypeResource DescriptionResource Type definition for AWS::Backup::BackupPlan -Idaws.backup.backup_plan +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
backup_planobject
backup_plan_tagsobject
backup_plan_arnstring
backup_plan_idstring
version_idstring
regionstringAWS region.
object
object
string
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual backup_plan resource, use b Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/backup_plans/index.md b/docs/aws-docs/providers/aws/backup/backup_plans/index.md index 6befc55c05..8d66ef6f2f 100644 --- a/docs/aws-docs/providers/aws/backup/backup_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of backup_plans in a region or create a backup_plans resource, use backup_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of backup_plans in a region or create a Namebackup_plans TypeResource DescriptionResource Type definition for AWS::Backup::BackupPlan -Idaws.backup.backup_plans +Id ## Fields - - + +
NameDatatypeDescription
backup_plan_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of backup_plans in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/backup_selection/index.md b/docs/aws-docs/providers/aws/backup/backup_selection/index.md index 4e86ddbe9f..f51a600f25 100644 --- a/docs/aws-docs/providers/aws/backup/backup_selection/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_selection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual backup_selection resource, use backup_selections to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual backup_selection resource, use Namebackup_selection TypeResource DescriptionResource Type definition for AWS::Backup::BackupSelection -Idaws.backup.backup_selection +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstring
backup_plan_idstring
backup_selectionobject
selection_idstring
regionstringAWS region.
string
string
object
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual backup_selection resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/backup_selections/index.md b/docs/aws-docs/providers/aws/backup/backup_selections/index.md index 3834417388..be8edf4b95 100644 --- a/docs/aws-docs/providers/aws/backup/backup_selections/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_selections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of backup_selections in a region or create a backup_selections resource, use backup_selection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of backup_selections in a region or create Namebackup_selections TypeResource DescriptionResource Type definition for AWS::Backup::BackupSelection -Idaws.backup.backup_selections +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of backup_selections in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/backup_vault/index.md b/docs/aws-docs/providers/aws/backup/backup_vault/index.md index abb0332315..6fd317dbd8 100644 --- a/docs/aws-docs/providers/aws/backup/backup_vault/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_vault/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual backup_vault resource, use backup_vaults to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual backup_vault resource, use Namebackup_vault TypeResource DescriptionResource Type definition for AWS::Backup::BackupVault -Idaws.backup.backup_vault +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
access_policyobject
backup_vault_namestring
backup_vault_tagsobject
encryption_key_arnstring
notificationsobject
lock_configurationobject
backup_vault_arnstring
regionstringAWS region.
object
string
object
string
object
object
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual backup_vault resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/backup_vaults/index.md b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md index de91e57400..42bb0551db 100644 --- a/docs/aws-docs/providers/aws/backup/backup_vaults/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of backup_vaults in a region or create a backup_vaults resource, use backup_vault to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of backup_vaults in a region or create a Namebackup_vaults TypeResource DescriptionResource Type definition for AWS::Backup::BackupVault -Idaws.backup.backup_vaults +Id ## Fields - - + +
NameDatatypeDescription
backup_vault_nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of backup_vaults in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/framework/index.md b/docs/aws-docs/providers/aws/backup/framework/index.md index f05f6901f0..65616c749c 100644 --- a/docs/aws-docs/providers/aws/backup/framework/index.md +++ b/docs/aws-docs/providers/aws/backup/framework/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual framework resource, use frameworks to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual framework resource, use fra Nameframework TypeResource DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results. -Idaws.backup.framework +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
framework_namestringThe unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
framework_descriptionstringAn optional description of the framework with a maximum 1,024 characters.
framework_arnstringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
deployment_statusstringThe deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
creation_timestringThe date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
framework_controlsarrayContains detailed information about all of the controls of a framework. Each framework must contain at least one control.
framework_statusstringA framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:<br/><br/>`ACTIVE` when recording is turned on for all resources governed by the framework.<br/><br/>`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.<br/><br/>`INACTIVE` when recording is turned off for all resources governed by the framework.<br/><br/>`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
framework_tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
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:<br/><br/>`ACTIVE` when recording is turned on for all resources governed by the framework.<br/><br/>`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.<br/><br/>`INACTIVE` when recording is turned off for all resources governed by the framework.<br/><br/>`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual framework resource, use fra Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/frameworks/index.md b/docs/aws-docs/providers/aws/backup/frameworks/index.md index 32b19da5cf..6329ec5a5b 100644 --- a/docs/aws-docs/providers/aws/backup/frameworks/index.md +++ b/docs/aws-docs/providers/aws/backup/frameworks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of frameworks in a region or create a frameworks resource, use framework to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of frameworks in a region or create a Nameframeworks TypeResource DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results. -Idaws.backup.frameworks +Id ## Fields - - + +
NameDatatypeDescription
framework_arnstringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
regionstringAWS region.
stringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of frameworks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/report_plan/index.md b/docs/aws-docs/providers/aws/backup/report_plan/index.md index 6d6a833aa7..d2f2cb5afb 100644 --- a/docs/aws-docs/providers/aws/backup/report_plan/index.md +++ b/docs/aws-docs/providers/aws/backup/report_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual report_plan resource, use report_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual report_plan resource, use r Namereport_plan TypeResource DescriptionContains detailed information about a report plan in AWS Backup Audit Manager. -Idaws.backup.report_plan +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
report_plan_namestringThe unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_descriptionstringAn optional description of the report plan with a maximum of 1,024 characters.
report_plan_tagsarrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
report_delivery_channelobjectA structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
report_settingobjectIdentifies the report template for the report. Reports are built using a report template.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual report_plan resource, use r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/report_plans/index.md b/docs/aws-docs/providers/aws/backup/report_plans/index.md index f72e282ab0..822d1152ba 100644 --- a/docs/aws-docs/providers/aws/backup/report_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/report_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of report_plans in a region or create a report_plans resource, use report_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of report_plans in a region or create a Namereport_plans TypeResource DescriptionContains detailed information about a report plan in AWS Backup Audit Manager. -Idaws.backup.report_plans +Id ## Fields - - + +
NameDatatypeDescription
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
regionstringAWS region.
stringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of report_plans in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md index af89ff24a0..677ba9da12 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual restore_testing_plan resource, use restore_testing_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual restore_testing_plan resource, us Namerestore_testing_plan TypeResource DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type -Idaws.backup.restore_testing_plan +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
recovery_point_selectionobject
restore_testing_plan_arnstring
restore_testing_plan_namestring
schedule_expressionstring
schedule_expression_timezonestring
start_window_hoursinteger
tagsarray
regionstringAWS region.
object
string
string
string
string
integer
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual restore_testing_plan resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md index 1d5ace4868..d26ed54126 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of restore_testing_plans in a region or create a restore_testing_plans resource, use restore_testing_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of restore_testing_plans in a region or cre Namerestore_testing_plans TypeResource DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type -Idaws.backup.restore_testing_plans +Id ## Fields - - + +
NameDatatypeDescription
restore_testing_plan_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of restore_testing_plans in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md index 85308dc1ab..6768a4c982 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual restore_testing_selection resource, use restore_testing_selections to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual restore_testing_selection resourc Namerestore_testing_selection TypeResource DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection -Idaws.backup.restore_testing_selection +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
iam_role_arnstring
protected_resource_arnsarray
protected_resource_conditionsobject
protected_resource_typestring
restore_metadata_overridesobject
restore_testing_plan_namestring
restore_testing_selection_namestring
validation_window_hoursinteger
regionstringAWS region.
string
array
object
string
object
string
string
integer
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual restore_testing_selection resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md index f4c9ae75c4..4e2841870f 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of restore_testing_selections in a region or create a restore_testing_selections resource, use restore_testing_selection to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of restore_testing_selections in a region o Namerestore_testing_selections TypeResource DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection -Idaws.backup.restore_testing_selections +Id ## Fields - - - + + +
NameDatatypeDescription
restore_testing_plan_namestring
restore_testing_selection_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of restore_testing_selections in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md index 014f407ac1..66a4154c8a 100644 --- a/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hypervisor resource, use hypervisors to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual hypervisor resource, use hy Namehypervisor TypeResource DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type -Idaws.backupgateway.hypervisor +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
hoststring
hypervisor_arnstring
kms_key_arnstring
log_group_arnstring
namestring
passwordstring
tagsarray
usernamestring
regionstringAWS region.
string
string
string
string
string
string
array
string
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual hypervisor resource, use hy Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md index 08849ff365..7a9682fc41 100644 --- a/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hypervisors in a region or create a hypervisors resource, use hypervisor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hypervisors in a region or create a Namehypervisors TypeResource DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type -Idaws.backupgateway.hypervisors +Id ## Fields - - + +
NameDatatypeDescription
hypervisor_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hypervisors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/batch/compute_environment/index.md b/docs/aws-docs/providers/aws/batch/compute_environment/index.md index bc5067b294..d115d630b7 100644 --- a/docs/aws-docs/providers/aws/batch/compute_environment/index.md +++ b/docs/aws-docs/providers/aws/batch/compute_environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual compute_environment resource, use compute_environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual compute_environment resource, use Namecompute_environment TypeResource DescriptionResource Type definition for AWS::Batch::ComputeEnvironment -Idaws.batch.compute_environment +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
compute_environment_arnstring
compute_environment_namestring
compute_resourcesobject
replace_compute_environmentboolean
service_rolestring
statestring
tagsobjectA key-value pair to associate with a resource.
typestring
update_policyobject
unmanagedv_cpusinteger
eks_configurationobject
regionstringAWS region.
string
string
object
boolean
string
string
objectA key-value pair to associate with a resource.
string
object
integer
object
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual compute_environment resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/batch/compute_environments/index.md b/docs/aws-docs/providers/aws/batch/compute_environments/index.md index 0fcf838e06..531ab45bf7 100644 --- a/docs/aws-docs/providers/aws/batch/compute_environments/index.md +++ b/docs/aws-docs/providers/aws/batch/compute_environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of compute_environments in a region or create a compute_environments resource, use compute_environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of compute_environments in a region or crea Namecompute_environments TypeResource DescriptionResource Type definition for AWS::Batch::ComputeEnvironment -Idaws.batch.compute_environments +Id ## Fields - - + +
NameDatatypeDescription
compute_environment_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of compute_environments in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/batch/job_queue/index.md b/docs/aws-docs/providers/aws/batch/job_queue/index.md index 790ef697b4..cec4de27af 100644 --- a/docs/aws-docs/providers/aws/batch/job_queue/index.md +++ b/docs/aws-docs/providers/aws/batch/job_queue/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual job_queue resource, use job_queues to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual job_queue resource, use job Namejob_queue TypeResource DescriptionResource Type definition for AWS::Batch::JobQueue -Idaws.batch.job_queue +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
job_queue_namestring
job_queue_arnstring
compute_environment_orderarray
job_state_time_limit_actionsarray
priorityinteger
statestring
scheduling_policy_arnstring
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
string
string
array
array
integer
string
string
objectA key-value pair to associate with a resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual job_queue resource, use job Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/batch/job_queues/index.md b/docs/aws-docs/providers/aws/batch/job_queues/index.md index 7e9cc927ca..d87d6210e9 100644 --- a/docs/aws-docs/providers/aws/batch/job_queues/index.md +++ b/docs/aws-docs/providers/aws/batch/job_queues/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of job_queues in a region or create a job_queues resource, use job_queue to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of job_queues in a region or create a Namejob_queues TypeResource DescriptionResource Type definition for AWS::Batch::JobQueue -Idaws.batch.job_queues +Id ## Fields - - + +
NameDatatypeDescription
job_queue_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of job_queues in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md index 1cddacdb73..12358d5c2d 100644 --- a/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md +++ b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scheduling_policies in a region or create a scheduling_policies resource, use scheduling_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scheduling_policies in a region or creat Namescheduling_policies TypeResource DescriptionResource Type schema for AWS::Batch::SchedulingPolicy -Idaws.batch.scheduling_policies +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scheduling_policies in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md index d808735754..6735e763c4 100644 --- a/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md +++ b/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scheduling_policy resource, use scheduling_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual scheduling_policy resource, use < Namescheduling_policy TypeResource DescriptionResource Type schema for AWS::Batch::SchedulingPolicy -Idaws.batch.scheduling_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringName of Scheduling Policy.
arnstring
fairshare_policyobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
stringName of Scheduling Policy.
string
object
objectA key-value pair to associate with a resource.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual scheduling_policy resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/export/index.md b/docs/aws-docs/providers/aws/bcmdataexports/export/index.md index 6472e25a42..58dad1a625 100644 --- a/docs/aws-docs/providers/aws/bcmdataexports/export/index.md +++ b/docs/aws-docs/providers/aws/bcmdataexports/export/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual export resource, use exports to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual export resource, use export Nameexport TypeResource DescriptionDefinition of AWS::BCMDataExports::Export Resource Type -Idaws.bcmdataexports.export +Id ## Fields - - - - + + + +
NameDatatypeDescription
exportobject
export_arnstring
tagsarray
regionstringAWS region.
object
string
array
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual export resource, use export Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md index 7f67cfbb41..9c3cf082c3 100644 --- a/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md +++ b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of exports in a region or create a exports resource, use export to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of exports in a region or create a ex Nameexports TypeResource DescriptionDefinition of AWS::BCMDataExports::Export Resource Type -Idaws.bcmdataexports.exports +Id ## Fields - - + +
NameDatatypeDescription
export_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of exports in a region or create a ex Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/bedrock/agent/index.md b/docs/aws-docs/providers/aws/bedrock/agent/index.md index 9d110b80b3..3a3e58925b 100644 --- a/docs/aws-docs/providers/aws/bedrock/agent/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agent/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual agent resource, use agents to retrieve a list of resources or to create a resource. ## Overview @@ -21,35 +24,35 @@ Gets or operates on an individual agent resource, use agents< Nameagent TypeResource DescriptionDefinition of AWS::Bedrock::Agent Resource Type -Idaws.bedrock.agent +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
action_groupsarrayList of ActionGroups
agent_arnstringArn representation of the Agent.
agent_idstringIdentifier for a resource.
agent_namestringName for a resource.
agent_resource_role_arnstringARN of a IAM role.
agent_statusstring
agent_versionstringDraft Agent Version.
auto_preparebooleanSpecifies whether to automatically prepare after creating or updating the agent.
created_atstringTime Stamp.
customer_encryption_key_arnstringA KMS key ARN
skip_resource_in_use_check_on_deletebooleanSpecifies whether to allow deleting agent while it is in use.
descriptionstringDescription of the Resource.
failure_reasonsarrayFailure Reasons for Error.
foundation_modelstringARN or name of a Bedrock model.
idle_session_ttl_in_secondsnumberMax Session Time.
instructionstringInstruction for the agent.
knowledge_basesarrayList of Agent Knowledge Bases
prepared_atstringTime Stamp.
prompt_override_configurationobject
recommended_actionsarrayThe recommended actions users can take to resolve an error in failureReasons.
tagsobject
updated_atstringTime Stamp.
regionstringAWS region.
arrayList of ActionGroups
stringArn representation of the Agent.
stringIdentifier for a resource.
stringName for a resource.
stringARN of a IAM role.
string
stringDraft Agent Version.
booleanSpecifies whether to automatically prepare after creating or updating the agent.
stringTime Stamp.
stringA KMS key ARN
booleanSpecifies whether to allow deleting agent while it is in use.
stringDescription of the Resource.
arrayFailure Reasons for Error.
stringARN or name of a Bedrock model.
numberMax Session Time.
stringInstruction for the agent.
arrayList of Agent Knowledge Bases
stringTime Stamp.
object
arrayThe recommended actions users can take to resolve an error in failureReasons.
object
stringTime Stamp.
stringAWS region.
@@ -62,19 +65,19 @@ Gets or operates on an individual agent resource, use agents< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md b/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md index a2efc45b68..236299692c 100644 --- a/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual agent_alias resource, use agent_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual agent_alias resource, use a Nameagent_alias TypeResource DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type -Idaws.bedrock.agent_alias +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
agent_alias_arnstringArn representation of the Agent Alias.
agent_alias_history_eventsarrayThe list of history events for an alias for an Agent.
agent_alias_idstringId for an Agent Alias generated at the server side.
agent_alias_namestringName for a resource.
agent_alias_statusstring
agent_idstringIdentifier for a resource.
created_atstringTime Stamp.
descriptionstringDescription of the Resource.
routing_configurationarrayRouting configuration for an Agent alias.
tagsobject
updated_atstringTime Stamp.
regionstringAWS region.
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.
string
stringIdentifier for a resource.
stringTime Stamp.
stringDescription of the Resource.
arrayRouting configuration for an Agent alias.
object
stringTime Stamp.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual agent_alias resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md index 4caeb7cb38..df7e33d71d 100644 --- a/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of agent_aliases in a region or create a agent_aliases resource, use agent_alias to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of agent_aliases in a region or create a Nameagent_aliases TypeResource DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type -Idaws.bedrock.agent_aliases +Id ## Fields - - - + + +
NameDatatypeDescription
agent_idstringIdentifier for a resource.
agent_alias_idstringId for an Agent Alias generated at the server side.
regionstringAWS region.
stringIdentifier for a resource.
stringId for an Agent Alias generated at the server side.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of agent_aliases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/bedrock/agents/index.md b/docs/aws-docs/providers/aws/bedrock/agents/index.md index 696fe6935d..62272890d2 100644 --- a/docs/aws-docs/providers/aws/bedrock/agents/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agents/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of agents in a region or create a agents resource, use agent to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of agents in a region or create a age Nameagents TypeResource DescriptionDefinition of AWS::Bedrock::Agent Resource Type -Idaws.bedrock.agents +Id ## Fields - - + +
NameDatatypeDescription
agent_idstringIdentifier for a resource.
regionstringAWS region.
stringIdentifier for a resource.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of agents in a region or create a age Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/bedrock/data_source/index.md b/docs/aws-docs/providers/aws/bedrock/data_source/index.md index ec08fa555d..226841c869 100644 --- a/docs/aws-docs/providers/aws/bedrock/data_source/index.md +++ b/docs/aws-docs/providers/aws/bedrock/data_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_source resource, use data_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual data_source resource, use d Namedata_source TypeResource DescriptionDefinition of AWS::Bedrock::DataSource Resource Type -Idaws.bedrock.data_source +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
data_source_configurationobject
data_source_idstringIdentifier for a resource.
descriptionstringDescription of the Resource.
knowledge_base_idstringThe unique identifier of the knowledge base to which to add the data source.
data_source_statusstring
namestringThe name of the data source.
server_side_encryption_configurationobject
vector_ingestion_configurationobject
created_atstringThe time at which the data source was created.
updated_atstringThe time at which the knowledge base was last updated.
regionstringAWS region.
object
stringIdentifier for a resource.
stringDescription of the Resource.
stringThe unique identifier of the knowledge base to which to add the data source.
string
stringThe name of the data source.
object
object
stringThe time at which the data source was created.
stringThe time at which the knowledge base was last updated.
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual data_source resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bedrock/data_sources/index.md b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md index d347d4ce1e..4fb0c65ab9 100644 --- a/docs/aws-docs/providers/aws/bedrock/data_sources/index.md +++ b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_sources in a region or create a data_sources resource, use data_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of data_sources in a region or create a Namedata_sources TypeResource DescriptionDefinition of AWS::Bedrock::DataSource Resource Type -Idaws.bedrock.data_sources +Id ## Fields - - - + + +
NameDatatypeDescription
knowledge_base_idstringThe unique identifier of the knowledge base to which to add the data source.
data_source_idstringIdentifier for a resource.
regionstringAWS region.
stringThe unique identifier of the knowledge base to which to add the data source.
stringIdentifier for a resource.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of data_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md index d6fbb51448..4ee1339f25 100644 --- a/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual knowledge_base resource, use knowledge_bases to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual knowledge_base resource, use Nameknowledge_base TypeResource DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type -Idaws.bedrock.knowledge_base +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringDescription of the Resource.
knowledge_base_configurationobject
knowledge_base_idstringThe unique identifier of the knowledge base.
knowledge_base_arnstringThe ARN of the knowledge base.
namestringThe name of the knowledge base.
statusstring
role_arnstringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
created_atstringThe time at which the knowledge base was created.
failure_reasonsarrayA list of reasons that the API operation on the knowledge base failed.
updated_atstringThe time at which the knowledge base was last updated.
storage_configurationobject
tagsobject
regionstringAWS region.
stringDescription of the Resource.
object
stringThe unique identifier of the knowledge base.
stringThe ARN of the knowledge base.
stringThe name of the knowledge base.
string
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.
object
object
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual knowledge_base resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md index fc632ae9f5..e114481d93 100644 --- a/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of knowledge_bases in a region or create a knowledge_bases resource, use knowledge_base to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of knowledge_bases in a region or create a Nameknowledge_bases TypeResource DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type -Idaws.bedrock.knowledge_bases +Id ## Fields - - + +
NameDatatypeDescription
knowledge_base_idstringThe unique identifier of the knowledge base.
regionstringAWS region.
stringThe unique identifier of the knowledge base.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of knowledge_bases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md index 0d5ae54087..191e328937 100644 --- a/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual billing_group resource, use billing_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual billing_group resource, use Namebilling_group TypeResource DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family. -Idaws.billingconductor.billing_group +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
arnstringBilling Group ARN
namestring
descriptionstring
primary_account_idstringThis account will act as a virtual payer account of the billing group
computation_preferenceobject
account_groupingobject
sizeintegerNumber of accounts in the billing group
statusstring
status_reasonstring
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual billing_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md index ffc170e38f..b67fab324f 100644 --- a/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of billing_groups in a region or create a billing_groups resource, use billing_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of billing_groups in a region or create a < Namebilling_groups TypeResource DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family. -Idaws.billingconductor.billing_groups +Id ## Fields - - + +
NameDatatypeDescription
arnstringBilling Group ARN
regionstringAWS region.
stringBilling Group ARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of billing_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md index c514557dd3..b640215d0a 100644 --- a/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual custom_line_item resource, use custom_line_items to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual custom_line_item resource, use Namecustom_line_item TypeResource DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill. -Idaws.billingconductor.custom_line_item +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
descriptionstring
custom_line_item_charge_detailsobject
billing_group_arnstringBilling Group ARN
billing_period_rangeobject
arnstringARN
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
association_sizeintegerNumber of source values associated to this custom line item
product_codestring
currency_codestring
account_idstringThe account which this custom line item will be charged to
tagsarray
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual custom_line_item resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md index 75c86ba81a..a2df235d7b 100644 --- a/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of custom_line_items in a region or create a custom_line_items resource, use custom_line_item to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of custom_line_items in a region or create Namecustom_line_items TypeResource DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill. -Idaws.billingconductor.custom_line_items +Id ## Fields - - + +
NameDatatypeDescription
arnstringARN
regionstringAWS region.
stringARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of custom_line_items in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md index 48ec8f210a..b6676b4ef7 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pricing_plan resource, use pricing_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual pricing_plan resource, use Namepricing_plan TypeResource DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups. -Idaws.billingconductor.pricing_plan +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringPricing Plan ARN
namestring
pricing_rule_arnsarray
sizeintegerNumber of associated pricing rules
descriptionstring
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual pricing_plan resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md index 0059597f11..a72e86d794 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pricing_plans in a region or create a pricing_plans resource, use pricing_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pricing_plans in a region or create a Namepricing_plans TypeResource DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups. -Idaws.billingconductor.pricing_plans +Id ## Fields - - + +
NameDatatypeDescription
arnstringPricing Plan ARN
regionstringAWS region.
stringPricing Plan ARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pricing_plans in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md index d308964992..a9e2da170a 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pricing_rule resource, use pricing_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual pricing_rule resource, use Namepricing_rule TypeResource DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan. -Idaws.billingconductor.pricing_rule +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringPricing rule ARN
namestringPricing rule name
descriptionstringPricing rule description
scopestringA term used to categorize the granularity of a Pricing Rule.
typestringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
modifier_percentagenumberPricing rule modifier percentage
servicestringThe service which a pricing rule is applied on
billing_entitystringThe seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.
tieringobjectThe set of tiering configurations for the pricing rule.
usage_typestringThe UsageType which a SKU pricing rule is modifying
operationstringThe Operation which a SKU pricing rule is modifying
associated_pricing_plan_countintegerThe number of pricing plans associated with pricing rule
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual pricing_rule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md index 96c5015003..00bf65fa7d 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pricing_rules in a region or create a pricing_rules resource, use pricing_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pricing_rules in a region or create a Namepricing_rules TypeResource DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan. -Idaws.billingconductor.pricing_rules +Id ## Fields - - + +
NameDatatypeDescription
arnstringPricing rule ARN
regionstringAWS region.
stringPricing rule ARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pricing_rules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/budgets/budgets_action/index.md b/docs/aws-docs/providers/aws/budgets/budgets_action/index.md index bdf7acd57c..185cbcd288 100644 --- a/docs/aws-docs/providers/aws/budgets/budgets_action/index.md +++ b/docs/aws-docs/providers/aws/budgets/budgets_action/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual budgets_action resource, use budgets_actions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual budgets_action resource, use Namebudgets_action TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.budgets.budgets_action +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
action_idstring
budget_namestring
notification_typestring
action_typestring
action_thresholdobject
execution_role_arnstring
approval_modelstring
subscribersarray
definitionobject
regionstringAWS region.
string
string
string
string
object
string
string
array
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual budgets_action resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md index 1bcd330174..88241d31be 100644 --- a/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md +++ b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of budgets_actions in a region or create a budgets_actions resource, use budgets_action to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of budgets_actions in a region or create a Namebudgets_actions TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.budgets.budgets_actions +Id ## Fields - - - + + +
NameDatatypeDescription
action_idstring
budget_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of budgets_actions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cassandra/keyspace/index.md b/docs/aws-docs/providers/aws/cassandra/keyspace/index.md index 6aa4f9f9d3..2e4e5cef47 100644 --- a/docs/aws-docs/providers/aws/cassandra/keyspace/index.md +++ b/docs/aws-docs/providers/aws/cassandra/keyspace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual keyspace resource, use keyspaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual keyspace resource, use keys Namekeyspace TypeResource DescriptionResource schema for AWS::Cassandra::Keyspace -Idaws.cassandra.keyspace +Id ## Fields - - - - + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
tagsarray
replication_specificationobject
regionstringAWS region.
stringName for Cassandra keyspace
array
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual keyspace resource, use keys Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md index fd2bb9dffc..65fc175f7d 100644 --- a/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md +++ b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of keyspaces in a region or create a keyspaces resource, use keyspace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of keyspaces in a region or create a Namekeyspaces TypeResource DescriptionResource schema for AWS::Cassandra::Keyspace -Idaws.cassandra.keyspaces +Id ## Fields - - + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
regionstringAWS region.
stringName for Cassandra keyspace
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of keyspaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cassandra/table/index.md b/docs/aws-docs/providers/aws/cassandra/table/index.md index 85895f0eda..8c4cee9a4c 100644 --- a/docs/aws-docs/providers/aws/cassandra/table/index.md +++ b/docs/aws-docs/providers/aws/cassandra/table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual table resource, use tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual table resource, use tables< Nametable TypeResource DescriptionResource schema for AWS::Cassandra::Table -Idaws.cassandra.table +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
table_namestringName for Cassandra table
regular_columnsarrayNon-key columns of the table
partition_key_columnsarrayPartition key columns of the table
clustering_key_columnsarrayClustering key columns of the table
billing_modeobject
point_in_time_recovery_enabledbooleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
client_side_timestamps_enabledbooleanIndicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.
tagsarrayAn array of key-value pairs to apply to this resource
default_time_to_liveintegerDefault TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
encryption_specificationobject
auto_scaling_specificationsobject
replica_specificationsarray
regionstringAWS region.
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.
object
object
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual table resource, use tables< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cassandra/tables/index.md b/docs/aws-docs/providers/aws/cassandra/tables/index.md index 4ea36b79bb..7f9d036625 100644 --- a/docs/aws-docs/providers/aws/cassandra/tables/index.md +++ b/docs/aws-docs/providers/aws/cassandra/tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tables in a region or create a tables resource, use table to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of tables in a region or create a tab Nametables TypeResource DescriptionResource schema for AWS::Cassandra::Table -Idaws.cassandra.tables +Id ## Fields - - - + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
table_namestringName for Cassandra table
regionstringAWS region.
stringName for Cassandra keyspace
stringName for Cassandra table
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of tables in a region or create a tab Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md index 5d1e8675f0..bda66af739 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual anomaly_monitor resource, use anomaly_monitors to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual anomaly_monitor resource, use Nameanomaly_monitor TypeResource DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor. -Idaws.ce.anomaly_monitor +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
monitor_arnstring
monitor_typestring
monitor_namestringThe name of the monitor.
creation_datestringThe date when the monitor was created.
last_evaluated_datestringThe date when the monitor last evaluated for anomalies.
last_updated_datestringThe date when the monitor was last updated.
monitor_dimensionstringThe dimensions to evaluate
monitor_specificationstring
dimensional_value_countintegerThe value for evaluated dimensions.
resource_tagsarrayTags to assign to monitor.
regionstringAWS region.
string
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual anomaly_monitor resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md index 50b7a03867..d470061a09 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of anomaly_monitors in a region or create a anomaly_monitors resource, use anomaly_monitor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of anomaly_monitors in a region or create a Nameanomaly_monitors TypeResource DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor. -Idaws.ce.anomaly_monitors +Id ## Fields - - + +
NameDatatypeDescription
monitor_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of anomaly_monitors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md index 12c7d65f23..9046580b52 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual anomaly_subscription resource, use anomaly_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual anomaly_subscription resource, us Nameanomaly_subscription TypeResource DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified -Idaws.ce.anomaly_subscription +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
subscription_arnstring
subscription_namestringThe name of the subscription.
account_idstringThe accountId
monitor_arn_listarrayA list of cost anomaly monitors.
subscribersarrayA list of subscriber
thresholdnumberThe dollar value that triggers a notification if the threshold is exceeded.
threshold_expressionstringAn Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.
frequencystringThe frequency at which anomaly reports are sent over email.
resource_tagsarrayTags to assign to subscription.
regionstringAWS region.
string
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual anomaly_subscription resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md index 6adbc86770..34569da2d5 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of anomaly_subscriptions in a region or create a anomaly_subscriptions resource, use anomaly_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of anomaly_subscriptions in a region or cre Nameanomaly_subscriptions TypeResource DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified -Idaws.ce.anomaly_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
subscription_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of anomaly_subscriptions in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ce/cost_categories/index.md b/docs/aws-docs/providers/aws/ce/cost_categories/index.md index f210d5e1a4..83951e2e95 100644 --- a/docs/aws-docs/providers/aws/ce/cost_categories/index.md +++ b/docs/aws-docs/providers/aws/ce/cost_categories/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cost_categories in a region or create a cost_categories resource, use cost_category to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cost_categories in a region or create a Namecost_categories TypeResource DescriptionCost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine. -Idaws.ce.cost_categories +Id ## Fields - - + +
NameDatatypeDescription
arnstringCost category ARN
regionstringAWS region.
stringCost category ARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cost_categories in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ce/cost_category/index.md b/docs/aws-docs/providers/aws/ce/cost_category/index.md index 66e905482a..0ad93ba6aa 100644 --- a/docs/aws-docs/providers/aws/ce/cost_category/index.md +++ b/docs/aws-docs/providers/aws/ce/cost_category/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cost_category resource, use cost_categories to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual cost_category resource, use Namecost_category TypeResource DescriptionCost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine. -Idaws.ce.cost_category +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstringCost category ARN
effective_startstring
namestring
rule_versionstring
rulesstringJSON array format of Expression in Billing and Cost Management API
split_charge_rulesstringJson array format of CostCategorySplitChargeRule in Billing and Cost Management API
default_valuestringThe default value for the cost category
regionstringAWS region.
stringCost category ARN
string
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual cost_category resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/certificatemanager/account/index.md b/docs/aws-docs/providers/aws/certificatemanager/account/index.md index e7ff68fefa..27ef6dea08 100644 --- a/docs/aws-docs/providers/aws/certificatemanager/account/index.md +++ b/docs/aws-docs/providers/aws/certificatemanager/account/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account resource, use accounts to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual account resource, use accou Nameaccount TypeResource DescriptionResource schema for AWS::CertificateManager::Account. -Idaws.certificatemanager.account +Id ## Fields - - - + + +
NameDatatypeDescription
expiry_events_configurationobject
account_idstring
regionstringAWS region.
object
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual account resource, use accou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md index 093c9b5a75..fb87f78e6a 100644 --- a/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md +++ b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of accounts in a region or create a accounts resource, use account to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of accounts in a region or create a a Nameaccounts TypeResource DescriptionResource schema for AWS::CertificateManager::Account. -Idaws.certificatemanager.accounts +Id ## Fields - - + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of accounts in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md index 31b06a12f4..03011e988f 100644 --- a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual microsoft_teams_channel_configuration resource, use microsoft_teams_channel_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual microsoft_teams_channel_configurationNamemicrosoft_teams_channel_configuration TypeResource DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration. -Idaws.chatbot.microsoft_teams_channel_configuration +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
team_idstringThe id of the Microsoft Teams team
teams_channel_idstringThe id of the Microsoft Teams channel
teams_tenant_idstringThe id of the Microsoft Teams tenant
configuration_namestringThe name of the configuration
iam_role_arnstringThe ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arnsarrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_levelstringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arnstringAmazon Resource Name (ARN) of the configuration
guardrail_policiesarrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
user_role_requiredbooleanEnables use of a user role requirement in your chat configuration
regionstringAWS region.
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
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual microsoft_teams_channel_configurationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md index d7a3d6b3b5..269fc67d83 100644 --- a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of microsoft_teams_channel_configurations in a region or create a microsoft_teams_channel_configurations resource, use microsoft_teams_channel_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of microsoft_teams_channel_configurations i Namemicrosoft_teams_channel_configurations TypeResource DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration. -Idaws.chatbot.microsoft_teams_channel_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
stringAmazon Resource Name (ARN) of the configuration
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of microsoft_teams_channel_configurations i Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md index 4880cf8cee..b4b4f4cb80 100644 --- a/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual slack_channel_configuration resource, use slack_channel_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual slack_channel_configuration resou Nameslack_channel_configuration TypeResource DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration. -Idaws.chatbot.slack_channel_configuration +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
slack_workspace_idstringThe id of the Slack workspace
slack_channel_idstringThe id of the Slack channel
configuration_namestringThe name of the configuration
iam_role_arnstringThe ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arnsarrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_levelstringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arnstringAmazon Resource Name (ARN) of the configuration
guardrail_policiesarrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
user_role_requiredbooleanEnables use of a user role requirement in your chat configuration
regionstringAWS region.
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
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual slack_channel_configuration resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md index a8d9c27181..52a3be0761 100644 --- a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of slack_channel_configurations in a region or create a slack_channel_configurations resource, use slack_channel_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of slack_channel_configurations in a region Nameslack_channel_configurations TypeResource DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration. -Idaws.chatbot.slack_channel_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
stringAmazon Resource Name (ARN) of the configuration
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of slack_channel_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md index 09d8700a71..a70ea87814 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual analysis_template resource, use analysis_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual analysis_template resource, use < Nameanalysis_template TypeResource DescriptionRepresents a stored analysis within a collaboration -Idaws.cleanrooms.analysis_template +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
collaboration_arnstring
collaboration_identifierstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
analysis_parametersarrayThe member who can query can provide this placeholder for a literal data value in an analysis template
analysis_template_identifierstring
descriptionstring
membership_arnstring
membership_identifierstring
namestring
schemaobject
sourceobject
formatstring
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual analysis_template resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md index 21fc1ec23e..d9e8a9ab78 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of analysis_templates in a region or create a analysis_templates resource, use analysis_template to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of analysis_templates in a region or create Nameanalysis_templates TypeResource DescriptionRepresents a stored analysis within a collaboration -Idaws.cleanrooms.analysis_templates +Id ## Fields - - - + + +
NameDatatypeDescription
analysis_template_identifierstring
membership_identifierstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of analysis_templates in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md index be89e1d5cf..87f41379a2 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual collaboration resource, use collaborations to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual collaboration resource, use Namecollaboration TypeResource DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration -Idaws.cleanrooms.collaboration +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
collaboration_identifierstring
creator_display_namestring
creator_member_abilitiesarray
data_encryption_metadataobject
descriptionstring
membersarray
namestring
query_log_statusstring
creator_payment_configurationobject
regionstringAWS region.
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
array
object
string
array
string
string
object
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual collaboration resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md index e0301f0979..cdd48630d0 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of collaborations in a region or create a collaborations resource, use collaboration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of collaborations in a region or create a < Namecollaborations TypeResource DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration -Idaws.cleanrooms.collaborations +Id ## Fields - - + +
NameDatatypeDescription
collaboration_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of collaborations in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md index 7461323e4a..a9ed6ea3e1 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configured_table resource, use configured_tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual configured_table resource, use Nameconfigured_table TypeResource DescriptionRepresents a table that can be associated with collaborations -Idaws.cleanrooms.configured_table +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
allowed_columnsarray
analysis_methodstring
configured_table_identifierstring
descriptionstring
namestring
analysis_rulesarray
table_referenceobject
regionstringAWS region.
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
array
string
string
string
string
array
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual configured_table resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md index 2fb694e795..23ae5fe5bf 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configured_table_association resource, use configured_table_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual configured_table_association reso Nameconfigured_table_association TypeResource DescriptionRepresents a table that can be queried within a collaboration -Idaws.cleanrooms.configured_table_association +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
configured_table_association_identifierstring
configured_table_identifierstring
descriptionstring
membership_identifierstring
namestring
role_arnstring
regionstringAWS region.
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
string
string
string
string
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual configured_table_association reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md index 4e5e35eebd..3fc2b2fe42 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configured_table_associations in a region or create a configured_table_associations resource, use configured_table_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of configured_table_associations in a regio Nameconfigured_table_associations TypeResource DescriptionRepresents a table that can be queried within a collaboration -Idaws.cleanrooms.configured_table_associations +Id ## Fields - - - + + +
NameDatatypeDescription
configured_table_association_identifierstring
membership_identifierstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of configured_table_associations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md index cc32784de7..b13e9aea93 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configured_tables in a region or create a configured_tables resource, use configured_table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configured_tables in a region or create Nameconfigured_tables TypeResource DescriptionRepresents a table that can be associated with collaborations -Idaws.cleanrooms.configured_tables +Id ## Fields - - + +
NameDatatypeDescription
configured_table_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configured_tables in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/membership/index.md b/docs/aws-docs/providers/aws/cleanrooms/membership/index.md index 2055118b5d..0c8b762747 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/membership/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/membership/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual membership resource, use memberships to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual membership resource, use me Namemembership TypeResource DescriptionRepresents an AWS account that is a part of a collaboration -Idaws.cleanrooms.membership +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
collaboration_arnstring
collaboration_creator_account_idstring
collaboration_identifierstring
membership_identifierstring
query_log_statusstring
default_result_configurationobject
payment_configurationobject
regionstringAWS region.
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
string
string
string
string
string
object
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual membership resource, use me Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md index 8887f65231..081248d2c4 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of memberships in a region or create a memberships resource, use membership to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of memberships in a region or create a Namememberships TypeResource DescriptionRepresents an AWS account that is a part of a collaboration -Idaws.cleanrooms.memberships +Id ## Fields - - + +
NameDatatypeDescription
membership_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of memberships in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md index 9ca94680c8..9c55e82402 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual privacy_budget_template resource, use privacy_budget_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual privacy_budget_template resource, Nameprivacy_budget_template TypeResource DescriptionRepresents a privacy budget within a collaboration -Idaws.cleanrooms.privacy_budget_template +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring
collaboration_arnstring
collaboration_identifierstring
privacy_budget_template_identifierstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
auto_refreshstring
privacy_budget_typestring
parametersobject
membership_arnstring
membership_identifierstring
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual privacy_budget_template resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md index 53b9bfba85..84e550e12e 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of privacy_budget_templates in a region or create a privacy_budget_templates resource, use privacy_budget_template to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of privacy_budget_templates in a region or Nameprivacy_budget_templates TypeResource DescriptionRepresents a privacy budget within a collaboration -Idaws.cleanrooms.privacy_budget_templates +Id ## Fields - - - + + +
NameDatatypeDescription
privacy_budget_template_identifierstring
membership_identifierstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of privacy_budget_templates in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md index fd27577474..bb631eb4aa 100644 --- a/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual training_dataset resource, use training_datasets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual training_dataset resource, use Nametraining_dataset TypeResource DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type -Idaws.cleanroomsml.training_dataset +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
descriptionstring
namestring
role_arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
training_dataarray
training_dataset_arnstring
statusstring
regionstringAWS region.
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
array
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual training_dataset resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md index fc0bb4b409..f547b22a86 100644 --- a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of training_datasets in a region or create a training_datasets resource, use training_dataset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of training_datasets in a region or create Nametraining_datasets TypeResource DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type -Idaws.cleanroomsml.training_datasets +Id ## Fields - - + +
NameDatatypeDescription
training_dataset_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of training_datasets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md index 8906c2e107..e8a01b30c1 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hook_default_version resource, use hook_default_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual hook_default_version resource, us Namehook_default_version TypeResource DescriptionSet a version as default version for a hook in CloudFormation Registry. -Idaws.cloudformation.hook_default_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
type_version_arnstringThe Amazon Resource Name (ARN) of the type version.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
version_idstringThe ID of an existing version of the hook to set as the default.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type version.
stringThe name of the type being registered.<br/><br/>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.
@@ -44,19 +47,19 @@ Gets or operates on an individual hook_default_version resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md index 16f35a0c66..97271a2638 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hook_default_versions in a region or create a hook_default_versions resource, use hook_default_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hook_default_versions in a region or cre Namehook_default_versions TypeResource DescriptionSet a version as default version for a hook in CloudFormation Registry. -Idaws.cloudformation.hook_default_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hook_default_versions in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md index d53e818c99..8ef15f1b04 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hook_type_config resource, use hook_type_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual hook_type_config resource, use Namehook_type_config TypeResource DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry. -Idaws.cloudformation.hook_type_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
type_arnstringThe Amazon Resource Name (ARN) of the type without version number.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
configuration_arnstringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
configurationstringThe configuration data for the extension, in this account and region.
configuration_aliasstringAn alias by which to refer to this extension configuration data.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type without version number.
stringThe name of the type being registered.<br/><br/>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.
@@ -45,19 +48,19 @@ Gets or operates on an individual hook_type_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md index 0da02ec22b..e6b3481842 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hook_type_configs in a region or create a hook_type_configs resource, use hook_type_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hook_type_configs in a region or create Namehook_type_configs TypeResource DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry. -Idaws.cloudformation.hook_type_configs +Id ## Fields - - + +
NameDatatypeDescription
configuration_arnstringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hook_type_configs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md index 6855d31e9e..d7640e55f7 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hook_version resource, use hook_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual hook_version resource, use Namehook_version TypeResource DescriptionPublishes new or first hook version to AWS CloudFormation Registry. -Idaws.cloudformation.hook_version +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
type_arnstringThe Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
is_default_versionbooleanIndicates if this type version is the current default version
logging_configobjectSpecifies logging configuration information for a type.
schema_handler_packagestringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_idstringThe ID of the version of the type represented by this hook instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>Valid values include:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
regionstringAWS region.
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.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.<br/><br/>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.<br/><br/>Valid values include:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
@@ -49,14 +52,14 @@ Gets or operates on an individual hook_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md index 622d7aa9fe..a1e14f3dd8 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hook_versions in a region or create a hook_versions resource, use hook_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hook_versions in a region or create a Namehook_versions TypeResource DescriptionPublishes new or first hook version to AWS CloudFormation Registry. -Idaws.cloudformation.hook_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hook_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md index 467795dcd9..2defd56100 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual module_default_version resource, use module_default_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual module_default_version resource, Namemodule_default_version TypeResource DescriptionA module that has been registered in the CloudFormation registry as the default version -Idaws.cloudformation.module_default_version +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module version to set as the default version.
module_namestringThe name of a module existing in the registry.
version_idstringThe ID of an existing version of the named module to set as the default.
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Gets or operates on an individual module_default_version resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md index 0356093adb..50d6b2001e 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of module_default_versions in a region or create a module_default_versions resource, use module_default_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of module_default_versions in a region or c Namemodule_default_versions TypeResource DescriptionA module that has been registered in the CloudFormation registry as the default version -Idaws.cloudformation.module_default_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module version to set as the default version.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the module version to set as the default version.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of module_default_versions in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_version/index.md b/docs/aws-docs/providers/aws/cloudformation/module_version/index.md index a200b13aeb..97ee9e2c91 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual module_version resource, use module_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual module_version resource, use Namemodule_version TypeResource DescriptionA module that has been registered in the CloudFormation registry. -Idaws.cloudformation.module_version +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module.
descriptionstringThe description of the registered module.
documentation_urlstringThe URL of a page providing detailed documentation for this module.
module_namestringThe name of the module being registered.<br/><br/>Recommended module naming pattern: company_or_organization::service::type::MODULE.
module_packagestringThe url to the S3 bucket containing the schema and template fragment for the module you want to register.
is_default_versionbooleanIndicator of whether this module version is the current default version
schemastringThe schema defining input parameters to and resources generated by the module.
time_createdstringThe time that the specified module version was registered.
version_idstringThe version ID of the module represented by this module instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>The only allowed value at present is:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
regionstringAWS region.
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.<br/><br/>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.<br/><br/>The only allowed value at present is:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
stringAWS region.
@@ -50,14 +53,14 @@ Gets or operates on an individual module_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md index 85649e02bd..942876cc30 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of module_versions in a region or create a module_versions resource, use module_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of module_versions in a region or create a Namemodule_versions TypeResource DescriptionA module that has been registered in the CloudFormation registry. -Idaws.cloudformation.module_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the module.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of module_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md index b767d807b0..76349906de 100644 --- a/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual public_type_version resource, use public_type_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual public_type_version resource, use Namepublic_type_version TypeResource DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.public_type_version +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Number (ARN) of the extension.
type_version_arnstringThe Amazon Resource Number (ARN) of the extension with the versionId.
public_version_numberstringThe version number of a public third-party extension
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
log_delivery_bucketstringA url to the S3 bucket where logs for the testType run will be available
typestringThe kind of extension
regionstringAWS region.
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.<br/><br/>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.
@@ -48,14 +51,14 @@ Gets or operates on an individual public_type_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md index 9be9b75d59..8fa5159412 100644 --- a/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of public_type_versions in a region or create a public_type_versions resource, use public_type_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of public_type_versions in a region or crea Namepublic_type_versions TypeResource DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.public_type_versions +Id ## Fields - - + +
NameDatatypeDescription
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
regionstringAWS region.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of public_type_versions in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/publisher/index.md b/docs/aws-docs/providers/aws/cloudformation/publisher/index.md index b669c8bdcd..29eec71aec 100644 --- a/docs/aws-docs/providers/aws/cloudformation/publisher/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/publisher/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual publisher resource, use publishers to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual publisher resource, use pub Namepublisher TypeResource DescriptionRegister as a publisher in the CloudFormation Registry. -Idaws.cloudformation.publisher +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
accept_terms_and_conditionsbooleanWhether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
connection_arnstringIf you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
publisher_statusstringWhether the publisher is verified.
publisher_profilestringThe URL to the publisher's profile with the identity provider.
identity_providerstringThe type of account used as the identity provider when registering this publisher with CloudFormation.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual publisher resource, use pub Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/publishers/index.md b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md index 4746c1a6ca..b5075adfa2 100644 --- a/docs/aws-docs/providers/aws/cloudformation/publishers/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of publishers in a region or create a publishers resource, use publisher to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of publishers in a region or create a Namepublishers TypeResource DescriptionRegister as a publisher in the CloudFormation Registry. -Idaws.cloudformation.publishers +Id ## Fields - - + +
NameDatatypeDescription
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
regionstringAWS region.
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of publishers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md index 59a8858628..2f4520c6fc 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_default_version resource, use resource_default_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource_default_version resource Nameresource_default_version TypeResource DescriptionThe default version of a resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.resource_default_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
version_idstringThe ID of an existing version of the resource to set as the default.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
type_version_arnstringThe Amazon Resource Name (ARN) of the type version.
regionstringAWS region.
stringThe ID of an existing version of the resource to set as the default.
stringThe name of the type being registered.<br/><br/>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.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource_default_version resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md index f804bdd8a9..7003f0aa09 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_default_versions in a region or create a resource_default_versions resource, use resource_default_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_default_versions in a region or Nameresource_default_versions TypeResource DescriptionThe default version of a resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.resource_default_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_default_versions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md index af14e40af1..c6248c5b49 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_version resource, use resource_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual resource_version resource, use Nameresource_version TypeResource DescriptionA resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.resource_version +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
type_arnstringThe Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
is_default_versionbooleanIndicates if this type version is the current default version
logging_configobjectSpecifies logging configuration information for a type.
provisioning_typestringThe provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
schema_handler_packagestringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_idstringThe ID of the version of the type represented by this resource instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>Valid values include:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
regionstringAWS region.
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.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.<br/><br/>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.<br/><br/>Valid values include:<br/><br/>PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
@@ -50,14 +53,14 @@ Gets or operates on an individual resource_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md index 0bc4729715..13a3c350a0 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_versions in a region or create a resource_versions resource, use resource_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_versions in a region or create Nameresource_versions TypeResource DescriptionA resource that has been registered in the CloudFormation Registry. -Idaws.cloudformation.resource_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_versions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack/index.md b/docs/aws-docs/providers/aws/cloudformation/stack/index.md index c270e7fbf3..13c4fcd59e 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stack/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stack/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stack resource, use stacks to retrieve a list of resources or to create a resource. ## Overview @@ -21,36 +24,36 @@ Gets or operates on an individual stack resource, use stacks< Namestack TypeResource DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template. -Idaws.cloudformation.stack +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesarray
role_arnstring
outputsarray
descriptionstring
disable_rollbackboolean
enable_termination_protectionboolean
notification_arnsarray
parametersobject
parent_idstring
root_idstring
change_set_idstring
stack_namestring
stack_idstring
stack_policy_bodyobject
stack_policy_urlstring
stack_statusstring
stack_status_reasonstring
tagsarray
template_bodyobject
template_urlstring
timeout_in_minutesinteger
last_update_timestring
creation_timestring
regionstringAWS region.
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.
@@ -63,19 +66,19 @@ Gets or operates on an individual stack resource, use stacks< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md index e71c39ac1d..a33fcf6b2e 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stack_set resource, use stack_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual stack_set resource, use sta Namestack_set TypeResource DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances -Idaws.cloudformation.stack_set +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stack_set_namestringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stack_set_idstringThe ID of the stack set that you're creating.
administration_role_arnstringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
auto_deploymentobjectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
capabilitiesarrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
descriptionstringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
execution_role_namestringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
operation_preferencesobject
stack_instances_grouparrayA group of stack instances with parameters in some specific accounts and regions.
parametersarrayThe input parameters for the stack set template.
permission_modelstringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
tagsarrayThe key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
template_bodystringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
template_urlstringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
call_asstringSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
managed_executionobjectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
regionstringAWS region.
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.
object
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual stack_set resource, use sta Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md index 6ff5c75a2a..b65d394844 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stack_sets in a region or create a stack_sets resource, use stack_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stack_sets in a region or create a Namestack_sets TypeResource DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances -Idaws.cloudformation.stack_sets +Id ## Fields - - + +
NameDatatypeDescription
stack_set_idstringThe ID of the stack set that you're creating.
regionstringAWS region.
stringThe ID of the stack set that you're creating.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of stack_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/stacks/index.md b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md index 78b272af12..218bcb62a5 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stacks/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stacks in a region or create a stacks resource, use stack to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stacks in a region or create a sta Namestacks TypeResource DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template. -Idaws.cloudformation.stacks +Id ## Fields - - + +
NameDatatypeDescription
stack_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of stacks in a region or create a sta Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md index d4dc8a335b..34a92f5065 100644 --- a/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual type_activation resource, use type_activations to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual type_activation resource, use Nametype_activation TypeResource DescriptionEnable a resource that has been published in the CloudFormation Registry. -Idaws.cloudformation.type_activation +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the extension.
execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
logging_configobjectSpecifies logging configuration information for a type.
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
auto_updatebooleanWhether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
type_name_aliasstringAn alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
version_bumpstringManually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
major_versionstringThe Major Version of the type you want to enable
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
typestringThe kind of extension
regionstringAWS region.
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.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe kind of extension
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual type_activation resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md index 01efdaa575..e8d7218b58 100644 --- a/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of type_activations in a region or create a type_activations resource, use type_activation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of type_activations in a region or create a Nametype_activations TypeResource DescriptionEnable a resource that has been published in the CloudFormation Registry. -Idaws.cloudformation.type_activations +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the extension.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the extension.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of type_activations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md index 83f0f90126..56a6558160 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cache_policies in a region or create a cache_policies resource, use cache_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cache_policies in a region or create a < Namecache_policies TypeResource DescriptionResource Type definition for AWS::CloudFront::CachePolicy -Idaws.cloudfront.cache_policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cache_policies in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md index d4b44593c8..6f27086ca3 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cache_policy resource, use cache_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual cache_policy resource, use Namecache_policy TypeResource DescriptionResource Type definition for AWS::CloudFront::CachePolicy -Idaws.cloudfront.cache_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
cache_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
object
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual cache_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md index 9eb0ffb568..3ec254e742 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cloud_front_origin_access_identities in a region or create a cloud_front_origin_access_identities resource, use cloud_front_origin_access_identity to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cloud_front_origin_access_identities in Namecloud_front_origin_access_identities TypeResource DescriptionResource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity -Idaws.cloudfront.cloud_front_origin_access_identities +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cloud_front_origin_access_identities in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md index 6cdd8edc93..260650cbb7 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cloud_front_origin_access_identity resource, use cloud_front_origin_access_identities to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual cloud_front_origin_access_identityNamecloud_front_origin_access_identity TypeResource DescriptionResource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity -Idaws.cloudfront.cloud_front_origin_access_identity +Id ## Fields - - - - + + + +
NameDatatypeDescription
cloud_front_origin_access_identity_configobject
idstring
s3_canonical_user_idstring
regionstringAWS region.
object
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual cloud_front_origin_access_identityRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md index ce0128ab60..332f13bd04 100644 --- a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of continuous_deployment_policies in a region or create a continuous_deployment_policies resource, use continuous_deployment_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of continuous_deployment_policies in a regi Namecontinuous_deployment_policies TypeResource DescriptionResource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy -Idaws.cloudfront.continuous_deployment_policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of continuous_deployment_policies in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md index 78794cc91f..4a5dddf563 100644 --- a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual continuous_deployment_policy resource, use continuous_deployment_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual continuous_deployment_policy reso Namecontinuous_deployment_policy TypeResource DescriptionResource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy -Idaws.cloudfront.continuous_deployment_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
continuous_deployment_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
object
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual continuous_deployment_policy reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/distribution/index.md b/docs/aws-docs/providers/aws/cloudfront/distribution/index.md index f3c2f50dbf..6b2546784f 100644 --- a/docs/aws-docs/providers/aws/cloudfront/distribution/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/distribution/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual distribution resource, use distributions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual distribution resource, use Namedistribution TypeResource DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. -Idaws.cloudfront.distribution +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
distribution_configobjectThe distribution's configuration.
domain_namestring
idstring
tagsarrayA complex type that contains zero or more ``Tag`` elements.
regionstringAWS region.
objectThe distribution's configuration.
string
string
arrayA complex type that contains zero or more ``Tag`` elements.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual distribution resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/distributions/index.md b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md index ba6be3381d..c66706147d 100644 --- a/docs/aws-docs/providers/aws/cloudfront/distributions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of distributions in a region or create a distributions resource, use distribution to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of distributions in a region or create a Namedistributions TypeResource DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. -Idaws.cloudfront.distributions +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of distributions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/function/index.md b/docs/aws-docs/providers/aws/cloudfront/function/index.md index 2704153a80..812ca8bcb0 100644 --- a/docs/aws-docs/providers/aws/cloudfront/function/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/function/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual function resource, use functions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual function resource, use func Namefunction TypeResource DescriptionResource Type definition for AWS::CloudFront::Function -Idaws.cloudfront.function +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
auto_publishboolean
function_arnstring
function_codestring
function_configobject
function_metadataobject
namestring
stagestring
regionstringAWS region.
boolean
string
string
object
object
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual function resource, use func Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/functions/index.md b/docs/aws-docs/providers/aws/cloudfront/functions/index.md index 8ca76ac86a..83b430c532 100644 --- a/docs/aws-docs/providers/aws/cloudfront/functions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/functions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of functions in a region or create a functions resource, use function to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of functions in a region or create a Namefunctions TypeResource DescriptionResource Type definition for AWS::CloudFront::Function -Idaws.cloudfront.functions +Id ## Fields - - + +
NameDatatypeDescription
function_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of functions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_group/index.md b/docs/aws-docs/providers/aws/cloudfront/key_group/index.md index bbf5850278..57b694dcc1 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_group/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual key_group resource, use key_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual key_group resource, use key Namekey_group TypeResource DescriptionResource Type definition for AWS::CloudFront::KeyGroup -Idaws.cloudfront.key_group +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
key_group_configobject
last_modified_timestring
regionstringAWS region.
string
object
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual key_group resource, use key Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md index 6ec45c889b..0eb4fd3725 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of key_groups in a region or create a key_groups resource, use key_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of key_groups in a region or create a Namekey_groups TypeResource DescriptionResource Type definition for AWS::CloudFront::KeyGroup -Idaws.cloudfront.key_groups +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of key_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md index 5773147319..a3fb308aea 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual key_value_store resource, use key_value_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual key_value_store resource, use Namekey_value_store TypeResource DescriptionResource Type definition for AWS::CloudFront::KeyValueStore -Idaws.cloudfront.key_value_store +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
idstring
statusstring
namestring
commentstring
import_sourceobject
regionstringAWS region.
string
string
string
string
string
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual key_value_store resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md index f8f629ecf4..9456ec2fcb 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of key_value_stores in a region or create a key_value_stores resource, use key_value_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of key_value_stores in a region or create a Namekey_value_stores TypeResource DescriptionResource Type definition for AWS::CloudFront::KeyValueStore -Idaws.cloudfront.key_value_stores +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of key_value_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md index 56f3c2eca2..c25d7b4c44 100644 --- a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual monitoring_subscription resource, use monitoring_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual monitoring_subscription resource, Namemonitoring_subscription TypeResource DescriptionResource Type definition for AWS::CloudFront::MonitoringSubscription -Idaws.cloudfront.monitoring_subscription +Id ## Fields - - - + + +
NameDatatypeDescription
distribution_idstring
monitoring_subscriptionobject
regionstringAWS region.
string
object
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual monitoring_subscription resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md index 664aeebdbd..9f5c293a7c 100644 --- a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of monitoring_subscriptions in a region or create a monitoring_subscriptions resource, use monitoring_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of monitoring_subscriptions in a region or Namemonitoring_subscriptions TypeResource DescriptionResource Type definition for AWS::CloudFront::MonitoringSubscription -Idaws.cloudfront.monitoring_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
distribution_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of monitoring_subscriptions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md index 4834dd6938..a07f4652fe 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual origin_access_control resource, use origin_access_controls to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual origin_access_control resource, u Nameorigin_access_control TypeResource DescriptionResource Type definition for AWS::CloudFront::OriginAccessControl -Idaws.cloudfront.origin_access_control +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
origin_access_control_configobject
regionstringAWS region.
string
object
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual origin_access_control resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md index 41cceb47fe..2f32108520 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of origin_access_controls in a region or create a origin_access_controls resource, use origin_access_control to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of origin_access_controls in a region or cr Nameorigin_access_controls TypeResource DescriptionResource Type definition for AWS::CloudFront::OriginAccessControl -Idaws.cloudfront.origin_access_controls +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of origin_access_controls in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md index ab7e2ebf94..6ceb54b97e 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of origin_request_policies in a region or create a origin_request_policies resource, use origin_request_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of origin_request_policies in a region or c Nameorigin_request_policies TypeResource DescriptionResource Type definition for AWS::CloudFront::OriginRequestPolicy -Idaws.cloudfront.origin_request_policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of origin_request_policies in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md index 895dfb6f10..fd2ab0d8d2 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual origin_request_policy resource, use origin_request_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual origin_request_policy resource, u Nameorigin_request_policy TypeResource DescriptionResource Type definition for AWS::CloudFront::OriginRequestPolicy -Idaws.cloudfront.origin_request_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
last_modified_timestring
origin_request_policy_configobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual origin_request_policy resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/public_key/index.md b/docs/aws-docs/providers/aws/cloudfront/public_key/index.md index 9b8d9ad61e..d809b78fac 100644 --- a/docs/aws-docs/providers/aws/cloudfront/public_key/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/public_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual public_key resource, use public_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual public_key resource, use pu Namepublic_key TypeResource DescriptionResource Type definition for AWS::CloudFront::PublicKey -Idaws.cloudfront.public_key +Id ## Fields - - - - + + + +
NameDatatypeDescription
created_timestring
idstring
public_key_configobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual public_key resource, use pu Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md index f08c49ed9f..7b3c484316 100644 --- a/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of public_keys in a region or create a public_keys resource, use public_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of public_keys in a region or create a Namepublic_keys TypeResource DescriptionResource Type definition for AWS::CloudFront::PublicKey -Idaws.cloudfront.public_keys +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of public_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md index ff2215d49c..55397ff48f 100644 --- a/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual realtime_log_config resource, use realtime_log_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual realtime_log_config resource, use Namerealtime_log_config TypeResource DescriptionResource Type definition for AWS::CloudFront::RealtimeLogConfig -Idaws.cloudfront.realtime_log_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
end_pointsarray
fieldsarray
namestring
sampling_ratenumber
regionstringAWS region.
string
array
array
string
number
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual realtime_log_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md index 9a22394999..19abf64407 100644 --- a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of realtime_log_configs in a region or create a realtime_log_configs resource, use realtime_log_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of realtime_log_configs in a region or crea Namerealtime_log_configs TypeResource DescriptionResource Type definition for AWS::CloudFront::RealtimeLogConfig -Idaws.cloudfront.realtime_log_configs +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of realtime_log_configs in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md index d0faa0a784..ade7b20a36 100644 --- a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of response_headers_policies in a region or create a response_headers_policies resource, use response_headers_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of response_headers_policies in a region or Nameresponse_headers_policies TypeResource DescriptionResource Type definition for AWS::CloudFront::ResponseHeadersPolicy -Idaws.cloudfront.response_headers_policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of response_headers_policies in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md index 33ebbb7363..e55b14865b 100644 --- a/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual response_headers_policy resource, use response_headers_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual response_headers_policy resource, Nameresponse_headers_policy TypeResource DescriptionResource Type definition for AWS::CloudFront::ResponseHeadersPolicy -Idaws.cloudfront.response_headers_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
last_modified_timestring
response_headers_policy_configobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual response_headers_policy resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/channel/index.md b/docs/aws-docs/providers/aws/cloudtrail/channel/index.md index 346b18c379..f7b8d168fd 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/channel/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel resource, use channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual channel resource, use chann Namechannel TypeResource DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS. -Idaws.cloudtrail.channel +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestring
sourcestringThe ARN of an on-premises storage solution or application, or a partner event source.
destinationsarrayOne or more resources to which events arriving through a channel are logged and stored.
channel_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
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.
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual channel resource, use chann Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/channels/index.md b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md index b142fc0218..29522d16c3 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/channels/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channels in a region or create a channels resource, use channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channels in a region or create a c Namechannels TypeResource DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS. -Idaws.cloudtrail.channels +Id ## Fields - - + +
NameDatatypeDescription
channel_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channels in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md index 6500d416fa..843c890491 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_data_store resource, use event_data_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual event_data_store resource, use Nameevent_data_store TypeResource DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode. -Idaws.cloudtrail.event_data_store +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
advanced_event_selectorsarrayThe advanced event selectors that were used to select events for the data store.
created_timestampstringThe timestamp of the event data store's creation.
event_data_store_arnstringThe ARN of the event data store.
federation_enabledbooleanIndicates whether federation is enabled on an event data store.
federation_role_arnstringThe ARN of the role used for event data store federation.
multi_region_enabledbooleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
namestringThe name of the event data store.
organization_enabledbooleanIndicates that an event data store is collecting logged events for an organization.
billing_modestringThe mode that the event data store will use to charge for event storage.
retention_periodintegerThe retention period, in days.
statusstringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
termination_protection_enabledbooleanIndicates whether the event data store is protected from termination.
updated_timestampstringThe timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
kms_key_idstringSpecifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
tagsarray
insight_selectorsarrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
insights_destinationstringSpecifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
ingestion_enabledbooleanIndicates whether the event data store is ingesting events.
regionstringAWS region.
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.
@@ -58,19 +61,19 @@ Gets or operates on an individual event_data_store resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md index 8588604bef..e69e2006f9 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_data_stores in a region or create a event_data_stores resource, use event_data_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_data_stores in a region or create Nameevent_data_stores TypeResource DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode. -Idaws.cloudtrail.event_data_stores +Id ## Fields - - + +
NameDatatypeDescription
event_data_store_arnstringThe ARN of the event data store.
regionstringAWS region.
stringThe ARN of the event data store.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_data_stores in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md index dffb47702f..95c12f0567 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionResource Type definition for AWS::CloudTrail::ResourcePolicy -Idaws.cloudtrail.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
resource_arnstringThe ARN of the AWS CloudTrail resource to which the policy applies.
regionstringAWS region.
stringThe ARN of the AWS CloudTrail resource to which the policy applies.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md b/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md index 8c3e3ec5cb..78ff48d0e9 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionResource Type definition for AWS::CloudTrail::ResourcePolicy -Idaws.cloudtrail.resource_policy +Id ## Fields - - - + + +
NameDatatypeDescription
resource_arnstringThe ARN of the AWS CloudTrail resource to which the policy applies.
resource_policyobjectA policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/trail/index.md b/docs/aws-docs/providers/aws/cloudtrail/trail/index.md index 431685401b..fda44b1553 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/trail/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/trail/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual trail resource, use trails to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual trail resource, use trails< Nametrail TypeResource DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. -Idaws.cloudtrail.trail +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cloud_watch_logs_log_group_arnstringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
cloud_watch_logs_role_arnstringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enable_log_file_validationbooleanSpecifies whether log file validation is enabled. The default is false.
advanced_event_selectorsarrayThe advanced event selectors that were used to select events for the data store.
event_selectorsarrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
include_global_service_eventsbooleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
is_loggingbooleanWhether the CloudTrail is currently logging AWS API calls.
is_multi_region_trailbooleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
is_organization_trailbooleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
kms_key_idstringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
s3_bucket_namestringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3_key_prefixstringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
sns_topic_namestringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tagsarray
trail_namestring
arnstring
sns_topic_arnstring
insight_selectorsarrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
regionstringAWS region.
stringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
stringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
booleanSpecifies whether log file validation is enabled. The default is false.
arrayThe advanced event selectors that were used to select events for the data store.
arrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
booleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
booleanWhether the CloudTrail is currently logging AWS API calls.
booleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
booleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
stringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
stringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
stringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
stringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
array
string
string
string
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
stringAWS region.
@@ -58,19 +61,19 @@ Gets or operates on an individual trail resource, use trails< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudtrail/trails/index.md b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md index cffa47eaa8..506d095064 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/trails/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trails in a region or create a trails resource, use trail to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of trails in a region or create a tra Nametrails TypeResource DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. -Idaws.cloudtrail.trails +Id ## Fields - - + +
NameDatatypeDescription
trail_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of trails in a region or create a tra Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md index 417d86259c..d11823fbfb 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alarm resource, use alarms to retrieve a list of resources or to create a resource. ## Overview @@ -21,36 +24,36 @@ Gets or operates on an individual alarm resource, use alarms< Namealarm TypeResource DescriptionThe ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.<br/> When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.<br/> When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. -Idaws.cloudwatch.alarm +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
threshold_metric_idstringIn an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.
evaluate_low_sample_count_percentilestringUsed only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
extended_statisticstringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
treat_missing_datastringSets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.<br/> If you omit this parameter, the default behavior of ``missing`` is used.
dimensionsarrayThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.
periodintegerThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.<br/> For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.<br/> *Minimum:* 10
evaluation_periodsintegerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.<br/> For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
unitstringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.<br/> You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
namespacestringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.<br/> For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
ok_actionsarrayThe actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
alarm_actionsarrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
metric_namestringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.
actions_enabledbooleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
metricsarrayAn array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.<br/> If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.
alarm_descriptionstringThe description of the alarm.
alarm_namestringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. <br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
statisticstringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
insufficient_data_actionsarrayThe actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arnstring
datapoints_to_alarmintegerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.<br/> If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
thresholdnumberThe value to compare with the specified statistic.
tagsarray
regionstringAWS region.
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.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
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*.<br/> 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.<br/> For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.<br/> *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.<br/> 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.<br/> You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
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.<br/> For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
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.<br/> 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. <br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
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*.<br/> If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
numberThe value to compare with the specified statistic.
array
stringAWS region.
@@ -63,19 +66,19 @@ Gets or operates on an individual alarm resource, use alarms< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md index ed26b69481..5f4613bf89 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of alarms in a region or create a alarms resource, use alarm to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of alarms in a region or create a ala Namealarms TypeResource DescriptionThe ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.<br/> When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.<br/> When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. -Idaws.cloudwatch.alarms +Id ## Fields - - + +
NameDatatypeDescription
alarm_namestringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. <br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
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. <br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of alarms in a region or create a ala Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md index 3c1d2e1428..0961848e07 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual composite_alarm resource, use composite_alarms to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual composite_alarm resource, use Namecomposite_alarm TypeResource DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression -Idaws.cloudwatch.composite_alarm +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the alarm
alarm_namestringThe name of the Composite Alarm
alarm_rulestringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
alarm_descriptionstringThe description of the alarm
actions_enabledbooleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
ok_actionsarrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
alarm_actionsarrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
insufficient_data_actionsarrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
actions_suppressorstringActions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
actions_suppressor_wait_periodintegerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
actions_suppressor_extension_periodintegerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
tagsarrayA list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual composite_alarm resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md index c9c5b53972..eae5b42874 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of composite_alarms in a region or create a composite_alarms resource, use composite_alarm to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of composite_alarms in a region or create a Namecomposite_alarms TypeResource DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression -Idaws.cloudwatch.composite_alarms +Id ## Fields - - + +
NameDatatypeDescription
alarm_namestringThe name of the Composite Alarm
regionstringAWS region.
stringThe name of the Composite Alarm
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of composite_alarms in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md index 4a4b81b0d2..eb13ec4592 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual metric_stream resource, use metric_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual metric_stream resource, use Namemetric_stream TypeResource DescriptionResource Type definition for Metric Stream -Idaws.cloudwatch.metric_stream +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name of the metric stream.
creation_datestringThe date of creation of the metric stream.
exclude_filtersarrayDefine which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
firehose_arnstringThe ARN of the Kinesis Firehose where to stream the data.
include_filtersarrayDefine which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
last_update_datestringThe date of the last update of the metric stream.
namestringName of the metric stream.
role_arnstringThe ARN of the role that provides access to the Kinesis Firehose.
statestringDisplays the state of the Metric Stream.
output_formatstringThe output format of the data streamed to the Kinesis Firehose.
statistics_configurationsarrayBy default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
tagsarrayA set of tags to assign to the delivery stream.
include_linked_accounts_metricsbooleanIf you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual metric_stream resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md index c99ed78c47..8c79d0d218 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of metric_streams in a region or create a metric_streams resource, use metric_stream to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of metric_streams in a region or create a < Namemetric_streams TypeResource DescriptionResource Type definition for Metric Stream -Idaws.cloudwatch.metric_streams +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the metric stream.
regionstringAWS region.
stringName of the metric stream.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of metric_streams in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeartifact/domain/index.md b/docs/aws-docs/providers/aws/codeartifact/domain/index.md index c25919e8cd..111b017d49 100644 --- a/docs/aws-docs/providers/aws/codeartifact/domain/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionThe resource schema to create a CodeArtifact domain. -Idaws.codeartifact.domain +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
domain_namestringThe name of the domain.
namestringThe name of the domain. This field is used for GetAtt
ownerstringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
encryption_keystringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
permissions_policy_documentobjectThe access control resource policy on the provided domain.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstringThe ARN of the domain.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codeartifact/domains/index.md b/docs/aws-docs/providers/aws/codeartifact/domains/index.md index 651572d84d..04fbd17f5a 100644 --- a/docs/aws-docs/providers/aws/codeartifact/domains/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionThe resource schema to create a CodeArtifact domain. -Idaws.codeartifact.domains +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the domain.
regionstringAWS region.
stringThe ARN of the domain.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeartifact/package_group/index.md b/docs/aws-docs/providers/aws/codeartifact/package_group/index.md index 2d1ba3418a..984f6e7e7b 100644 --- a/docs/aws-docs/providers/aws/codeartifact/package_group/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/package_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual package_group resource, use package_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual package_group resource, use Namepackage_group TypeResource DescriptionThe resource schema to create a CodeArtifact package group. -Idaws.codeartifact.package_group +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
domain_namestringThe name of the domain that contains the package group.
domain_ownerstringThe 12-digit account ID of the AWS account that owns the domain.
patternstringThe package group pattern that is used to gather packages.
contact_infostringThe contact info of the package group.
descriptionstringThe text description of the package group.
origin_configurationobjectThe package origin configuration of the package group.
tagsarrayAn array of key-value pairs to apply to the package group.
arnstringThe ARN of the package group.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual package_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md index d3dc2c1af7..a8c8e22441 100644 --- a/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of package_groups in a region or create a package_groups resource, use package_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of package_groups in a region or create a < Namepackage_groups TypeResource DescriptionThe resource schema to create a CodeArtifact package group. -Idaws.codeartifact.package_groups +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the package group.
regionstringAWS region.
stringThe ARN of the package group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of package_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeartifact/repositories/index.md b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md index 878a67f59b..1e5d6d7549 100644 --- a/docs/aws-docs/providers/aws/codeartifact/repositories/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of repositories in a region or create a repositories resource, use repository to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of repositories in a region or create a Namerepositories TypeResource DescriptionThe resource schema to create a CodeArtifact repository. -Idaws.codeartifact.repositories +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the repository.
regionstringAWS region.
stringThe ARN of the repository.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of repositories in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeartifact/repository/index.md b/docs/aws-docs/providers/aws/codeartifact/repository/index.md index f68a5c19c8..90bae47564 100644 --- a/docs/aws-docs/providers/aws/codeartifact/repository/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/repository/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual repository resource, use repositories to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual repository resource, use re Namerepository TypeResource DescriptionThe resource schema to create a CodeArtifact repository. -Idaws.codeartifact.repository +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
repository_namestringThe name of the repository.
namestringThe name of the repository. This is used for GetAtt
domain_namestringThe name of the domain that contains the repository.
domain_ownerstringThe 12-digit account ID of the AWS account that owns the domain.
descriptionstringA text description of the repository.
arnstringThe ARN of the repository.
external_connectionsarrayA list of external connections associated with the repository.
upstreamsarrayA list of upstream repositories associated with the repository.
permissions_policy_documentobjectThe access control resource policy on the provided repository.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual repository resource, use re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codebuild/fleet/index.md b/docs/aws-docs/providers/aws/codebuild/fleet/index.md index 7d5e8ba68e..119a91be28 100644 --- a/docs/aws-docs/providers/aws/codebuild/fleet/index.md +++ b/docs/aws-docs/providers/aws/codebuild/fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet resource, use fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual fleet resource, use fleets< Namefleet TypeResource DescriptionResource Type definition for AWS::CodeBuild::Fleet -Idaws.codebuild.fleet +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestring
base_capacityinteger
environment_typestring
compute_typestring
tagsarray
arnstring
regionstringAWS region.
string
integer
string
string
array
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual fleet resource, use fleets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codebuild/fleets/index.md b/docs/aws-docs/providers/aws/codebuild/fleets/index.md index a0d7420cae..ca0b947b54 100644 --- a/docs/aws-docs/providers/aws/codebuild/fleets/index.md +++ b/docs/aws-docs/providers/aws/codebuild/fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleets in a region or create a fleets resource, use fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleets in a region or create a fle Namefleets TypeResource DescriptionResource Type definition for AWS::CodeBuild::Fleet -Idaws.codebuild.fleets +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleets in a region or create a fle Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeconnections/connection/index.md b/docs/aws-docs/providers/aws/codeconnections/connection/index.md index 76a640aca9..3631547276 100644 --- a/docs/aws-docs/providers/aws/codeconnections/connection/index.md +++ b/docs/aws-docs/providers/aws/codeconnections/connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connection resource, use connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual connection resource, use co Nameconnection TypeResource DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline) -Idaws.codeconnections.connection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
connection_namestringThe name of the connection. Connection names must be unique in an AWS user account.
connection_statusstringThe current status of the connection.
owner_account_idstringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
provider_typestringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
host_arnstringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
tagsarraySpecifies the tags applied to a connection.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual connection resource, use co Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codeconnections/connections/index.md b/docs/aws-docs/providers/aws/codeconnections/connections/index.md index 7334bb86e6..c61e6bfca0 100644 --- a/docs/aws-docs/providers/aws/codeconnections/connections/index.md +++ b/docs/aws-docs/providers/aws/codeconnections/connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connections in a region or create a connections resource, use connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connections in a region or create a Nameconnections TypeResource DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline) -Idaws.codeconnections.connections +Id ## Fields - - + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codedeploy/application/index.md b/docs/aws-docs/providers/aws/codedeploy/application/index.md index 58e4f5f5aa..ff88f204bb 100644 --- a/docs/aws-docs/providers/aws/codedeploy/application/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application -Idaws.codedeploy.application +Id ## Fields - - - - + + + +
NameDatatypeDescription
application_namestringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
compute_platformstringThe compute platform that CodeDeploy deploys the application to.
tagsarrayThe metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codedeploy/applications/index.md b/docs/aws-docs/providers/aws/codedeploy/applications/index.md index 9beb2c3612..1cf664a35b 100644 --- a/docs/aws-docs/providers/aws/codedeploy/applications/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application -Idaws.codedeploy.applications +Id ## Fields - - + +
NameDatatypeDescription
application_namestringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md index 059d632801..f8ff47a494 100644 --- a/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual deployment_config resource, use deployment_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual deployment_config resource, use < Namedeployment_config TypeResource DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig -Idaws.codedeploy.deployment_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
compute_platformstringThe destination platform type for the deployment (Lambda, Server, or ECS).
deployment_config_namestringA name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
minimum_healthy_hostsobjectThe minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
zonal_configobjectThe zonal deployment config that specifies how the zonal deployment behaves
traffic_routing_configobjectThe configuration that specifies how the deployment traffic is routed.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual deployment_config resource, use < Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md index daddfa330a..6ef5cacca5 100644 --- a/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of deployment_configs in a region or create a deployment_configs resource, use deployment_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of deployment_configs in a region or create Namedeployment_configs TypeResource DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig -Idaws.codedeploy.deployment_configs +Id ## Fields - - + +
NameDatatypeDescription
deployment_config_namestringA name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of deployment_configs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md index b266137b0a..7215df2066 100644 --- a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual profiling_group resource, use profiling_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual profiling_group resource, use Nameprofiling_group TypeResource DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service. -Idaws.codeguruprofiler.profiling_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
profiling_group_namestringThe name of the profiling group.
compute_platformstringThe compute platform of the profiling group.
agent_permissionsobjectThe agent permissions attached to this profiling group.
anomaly_detection_notification_configurationarrayConfiguration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
arnstringThe Amazon Resource Name (ARN) of the specified profiling group.
tagsarrayThe tags associated with a profiling group.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual profiling_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md index 758b38a9b8..044b2a3c5e 100644 --- a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of profiling_groups in a region or create a profiling_groups resource, use profiling_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of profiling_groups in a region or create a Nameprofiling_groups TypeResource DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service. -Idaws.codeguruprofiler.profiling_groups +Id ## Fields - - + +
NameDatatypeDescription
profiling_group_namestringThe name of the profiling group.
regionstringAWS region.
stringThe name of the profiling group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of profiling_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md index 9a69a7c569..3a29da5a26 100644 --- a/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual repository_association resource, use repository_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual repository_association resource, Namerepository_association TypeResource DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service. -Idaws.codegurureviewer.repository_association +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringName of the repository to be associated.
typestringThe type of repository to be associated.
ownerstringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
bucket_namestringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
connection_arnstringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
association_arnstringThe Amazon Resource Name (ARN) of the repository association.
tagsarrayThe tags associated with a repository association.
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual repository_association resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md index 7763f4466e..d96e4e3925 100644 --- a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of repository_associations in a region or create a repository_associations resource, use repository_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of repository_associations in a region or c Namerepository_associations TypeResource DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service. -Idaws.codegurureviewer.repository_associations +Id ## Fields - - + +
NameDatatypeDescription
association_arnstringThe Amazon Resource Name (ARN) of the repository association.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the repository association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of repository_associations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md index c724616ce7..5efd7b0c0b 100644 --- a/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual custom_action_type resource, use custom_action_types to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual custom_action_type resource, use Namecustom_action_type TypeResource DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. -Idaws.codepipeline.custom_action_type +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
categorystringThe category of the custom action, such as a build action or a test action.
configuration_propertiesarrayThe configuration properties for the custom action.
input_artifact_detailsobjectThe details of the input artifact for the action, such as its commit ID.
output_artifact_detailsobjectThe details of the output artifact of the action, such as its commit ID.
providerstringThe provider of the service used in the custom action, such as AWS CodeDeploy.
settingsobjectURLs that provide users information about this custom action.
tagsarrayAny tags assigned to the custom action.
versionstringThe version identifier of the custom action.
idstring
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual custom_action_type resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md index e5ce46da7c..fe141d44d9 100644 --- a/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of custom_action_types in a region or create a custom_action_types resource, use custom_action_type to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of custom_action_types in a region or creat Namecustom_action_types TypeResource DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. -Idaws.codepipeline.custom_action_types +Id ## Fields - - - - + + + +
NameDatatypeDescription
categorystringThe category of the custom action, such as a build action or a test action.
providerstringThe provider of the service used in the custom action, such as AWS CodeDeploy.
versionstringThe version identifier of the custom action.
regionstringAWS region.
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.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of custom_action_types in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/connection/index.md b/docs/aws-docs/providers/aws/codestarconnections/connection/index.md index 68ff01c65b..c41bfd2830 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/connection/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connection resource, use connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual connection resource, use co Nameconnection TypeResource DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline -Idaws.codestarconnections.connection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
connection_namestringThe name of the connection. Connection names must be unique in an AWS user account.
connection_statusstringThe current status of the connection.
owner_account_idstringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
provider_typestringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
host_arnstringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
tagsarraySpecifies the tags applied to a connection.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual connection resource, use co Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/connections/index.md b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md index acd304e92d..5c6742147f 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/connections/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connections in a region or create a connections resource, use connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connections in a region or create a Nameconnections TypeResource DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline -Idaws.codestarconnections.connections +Id ## Fields - - + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md index dec3b37665..e163291510 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual repository_link resource, use repository_links to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual repository_link resource, use Namerepository_link TypeResource DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources. -Idaws.codestarconnections.repository_link +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
provider_typestringThe name of the external provider where your third-party code repository is configured.
owner_idstringthe ID of the entity that owns the repository.
repository_namestringThe repository for which the link is being created.
encryption_key_arnstringThe ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.
repository_link_idstringA UUID that uniquely identifies the RepositoryLink.
repository_link_arnstringA unique Amazon Resource Name (ARN) to designate the repository link.
tagsarraySpecifies the tags applied to a RepositoryLink.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual repository_link resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md index 9bf8136da5..0fa7520b74 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of repository_links in a region or create a repository_links resource, use repository_link to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of repository_links in a region or create a Namerepository_links TypeResource DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources. -Idaws.codestarconnections.repository_links +Id ## Fields - - + +
NameDatatypeDescription
repository_link_arnstringA unique Amazon Resource Name (ARN) to designate the repository link.
regionstringAWS region.
stringA unique Amazon Resource Name (ARN) to designate the repository link.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of repository_links in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md index 4777aed477..1b629e54fa 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual sync_configuration resource, use sync_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual sync_configuration resource, use Namesync_configuration TypeResource DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider. -Idaws.codestarconnections.sync_configuration +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
owner_idstringthe ID of the entity that owns the repository.
resource_namestringThe name of the resource that is being synchronized to the repository.
repository_namestringThe name of the repository that is being synced to.
provider_typestringThe name of the external provider where your third-party code repository is configured.
branchstringThe name of the branch of the repository from which resources are to be synchronized,
config_filestringThe source provider repository path of the sync configuration file of the respective SyncType.
sync_typestringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
role_arnstringThe IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
publish_deployment_statusstringWhether to enable or disable publishing of deployment status to source providers.
trigger_resource_update_onstringWhen to trigger Git sync to begin the stack update.
repository_link_idstringA UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual sync_configuration resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md index 79038bb08f..135b14ac6e 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sync_configurations in a region or create a sync_configurations resource, use sync_configuration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of sync_configurations in a region or creat Namesync_configurations TypeResource DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider. -Idaws.codestarconnections.sync_configurations +Id ## Fields - - - + + +
NameDatatypeDescription
resource_namestringThe name of the resource that is being synchronized to the repository.
sync_typestringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of sync_configurations in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md index 8b974cb44e..73241cc29d 100644 --- a/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual notification_rule resource, use notification_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual notification_rule resource, use < Namenotification_rule TypeResource DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule -Idaws.codestarnotifications.notification_rule +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
event_type_idstring
created_bystring
target_addressstring
event_type_idsarray
statusstring
detail_typestring
resourcestring
targetsarray
tagsobject
namestring
arnstring
regionstringAWS region.
string
string
string
array
string
string
string
array
object
string
string
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual notification_rule resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md index 7b4e0dc2af..6f9ed9dc12 100644 --- a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of notification_rules in a region or create a notification_rules resource, use notification_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of notification_rules in a region or create Namenotification_rules TypeResource DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule -Idaws.codestarnotifications.notification_rules +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of notification_rules in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool/index.md index 37301c302f..73dd648503 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_pool resource, use identity_pools to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual identity_pool resource, use Nameidentity_pool TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPool -Idaws.cognito.identity_pool +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
push_syncobject
cognito_identity_providersarray
developer_provider_namestring
cognito_streamsobject
supported_login_providersobject
namestring
cognito_eventsobject
idstring
identity_pool_namestring
allow_unauthenticated_identitiesboolean
saml_provider_arnsarray
open_id_connect_provider_arnsarray
allow_classic_flowboolean
regionstringAWS region.
object
array
string
object
object
string
object
string
string
boolean
array
array
boolean
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual identity_pool resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md index f2116f8afe..7fe59e946f 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_pool_principal_tag resource, use identity_pool_principal_tags to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual identity_pool_principal_tag resou Nameidentity_pool_principal_tag TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag -Idaws.cognito.identity_pool_principal_tag +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
use_defaultsboolean
principal_tagsobject
regionstringAWS region.
string
string
boolean
object
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual identity_pool_principal_tag resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md index b019b77ad2..b609df132c 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_pool_principal_tags in a region or create a identity_pool_principal_tags resource, use identity_pool_principal_tag to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of identity_pool_principal_tags in a region Nameidentity_pool_principal_tags TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag -Idaws.cognito.identity_pool_principal_tags +Id ## Fields - - - + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of identity_pool_principal_tags in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md index b8862fbb75..d83673ddb1 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_pool_role_attachment resource, use identity_pool_role_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual identity_pool_role_attachment res Nameidentity_pool_role_attachment TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment -Idaws.cognito.identity_pool_role_attachment +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
identity_pool_idstring
rolesundefined
idstring
role_mappingsundefined
regionstringAWS region.
string
undefined
string
undefined
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual identity_pool_role_attachment res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md index 484322dbbb..cdc0301f12 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_pool_role_attachments in a region or create a identity_pool_role_attachments resource, use identity_pool_role_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of identity_pool_role_attachments in a regi Nameidentity_pool_role_attachments TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment -Idaws.cognito.identity_pool_role_attachments +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of identity_pool_role_attachments in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pools/index.md b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md index f600a38438..1f9364f529 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pools/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_pools in a region or create a identity_pools resource, use identity_pool to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of identity_pools in a region or create a < Nameidentity_pools TypeResource DescriptionResource Type definition for AWS::Cognito::IdentityPool -Idaws.cognito.identity_pools +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of identity_pools in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md b/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md index bded989685..9b00d2d4ee 100644 --- a/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md +++ b/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual log_delivery_configuration resource, use log_delivery_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual log_delivery_configuration resour Namelog_delivery_configuration TypeResource DescriptionResource Type definition for AWS::Cognito::LogDeliveryConfiguration -Idaws.cognito.log_delivery_configuration +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
user_pool_idstring
log_configurationsarray
regionstringAWS region.
string
string
array
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual log_delivery_configuration resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md index f89dd54b99..73c302d149 100644 --- a/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md +++ b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of log_delivery_configurations in a region or create a log_delivery_configurations resource, use log_delivery_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of log_delivery_configurations in a region Namelog_delivery_configurations TypeResource DescriptionResource Type definition for AWS::Cognito::LogDeliveryConfiguration -Idaws.cognito.log_delivery_configurations +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of log_delivery_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool/index.md b/docs/aws-docs/providers/aws/cognito/user_pool/index.md index 2c1d6e0dac..30d5e669c2 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool resource, use user_pools to retrieve a list of resources or to create a resource. ## Overview @@ -21,41 +24,41 @@ Gets or operates on an individual user_pool resource, use use Nameuser_pool TypeResource DescriptionResource Type definition for AWS::Cognito::UserPool -Idaws.cognito.user_pool +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
user_pool_namestring
policiesobject
account_recovery_settingobject
admin_create_user_configobject
alias_attributesarray
username_attributesarray
auto_verified_attributesarray
device_configurationobject
email_configurationobject
email_verification_messagestring
email_verification_subjectstring
deletion_protectionstring
lambda_configobject
mfa_configurationstring
enabled_mfasarray
sms_authentication_messagestring
sms_configurationobject
sms_verification_messagestring
schemaarray
username_configurationobject
user_attribute_update_settingsobject
user_pool_tagsobject
verification_message_templateobject
user_pool_add_onsobject
provider_namestring
provider_urlstring
arnstring
user_pool_idstring
regionstringAWS region.
string
object
object
object
array
array
array
object
object
string
string
string
object
string
array
string
object
string
array
object
object
object
object
object
string
string
string
string
stringAWS region.
@@ -68,19 +71,19 @@ Gets or operates on an individual user_pool resource, use use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md index 8e628725b2..1d6f49fbb6 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool_client resource, use user_pool_clients to retrieve a list of resources or to create a resource. ## Overview @@ -21,38 +24,38 @@ Gets or operates on an individual user_pool_client resource, use Nameuser_pool_client TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolClient -Idaws.cognito.user_pool_client +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
client_namestring
explicit_auth_flowsarray
generate_secretboolean
read_attributesarray
auth_session_validityinteger
refresh_token_validityinteger
access_token_validityinteger
id_token_validityinteger
token_validity_unitsobject
user_pool_idstring
write_attributesarray
allowed_oauth_flowsarray
allowed_oauth_flows_user_pool_clientboolean
allowed_oauth_scopesarray
callback_urlsarray
default_redirect_uristring
logout_urlsarray
supported_identity_providersarray
analytics_configurationobject
prevent_user_existence_errorsstring
enable_token_revocationboolean
enable_propagate_additional_user_context_databoolean
namestring
client_secretstring
client_idstring
regionstringAWS region.
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.
@@ -65,19 +68,19 @@ Gets or operates on an individual user_pool_client resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md index 0f03ec4837..0db1dcb7a3 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pool_clients in a region or create a user_pool_clients resource, use user_pool_client to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of user_pool_clients in a region or create Nameuser_pool_clients TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolClient -Idaws.cognito.user_pool_clients +Id ## Fields - - - + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of user_pool_clients in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md index b18352dbcb..51c5af2971 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool_group resource, use user_pool_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual user_pool_group resource, use Nameuser_pool_group TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolGroup -Idaws.cognito.user_pool_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstring
group_namestring
precedenceinteger
role_arnstring
user_pool_idstring
regionstringAWS region.
string
string
integer
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual user_pool_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md index 6c78df7e85..78639ad240 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pool_groups in a region or create a user_pool_groups resource, use user_pool_group to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of user_pool_groups in a region or create a Nameuser_pool_groups TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolGroup -Idaws.cognito.user_pool_groups +Id ## Fields - - - + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of user_pool_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md index 91be94e418..76117fc69c 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool_risk_configuration_attachment resource, use user_pool_risk_configuration_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual user_pool_risk_configuration_attachment< Nameuser_pool_risk_configuration_attachment TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment -Idaws.cognito.user_pool_risk_configuration_attachment +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
risk_exception_configurationobject
compromised_credentials_risk_configurationobject
account_takeover_risk_configurationobject
regionstringAWS region.
string
string
object
object
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual user_pool_risk_configuration_attachment< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md index d5ad261000..035e46f2be 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pool_risk_configuration_attachments in a region or create a user_pool_risk_configuration_attachments resource, use user_pool_risk_configuration_attachment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of user_pool_risk_configuration_attachments Nameuser_pool_risk_configuration_attachments TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment -Idaws.cognito.user_pool_risk_configuration_attachments +Id ## Fields - - - + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of user_pool_risk_configuration_attachments Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md index 607110d2e5..3319ce45d7 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool_user resource, use user_pool_users to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual user_pool_user resource, use Nameuser_pool_user TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolUser -Idaws.cognito.user_pool_user +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
desired_delivery_mediumsarray
force_alias_creationboolean
user_attributesarray
message_actionstring
usernamestring
user_pool_idstring
validation_dataarray
client_metadataobject
regionstringAWS region.
array
boolean
array
string
string
string
array
object
stringAWS region.
@@ -48,14 +51,14 @@ Gets or operates on an individual user_pool_user resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md index e8f7171fbe..ce869eeee5 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_pool_user_to_group_attachment resource, use user_pool_user_to_group_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual user_pool_user_to_group_attachmentNameuser_pool_user_to_group_attachment TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment -Idaws.cognito.user_pool_user_to_group_attachment +Id ## Fields - - - - + + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
group_namestring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual user_pool_user_to_group_attachmentRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md index c849095aa9..e40863e7de 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pool_user_to_group_attachments in a region or create a user_pool_user_to_group_attachments resource, use user_pool_user_to_group_attachment to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of user_pool_user_to_group_attachments in a Nameuser_pool_user_to_group_attachments TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment -Idaws.cognito.user_pool_user_to_group_attachments +Id ## Fields - - - - + + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
usernamestring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of user_pool_user_to_group_attachments in a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md index 308ffb6033..0bc9eb412c 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pool_users in a region or create a user_pool_users resource, use user_pool_user to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of user_pool_users in a region or create a Nameuser_pool_users TypeResource DescriptionResource Type definition for AWS::Cognito::UserPoolUser -Idaws.cognito.user_pool_users +Id ## Fields - - - + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of user_pool_users in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cognito/user_pools/index.md b/docs/aws-docs/providers/aws/cognito/user_pools/index.md index 9c5cf29bcc..9ca05bdc47 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pools/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pools/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_pools in a region or create a user_pools resource, use user_pool to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of user_pools in a region or create a Nameuser_pools TypeResource DescriptionResource Type definition for AWS::Cognito::UserPool -Idaws.cognito.user_pools +Id ## Fields - - + +
NameDatatypeDescription
user_pool_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of user_pools in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md index 0a0dd82c49..60602415f0 100644 --- a/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md +++ b/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual document_classifier resource, use document_classifiers to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual document_classifier resource, use Namedocument_classifier TypeResource DescriptionDocument Classifier enables training document classifier models. -Idaws.comprehend.document_classifier +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
data_access_role_arnstring
input_data_configobject
output_data_configobject
language_codestring
model_kms_key_idstring
model_policystring
document_classifier_namestring
modestring
tagsarray
version_namestring
volume_kms_key_idstring
vpc_configobject
arnstring
regionstringAWS region.
string
object
object
string
string
string
string
string
array
string
string
object
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual document_classifier resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md index 856a119c69..d00093a856 100644 --- a/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md +++ b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of document_classifiers in a region or create a document_classifiers resource, use document_classifier to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of document_classifiers in a region or crea Namedocument_classifiers TypeResource DescriptionDocument Classifier enables training document classifier models. -Idaws.comprehend.document_classifiers +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of document_classifiers in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheel/index.md b/docs/aws-docs/providers/aws/comprehend/flywheel/index.md index 24a82ee885..319eb2a806 100644 --- a/docs/aws-docs/providers/aws/comprehend/flywheel/index.md +++ b/docs/aws-docs/providers/aws/comprehend/flywheel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flywheel resource, use flywheels to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual flywheel resource, use flyw Nameflywheel TypeResource DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model. -Idaws.comprehend.flywheel +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
active_model_arnstring
data_access_role_arnstring
data_lake_s3_uristring
data_security_configobject
flywheel_namestring
model_typestring
tagsarray
task_configobject
arnstring
regionstringAWS region.
string
string
string
object
string
string
array
object
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual flywheel resource, use flyw Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheels/index.md b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md index 42cd056aa2..1a1025c009 100644 --- a/docs/aws-docs/providers/aws/comprehend/flywheels/index.md +++ b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flywheels in a region or create a flywheels resource, use flywheel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flywheels in a region or create a Nameflywheels TypeResource DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model. -Idaws.comprehend.flywheels +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flywheels in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md index a3b46d04b4..abc166555c 100644 --- a/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md +++ b/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual aggregation_authorization resource, use aggregation_authorizations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual aggregation_authorization resourc Nameaggregation_authorization TypeResource DescriptionResource Type definition for AWS::Config::AggregationAuthorization -Idaws.config.aggregation_authorization +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
authorized_account_idstringThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_regionstringThe region authorized to collect aggregated data.
aggregation_authorization_arnstringThe ARN of the AggregationAuthorization.
tagsarrayThe tags for the AggregationAuthorization.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual aggregation_authorization resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md index 69fde6b900..8bc09d5433 100644 --- a/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md +++ b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of aggregation_authorizations in a region or create a aggregation_authorizations resource, use aggregation_authorization to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of aggregation_authorizations in a region o Nameaggregation_authorizations TypeResource DescriptionResource Type definition for AWS::Config::AggregationAuthorization -Idaws.config.aggregation_authorizations +Id ## Fields - - - + + +
NameDatatypeDescription
authorized_account_idstringThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_regionstringThe region authorized to collect aggregated data.
regionstringAWS region.
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of aggregation_authorizations in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/config_rule/index.md b/docs/aws-docs/providers/aws/config/config_rule/index.md index 27f44fba3a..e729b7ad39 100644 --- a/docs/aws-docs/providers/aws/config/config_rule/index.md +++ b/docs/aws-docs/providers/aws/config/config_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual config_rule resource, use config_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual config_rule resource, use c Nameconfig_rule TypeResource DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).<br/> Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.<br/> There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.<br/> CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.<br/> CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.<br/> If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. <br/> For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.<br/> If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.<br/> For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*. -Idaws.config.config_rule +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
config_rule_idstring
descriptionstringThe description that you provide for the CC rule.
scopeobjectDefines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.<br/> The scope can be empty.
config_rule_namestringA name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
arnstring
complianceobjectIndicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.
maximum_execution_frequencystringThe maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:<br/> + You are using an AWS managed rule that is triggered at a periodic frequency.<br/> + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).<br/> <br/> By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.
sourceobjectProvides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
input_parametersobjectA string, in JSON format, that is passed to the CC rule Lambda function.
evaluation_modesarrayThe modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
regionstringAWS region.
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.<br/> 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:<br/> + You are using an AWS managed rule that is triggered at a periodic frequency.<br/> + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).<br/> <br/> By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual config_rule resource, use c Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/config/config_rules/index.md b/docs/aws-docs/providers/aws/config/config_rules/index.md index 7d5a0bfed4..8c50a03352 100644 --- a/docs/aws-docs/providers/aws/config/config_rules/index.md +++ b/docs/aws-docs/providers/aws/config/config_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of config_rules in a region or create a config_rules resource, use config_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of config_rules in a region or create a Nameconfig_rules TypeResource DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).<br/> Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.<br/> There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.<br/> CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.<br/> CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.<br/> If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. <br/> For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.<br/> If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.<br/> For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*. -Idaws.config.config_rules +Id ## Fields - - + +
NameDatatypeDescription
config_rule_namestringA name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of config_rules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md index 3407eaa216..feb1425865 100644 --- a/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md +++ b/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration_aggregator resource, use configuration_aggregators to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual configuration_aggregator resource Nameconfiguration_aggregator TypeResource DescriptionResource Type definition for AWS::Config::ConfigurationAggregator -Idaws.config.configuration_aggregator +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
account_aggregation_sourcesarray
configuration_aggregator_namestringThe name of the aggregator.
configuration_aggregator_arnstringThe Amazon Resource Name (ARN) of the aggregator.
organization_aggregation_sourceobject
tagsarrayThe tags for the configuration aggregator.
regionstringAWS region.
array
stringThe name of the aggregator.
stringThe Amazon Resource Name (ARN) of the aggregator.
object
arrayThe tags for the configuration aggregator.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual configuration_aggregator resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md index 2a6ad1c5b1..1f6d6303a8 100644 --- a/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md +++ b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configuration_aggregators in a region or create a configuration_aggregators resource, use configuration_aggregator to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configuration_aggregators in a region or Nameconfiguration_aggregators TypeResource DescriptionResource Type definition for AWS::Config::ConfigurationAggregator -Idaws.config.configuration_aggregators +Id ## Fields - - + +
NameDatatypeDescription
configuration_aggregator_namestringThe name of the aggregator.
regionstringAWS region.
stringThe name of the aggregator.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configuration_aggregators in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/conformance_pack/index.md b/docs/aws-docs/providers/aws/config/conformance_pack/index.md index a76dbd5669..3ae1b08647 100644 --- a/docs/aws-docs/providers/aws/config/conformance_pack/index.md +++ b/docs/aws-docs/providers/aws/config/conformance_pack/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual conformance_pack resource, use conformance_packs to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual conformance_pack resource, use Nameconformance_pack TypeResource DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization. -Idaws.config.conformance_pack +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
conformance_pack_namestringName of the conformance pack which will be assigned as the unique identifier.
delivery_s3_bucketstringAWS Config stores intermediate files while processing conformance pack template.
delivery_s3_key_prefixstringThe prefix for delivery S3 bucket.
template_bodystringA string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
template_s3_uristringLocation of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
template_ssm_document_detailsobjectThe TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
conformance_pack_input_parametersarrayA list of ConformancePackInputParameter objects.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual conformance_pack resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/config/conformance_packs/index.md b/docs/aws-docs/providers/aws/config/conformance_packs/index.md index fc23c50d8b..3c767d08d7 100644 --- a/docs/aws-docs/providers/aws/config/conformance_packs/index.md +++ b/docs/aws-docs/providers/aws/config/conformance_packs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of conformance_packs in a region or create a conformance_packs resource, use conformance_pack to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of conformance_packs in a region or create Nameconformance_packs TypeResource DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization. -Idaws.config.conformance_packs +Id ## Fields - - + +
NameDatatypeDescription
conformance_pack_namestringName of the conformance pack which will be assigned as the unique identifier.
regionstringAWS region.
stringName of the conformance pack which will be assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of conformance_packs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md index 5d53c4b992..b49c1dc874 100644 --- a/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md +++ b/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual organization_conformance_pack resource, use organization_conformance_packs to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual organization_conformance_pack res Nameorganization_conformance_pack TypeResource DescriptionResource schema for AWS::Config::OrganizationConformancePack. -Idaws.config.organization_conformance_pack +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
organization_conformance_pack_namestringThe name of the organization conformance pack.
template_s3_uristringLocation of file containing the template body.
template_bodystringA string containing full conformance pack template body.
delivery_s3_bucketstringAWS Config stores intermediate files while processing conformance pack template.
delivery_s3_key_prefixstringThe prefix for the delivery S3 bucket.
conformance_pack_input_parametersarrayA list of ConformancePackInputParameter objects.
excluded_accountsarrayA list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual organization_conformance_pack res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md index 5171af86b8..8e02f0a425 100644 --- a/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md +++ b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of organization_conformance_packs in a region or create a organization_conformance_packs resource, use organization_conformance_pack to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of organization_conformance_packs in a regi Nameorganization_conformance_packs TypeResource DescriptionResource schema for AWS::Config::OrganizationConformancePack. -Idaws.config.organization_conformance_packs +Id ## Fields - - + +
NameDatatypeDescription
organization_conformance_pack_namestringThe name of the organization conformance pack.
regionstringAWS region.
stringThe name of the organization conformance pack.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of organization_conformance_packs in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/stored_queries/index.md b/docs/aws-docs/providers/aws/config/stored_queries/index.md index 797b1e5299..13a54b1647 100644 --- a/docs/aws-docs/providers/aws/config/stored_queries/index.md +++ b/docs/aws-docs/providers/aws/config/stored_queries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stored_queries in a region or create a stored_queries resource, use stored_query to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stored_queries in a region or create a < Namestored_queries TypeResource DescriptionResource Type definition for AWS::Config::StoredQuery -Idaws.config.stored_queries +Id ## Fields - - + +
NameDatatypeDescription
query_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of stored_queries in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/config/stored_query/index.md b/docs/aws-docs/providers/aws/config/stored_query/index.md index 59a6d40e65..e8fa759dc9 100644 --- a/docs/aws-docs/providers/aws/config/stored_query/index.md +++ b/docs/aws-docs/providers/aws/config/stored_query/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stored_query resource, use stored_queries to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual stored_query resource, use Namestored_query TypeResource DescriptionResource Type definition for AWS::Config::StoredQuery -Idaws.config.stored_query +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
query_arnstring
query_idstring
query_namestring
query_descriptionstring
query_expressionstring
tagsarrayThe tags for the stored query.
regionstringAWS region.
string
string
string
string
string
arrayThe tags for the stored query.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual stored_query resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/approved_origin/index.md b/docs/aws-docs/providers/aws/connect/approved_origin/index.md index ad41c365a6..fae8a9bb73 100644 --- a/docs/aws-docs/providers/aws/connect/approved_origin/index.md +++ b/docs/aws-docs/providers/aws/connect/approved_origin/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual approved_origin resource, use approved_origins to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual approved_origin resource, use Nameapproved_origin TypeResource DescriptionResource Type definition for AWS::Connect::ApprovedOrigin -Idaws.connect.approved_origin +Id ## Fields - - - + + +
NameDatatypeDescription
originstring
instance_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual approved_origin resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/approved_origins/index.md b/docs/aws-docs/providers/aws/connect/approved_origins/index.md index 75cc8076d1..8a84f03ade 100644 --- a/docs/aws-docs/providers/aws/connect/approved_origins/index.md +++ b/docs/aws-docs/providers/aws/connect/approved_origins/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of approved_origins in a region or create a approved_origins resource, use approved_origin to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of approved_origins in a region or create a Nameapproved_origins TypeResource DescriptionResource Type definition for AWS::Connect::ApprovedOrigin -Idaws.connect.approved_origins +Id ## Fields - - - + + +
NameDatatypeDescription
instance_idundefined
originundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of approved_origins in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow/index.md b/docs/aws-docs/providers/aws/connect/contact_flow/index.md index b197082939..a64d70c0a4 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flow/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual contact_flow resource, use contact_flows to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual contact_flow resource, use Namecontact_flow TypeResource DescriptionResource Type definition for AWS::Connect::ContactFlow -Idaws.connect.contact_flow +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance (ARN).
contact_flow_arnstringThe identifier of the contact flow (ARN).
namestringThe name of the contact flow.
contentstringThe content of the contact flow in JSON format.
descriptionstringThe description of the contact flow.
statestringThe state of the contact flow.
typestringThe type of the contact flow.
tagsarrayOne or more tags.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual contact_flow resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md index df8d7eb61d..093af0a943 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual contact_flow_module resource, use contact_flow_modules to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual contact_flow_module resource, use Namecontact_flow_module TypeResource DescriptionResource Type definition for AWS::Connect::ContactFlowModule. -Idaws.connect.contact_flow_module +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance (ARN).
contact_flow_module_arnstringThe identifier of the contact flow module (ARN).
namestringThe name of the contact flow module.
contentstringThe content of the contact flow module in JSON format.
descriptionstringThe description of the contact flow module.
statestringThe state of the contact flow module.
statusstringThe status of the contact flow module.
tagsarrayOne or more tags.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual contact_flow_module resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md index fa9518b370..6aed222200 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of contact_flow_modules in a region or create a contact_flow_modules resource, use contact_flow_module to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of contact_flow_modules in a region or crea Namecontact_flow_modules TypeResource DescriptionResource Type definition for AWS::Connect::ContactFlowModule. -Idaws.connect.contact_flow_modules +Id ## Fields - - + +
NameDatatypeDescription
contact_flow_module_arnstringThe identifier of the contact flow module (ARN).
regionstringAWS region.
stringThe identifier of the contact flow module (ARN).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of contact_flow_modules in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/contact_flows/index.md b/docs/aws-docs/providers/aws/connect/contact_flows/index.md index 517428944b..62c9711d3d 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flows/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of contact_flows in a region or create a contact_flows resource, use contact_flow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of contact_flows in a region or create a Namecontact_flows TypeResource DescriptionResource Type definition for AWS::Connect::ContactFlow -Idaws.connect.contact_flows +Id ## Fields - - + +
NameDatatypeDescription
contact_flow_arnstringThe identifier of the contact flow (ARN).
regionstringAWS region.
stringThe identifier of the contact flow (ARN).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of contact_flows in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_form/index.md b/docs/aws-docs/providers/aws/connect/evaluation_form/index.md index 10003ed131..52cfcc7725 100644 --- a/docs/aws-docs/providers/aws/connect/evaluation_form/index.md +++ b/docs/aws-docs/providers/aws/connect/evaluation_form/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual evaluation_form resource, use evaluation_forms to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual evaluation_form resource, use Nameevaluation_form TypeResource DescriptionResource Type definition for AWS::Connect::EvaluationForm -Idaws.connect.evaluation_form +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
titlestringThe title of the evaluation form.
descriptionstringThe description of the evaluation form.
evaluation_form_arnstringThe Amazon Resource Name (ARN) for the evaluation form.
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
itemsarrayThe list of evaluation form items.
scoring_strategyobjectThe scoring strategy.
statusstringThe status of the evaluation form.
tagsarrayOne or more tags.
regionstringAWS region.
stringThe title of the evaluation form.
stringThe description of the evaluation form.
stringThe Amazon Resource Name (ARN) for the evaluation form.
stringThe Amazon Resource Name (ARN) of the instance.
arrayThe list of evaluation form items.
objectThe scoring strategy.
stringThe status of the evaluation form.
arrayOne or more tags.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual evaluation_form resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md index bdbfa19032..eacd2487f5 100644 --- a/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md +++ b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of evaluation_forms in a region or create a evaluation_forms resource, use evaluation_form to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of evaluation_forms in a region or create a Nameevaluation_forms TypeResource DescriptionResource Type definition for AWS::Connect::EvaluationForm -Idaws.connect.evaluation_forms +Id ## Fields - - + +
NameDatatypeDescription
evaluation_form_arnstringThe Amazon Resource Name (ARN) for the evaluation form.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the evaluation form.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of evaluation_forms in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md index c91bcfea41..0e10091b38 100644 --- a/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md +++ b/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hours_of_operation resource, use hours_of_operations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual hours_of_operation resource, use Namehours_of_operation TypeResource DescriptionResource Type definition for AWS::Connect::HoursOfOperation -Idaws.connect.hours_of_operation +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the hours of operation.
descriptionstringThe description of the hours of operation.
time_zonestringThe time zone of the hours of operation.
configarrayConfiguration information for the hours of operation: day, start time, and end time.
hours_of_operation_arnstringThe Amazon Resource Name (ARN) for the hours of operation.
tagsarrayOne or more tags.
regionstringAWS region.
stringThe identifier of the Amazon Connect instance.
stringThe name of the hours of operation.
stringThe description of the hours of operation.
stringThe time zone of the hours of operation.
arrayConfiguration information for the hours of operation: day, start time, and end time.
stringThe Amazon Resource Name (ARN) for the hours of operation.
arrayOne or more tags.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual hours_of_operation resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md index 3f7df7cb34..b077422833 100644 --- a/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md +++ b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hours_of_operations in a region or create a hours_of_operations resource, use hours_of_operation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hours_of_operations in a region or creat Namehours_of_operations TypeResource DescriptionResource Type definition for AWS::Connect::HoursOfOperation -Idaws.connect.hours_of_operations +Id ## Fields - - + +
NameDatatypeDescription
hours_of_operation_arnstringThe Amazon Resource Name (ARN) for the hours of operation.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the hours of operation.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hours_of_operations in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/instance/index.md b/docs/aws-docs/providers/aws/connect/instance/index.md index 9cb3f9eeac..a522310437 100644 --- a/docs/aws-docs/providers/aws/connect/instance/index.md +++ b/docs/aws-docs/providers/aws/connect/instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance resource, use instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual instance resource, use inst Nameinstance TypeResource DescriptionResource Type definition for AWS::Connect::Instance -Idaws.connect.instance +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
idstringAn instanceId is automatically generated on creation and assigned as the unique identifier.
arnstringAn instanceArn is automatically generated on creation based on instanceId.
identity_management_typestringSpecifies the type of directory integration for new instance.
instance_aliasstringAlias of the new directory created as part of new instance creation.
created_timestringTimestamp of instance creation logged as part of instance creation.
service_rolestringService linked role created as part of instance creation.
instance_statusstringSpecifies the creation status of new instance.
directory_idstringExisting directoryId user wants to map to the new Connect instance.
attributesobjectThe attributes for the instance.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual instance resource, use inst Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md index f0bb3af923..0e487e76fa 100644 --- a/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md +++ b/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance_storage_config resource, use instance_storage_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual instance_storage_config resource, Nameinstance_storage_config TypeResource DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig -Idaws.connect.instance_storage_config +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
instance_arnstringConnect Instance ID with which the storage config will be associated
resource_typestring
association_idstring
storage_typestring
s3_configobject
kinesis_video_stream_configobject
kinesis_stream_configobject
kinesis_firehose_configobject
regionstringAWS region.
stringConnect Instance ID with which the storage config will be associated
string
string
string
object
object
object
object
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual instance_storage_config resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md index a9d4981f20..17b7a2afae 100644 --- a/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md +++ b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instance_storage_configs in a region or create a instance_storage_configs resource, use instance_storage_config to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of instance_storage_configs in a region or Nameinstance_storage_configs TypeResource DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig -Idaws.connect.instance_storage_configs +Id ## Fields - - - - + + + +
NameDatatypeDescription
instance_arnstringConnect Instance ID with which the storage config will be associated
association_idundefined
resource_typeundefined
regionstringAWS region.
stringConnect Instance ID with which the storage config will be associated
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of instance_storage_configs in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/instances/index.md b/docs/aws-docs/providers/aws/connect/instances/index.md index 73b80aae09..6ede9f9fe9 100644 --- a/docs/aws-docs/providers/aws/connect/instances/index.md +++ b/docs/aws-docs/providers/aws/connect/instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instances in a region or create a instances resource, use instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instances in a region or create a Nameinstances TypeResource DescriptionResource Type definition for AWS::Connect::Instance -Idaws.connect.instances +Id ## Fields - - + +
NameDatatypeDescription
arnstringAn instanceArn is automatically generated on creation based on instanceId.
regionstringAWS region.
stringAn instanceArn is automatically generated on creation based on instanceId.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instances in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/integration_association/index.md b/docs/aws-docs/providers/aws/connect/integration_association/index.md index 2de7a4c4d8..8164d01e53 100644 --- a/docs/aws-docs/providers/aws/connect/integration_association/index.md +++ b/docs/aws-docs/providers/aws/connect/integration_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual integration_association resource, use integration_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual integration_association resource, Nameintegration_association TypeResource DescriptionResource Type definition for AWS::Connect::IntegrationAssociation -Idaws.connect.integration_association +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
integration_association_idstring
instance_idstring
integration_arnstring
integration_typestring
regionstringAWS region.
string
string
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual integration_association resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/integration_associations/index.md b/docs/aws-docs/providers/aws/connect/integration_associations/index.md index 8d8f3aeba2..c435043633 100644 --- a/docs/aws-docs/providers/aws/connect/integration_associations/index.md +++ b/docs/aws-docs/providers/aws/connect/integration_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of integration_associations in a region or create a integration_associations resource, use integration_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of integration_associations in a region or Nameintegration_associations TypeResource DescriptionResource Type definition for AWS::Connect::IntegrationAssociation -Idaws.connect.integration_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
instance_idundefined
integration_typeundefined
integration_arnundefined
regionstringAWS region.
undefined
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of integration_associations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md b/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md index 6c83c80375..39c960556e 100644 --- a/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md +++ b/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual predefined_attribute resource, use predefined_attributes to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual predefined_attribute resource, us Namepredefined_attribute TypeResource DescriptionResource Type definition for AWS::Connect::PredefinedAttribute -Idaws.connect.predefined_attribute +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the predefined attribute.
valuesobjectThe values of a predefined attribute.
last_modified_regionstringLast modified region.
last_modified_timenumberLast modified time.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual predefined_attribute resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md index de983dffd2..c1fd82671c 100644 --- a/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md +++ b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of predefined_attributes in a region or create a predefined_attributes resource, use predefined_attribute to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of predefined_attributes in a region or cre Namepredefined_attributes TypeResource DescriptionResource Type definition for AWS::Connect::PredefinedAttribute -Idaws.connect.predefined_attributes +Id ## Fields - - - + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the predefined attribute.
regionstringAWS region.
stringThe identifier of the Amazon Connect instance.
stringThe name of the predefined attribute.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of predefined_attributes in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/prompt/index.md b/docs/aws-docs/providers/aws/connect/prompt/index.md index 39a8cc3bdc..c42d449a8f 100644 --- a/docs/aws-docs/providers/aws/connect/prompt/index.md +++ b/docs/aws-docs/providers/aws/connect/prompt/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual prompt resource, use prompts to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual prompt resource, use prompt Nameprompt TypeResource DescriptionResource Type definition for AWS::Connect::Prompt -Idaws.connect.prompt +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the prompt.
descriptionstringThe description of the prompt.
s3_uristringS3 URI of the customer's audio file for creating prompts resource..
prompt_arnstringThe Amazon Resource Name (ARN) for the prompt.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual prompt resource, use prompt Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/prompts/index.md b/docs/aws-docs/providers/aws/connect/prompts/index.md index 15f7f227fe..0690603322 100644 --- a/docs/aws-docs/providers/aws/connect/prompts/index.md +++ b/docs/aws-docs/providers/aws/connect/prompts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of prompts in a region or create a prompts resource, use prompt to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of prompts in a region or create a pr Nameprompts TypeResource DescriptionResource Type definition for AWS::Connect::Prompt -Idaws.connect.prompts +Id ## Fields - - + +
NameDatatypeDescription
prompt_arnstringThe Amazon Resource Name (ARN) for the prompt.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the prompt.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of prompts in a region or create a pr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/queue/index.md b/docs/aws-docs/providers/aws/connect/queue/index.md index e1e61fb4f5..44d68b3211 100644 --- a/docs/aws-docs/providers/aws/connect/queue/index.md +++ b/docs/aws-docs/providers/aws/connect/queue/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue resource, use queues to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual queue resource, use queues< Namequeue TypeResource DescriptionResource Type definition for AWS::Connect::Queue -Idaws.connect.queue +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
descriptionstringThe description of the queue.
hours_of_operation_arnstringThe identifier for the hours of operation.
max_contactsintegerThe maximum number of contacts that can be in the queue before it is considered full.
namestringThe name of the queue.
outbound_caller_configobjectThe outbound caller ID name, number, and outbound whisper flow.
queue_arnstringThe Amazon Resource Name (ARN) for the queue.
statusstringThe status of the queue.
quick_connect_arnsarrayThe quick connects available to agents who are working the queue.
tagsarrayAn array of key-value pairs to apply to this resource.
typestringThe type of queue.
regionstringAWS region.
stringThe identifier of the Amazon Connect instance.
stringThe description of the queue.
stringThe identifier for the hours of operation.
integerThe maximum number of contacts that can be in the queue before it is considered full.
stringThe name of the queue.
objectThe outbound caller ID name, number, and outbound whisper flow.
stringThe Amazon Resource Name (ARN) for the queue.
stringThe status of the queue.
arrayThe quick connects available to agents who are working the queue.
arrayAn array of key-value pairs to apply to this resource.
stringThe type of queue.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual queue resource, use queues< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/queues/index.md b/docs/aws-docs/providers/aws/connect/queues/index.md index e9108312ac..b942456f49 100644 --- a/docs/aws-docs/providers/aws/connect/queues/index.md +++ b/docs/aws-docs/providers/aws/connect/queues/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queues in a region or create a queues resource, use queue to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of queues in a region or create a que Namequeues TypeResource DescriptionResource Type definition for AWS::Connect::Queue -Idaws.connect.queues +Id ## Fields - - + +
NameDatatypeDescription
queue_arnstringThe Amazon Resource Name (ARN) for the queue.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the queue.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of queues in a region or create a que Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/quick_connect/index.md b/docs/aws-docs/providers/aws/connect/quick_connect/index.md index 72792ef8e9..7efeaec3bc 100644 --- a/docs/aws-docs/providers/aws/connect/quick_connect/index.md +++ b/docs/aws-docs/providers/aws/connect/quick_connect/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual quick_connect resource, use quick_connects to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual quick_connect resource, use Namequick_connect TypeResource DescriptionResource Type definition for AWS::Connect::QuickConnect -Idaws.connect.quick_connect +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the quick connect.
descriptionstringThe description of the quick connect.
quick_connect_configobjectConfiguration settings for the quick connect.
quick_connect_arnstringThe Amazon Resource Name (ARN) for the quick connect.
tagsarrayOne or more tags.
quick_connect_typestringThe type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual quick_connect resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/quick_connects/index.md b/docs/aws-docs/providers/aws/connect/quick_connects/index.md index 980e989303..6dbb9734c2 100644 --- a/docs/aws-docs/providers/aws/connect/quick_connects/index.md +++ b/docs/aws-docs/providers/aws/connect/quick_connects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of quick_connects in a region or create a quick_connects resource, use quick_connect to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of quick_connects in a region or create a < Namequick_connects TypeResource DescriptionResource Type definition for AWS::Connect::QuickConnect -Idaws.connect.quick_connects +Id ## Fields - - + +
NameDatatypeDescription
quick_connect_arnstringThe Amazon Resource Name (ARN) for the quick connect.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the quick connect.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of quick_connects in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/routing_profile/index.md b/docs/aws-docs/providers/aws/connect/routing_profile/index.md index e91aad6afc..203f79f132 100644 --- a/docs/aws-docs/providers/aws/connect/routing_profile/index.md +++ b/docs/aws-docs/providers/aws/connect/routing_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual routing_profile resource, use routing_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual routing_profile resource, use Namerouting_profile TypeResource DescriptionResource Type definition for AWS::Connect::RoutingProfile -Idaws.connect.routing_profile +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the routing profile.
descriptionstringThe description of the routing profile.
media_concurrenciesarrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
default_outbound_queue_arnstringThe identifier of the default outbound queue for this routing profile.
routing_profile_arnstringThe Amazon Resource Name (ARN) of the routing profile.
queue_configsarrayThe queues to associate with this routing profile.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_availability_timerstringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual routing_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/routing_profiles/index.md b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md index ce8336f530..d6ff7d8543 100644 --- a/docs/aws-docs/providers/aws/connect/routing_profiles/index.md +++ b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of routing_profiles in a region or create a routing_profiles resource, use routing_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of routing_profiles in a region or create a Namerouting_profiles TypeResource DescriptionResource Type definition for AWS::Connect::RoutingProfile -Idaws.connect.routing_profiles +Id ## Fields - - + +
NameDatatypeDescription
routing_profile_arnstringThe Amazon Resource Name (ARN) of the routing profile.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the routing profile.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of routing_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/rule/index.md b/docs/aws-docs/providers/aws/connect/rule/index.md index b994da2db1..9c6a9296f3 100644 --- a/docs/aws-docs/providers/aws/connect/rule/index.md +++ b/docs/aws-docs/providers/aws/connect/rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule resource, use rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual rule resource, use rulesNamerule TypeResource DescriptionResource Type definition for AWS:Connect::Rule -Idaws.connect.rule +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name of the rule.
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
trigger_event_sourceobjectThe event source that triggers the rule.
functionstringThe conditions of a rule.
actionsobjectThe list of actions that will be executed when a rule is triggered.
publish_statusstringThe publish status of a rule, either draft or published.
tagsarrayOne or more tags.
regionstringAWS region.
stringThe name of the rule.
stringThe Amazon Resource Name (ARN) of the rule.
stringThe Amazon Resource Name (ARN) of the instance.
objectThe event source that triggers the rule.
stringThe conditions of a rule.
objectThe list of actions that will be executed when a rule is triggered.
stringThe publish status of a rule, either draft or published.
arrayOne or more tags.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual rule resource, use rulesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/rules/index.md b/docs/aws-docs/providers/aws/connect/rules/index.md index 556e671f04..3004687ec4 100644 --- a/docs/aws-docs/providers/aws/connect/rules/index.md +++ b/docs/aws-docs/providers/aws/connect/rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rules in a region or create a rules resource, use rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rules in a region or create a rule Namerules TypeResource DescriptionResource Type definition for AWS:Connect::Rule -Idaws.connect.rules +Id ## Fields - - + +
NameDatatypeDescription
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the rule.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rules in a region or create a rule Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/security_key/index.md b/docs/aws-docs/providers/aws/connect/security_key/index.md index 67126e18cd..f2555bd67f 100644 --- a/docs/aws-docs/providers/aws/connect/security_key/index.md +++ b/docs/aws-docs/providers/aws/connect/security_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_key resource, use security_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual security_key resource, use Namesecurity_key TypeResource DescriptionResource Type definition for AWS::Connect::SecurityKey -Idaws.connect.security_key +Id ## Fields - - - - + + + +
NameDatatypeDescription
keystring
instance_idstring
association_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual security_key resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/security_keys/index.md b/docs/aws-docs/providers/aws/connect/security_keys/index.md index 30f13c3f59..106ca198ec 100644 --- a/docs/aws-docs/providers/aws/connect/security_keys/index.md +++ b/docs/aws-docs/providers/aws/connect/security_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_keys in a region or create a security_keys resource, use security_key to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of security_keys in a region or create a Namesecurity_keys TypeResource DescriptionResource Type definition for AWS::Connect::SecurityKey -Idaws.connect.security_keys +Id ## Fields - - - + + +
NameDatatypeDescription
instance_idundefined
association_idundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of security_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/security_profile/index.md b/docs/aws-docs/providers/aws/connect/security_profile/index.md index de6f5aa7e4..b97a2e52c9 100644 --- a/docs/aws-docs/providers/aws/connect/security_profile/index.md +++ b/docs/aws-docs/providers/aws/connect/security_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_profile resource, use security_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual security_profile resource, use Namesecurity_profile TypeResource DescriptionResource Type definition for AWS::Connect::SecurityProfile -Idaws.connect.security_profile +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
allowed_access_control_tagsarrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
descriptionstringThe description of the security profile.
instance_arnstringThe identifier of the Amazon Connect instance.
permissionsarrayPermissions assigned to the security profile.
security_profile_arnstringThe Amazon Resource Name (ARN) for the security profile.
security_profile_namestringThe name of the security profile.
tag_restricted_resourcesarrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
hierarchy_restricted_resourcesarrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
allowed_access_control_hierarchy_group_idstringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
applicationsarrayA list of third-party applications that the security profile will give access to.
tagsarrayThe tags used to organize, track, or control access for this resource.
last_modified_regionstringThe AWS Region where this resource was last modified.
last_modified_timenumberThe timestamp when this resource was last modified.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual security_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/security_profiles/index.md b/docs/aws-docs/providers/aws/connect/security_profiles/index.md index 633c52375e..843b09b363 100644 --- a/docs/aws-docs/providers/aws/connect/security_profiles/index.md +++ b/docs/aws-docs/providers/aws/connect/security_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_profiles in a region or create a security_profiles resource, use security_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_profiles in a region or create Namesecurity_profiles TypeResource DescriptionResource Type definition for AWS::Connect::SecurityProfile -Idaws.connect.security_profiles +Id ## Fields - - + +
NameDatatypeDescription
security_profile_arnstringThe Amazon Resource Name (ARN) for the security profile.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the security profile.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_profiles in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/task_template/index.md b/docs/aws-docs/providers/aws/connect/task_template/index.md index c883d1e295..946f713769 100644 --- a/docs/aws-docs/providers/aws/connect/task_template/index.md +++ b/docs/aws-docs/providers/aws/connect/task_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual task_template resource, use task_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual task_template resource, use Nametask_template TypeResource DescriptionResource Type definition for AWS::Connect::TaskTemplate. -Idaws.connect.task_template +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe identifier (arn) of the task template.
instance_arnstringThe identifier (arn) of the instance.
namestringThe name of the task template.
descriptionstringThe description of the task template.
contact_flow_arnstringThe identifier of the contact flow.
constraintsobjectThe constraints for the task template
defaultsarray
fieldsarrayThe list of task template's fields
statusstring
client_tokenstring
tagsarrayOne or more tags.
regionstringAWS region.
stringThe identifier (arn) of the task template.
stringThe identifier (arn) of the instance.
stringThe name of the task template.
stringThe description of the task template.
stringThe identifier of the contact flow.
objectThe constraints for the task template
array
arrayThe list of task template's fields
string
string
arrayOne or more tags.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual task_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/task_templates/index.md b/docs/aws-docs/providers/aws/connect/task_templates/index.md index d187003bf3..be5952cced 100644 --- a/docs/aws-docs/providers/aws/connect/task_templates/index.md +++ b/docs/aws-docs/providers/aws/connect/task_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of task_templates in a region or create a task_templates resource, use task_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of task_templates in a region or create a < Nametask_templates TypeResource DescriptionResource Type definition for AWS::Connect::TaskTemplate. -Idaws.connect.task_templates +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe identifier (arn) of the task template.
regionstringAWS region.
stringThe identifier (arn) of the task template.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of task_templates in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md index ef9a9a8ec2..d01177ff79 100644 --- a/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual traffic_distribution_group resource, use traffic_distribution_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual traffic_distribution_group resour Nametraffic_distribution_group TypeResource DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup -Idaws.connect.traffic_distribution_group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance that has been replicated.
traffic_distribution_group_arnstringThe identifier of the traffic distribution group.
descriptionstringA description for the traffic distribution group.
namestringThe name for the traffic distribution group.
statusstringThe status of the traffic distribution group.
tagsarrayOne or more tags.
is_defaultbooleanIf this is the default traffic distribution group.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual traffic_distribution_group resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md index 3581acd2ce..d44cff682b 100644 --- a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of traffic_distribution_groups in a region or create a traffic_distribution_groups resource, use traffic_distribution_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of traffic_distribution_groups in a region Nametraffic_distribution_groups TypeResource DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup -Idaws.connect.traffic_distribution_groups +Id ## Fields - - + +
NameDatatypeDescription
traffic_distribution_group_arnstringThe identifier of the traffic distribution group.
regionstringAWS region.
stringThe identifier of the traffic distribution group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of traffic_distribution_groups in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/user/index.md b/docs/aws-docs/providers/aws/connect/user/index.md index 1ebd427fb4..1a3d13e589 100644 --- a/docs/aws-docs/providers/aws/connect/user/index.md +++ b/docs/aws-docs/providers/aws/connect/user/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user resource, use users to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual user resource, use usersNameuser TypeResource DescriptionResource Type definition for AWS::Connect::User -Idaws.connect.user +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
directory_user_idstringThe identifier of the user account in the directory used for identity management.
hierarchy_group_arnstringThe identifier of the hierarchy group for the user.
usernamestringThe user name for the account.
passwordstringThe password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
routing_profile_arnstringThe identifier of the routing profile for the user.
identity_infoobjectThe information about the identity of the user.
phone_configobjectThe phone settings for the user.
security_profile_arnsarrayOne or more security profile arns for the user
user_arnstringThe Amazon Resource Name (ARN) for the user.
tagsarrayOne or more tags.
user_proficienciesarrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual user resource, use usersRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md index d4032d7d98..e691c5da07 100644 --- a/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_hierarchy_group resource, use user_hierarchy_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual user_hierarchy_group resource, us Nameuser_hierarchy_group TypeResource DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup -Idaws.connect.user_hierarchy_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
user_hierarchy_group_arnstringThe Amazon Resource Name (ARN) for the user hierarchy group.
parent_group_arnstringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
namestringThe name of the user hierarchy group.
tagsarrayOne or more tags.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual user_hierarchy_group resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md index 82b84eb88a..d8dd53bf1e 100644 --- a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_hierarchy_groups in a region or create a user_hierarchy_groups resource, use user_hierarchy_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of user_hierarchy_groups in a region or cre Nameuser_hierarchy_groups TypeResource DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup -Idaws.connect.user_hierarchy_groups +Id ## Fields - - + +
NameDatatypeDescription
user_hierarchy_group_arnundefinedThe Amazon Resource Name (ARN) for the user hierarchy group.
regionstringAWS region.
undefinedThe Amazon Resource Name (ARN) for the user hierarchy group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of user_hierarchy_groups in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/users/index.md b/docs/aws-docs/providers/aws/connect/users/index.md index 3129142b7a..133bcbcf64 100644 --- a/docs/aws-docs/providers/aws/connect/users/index.md +++ b/docs/aws-docs/providers/aws/connect/users/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of users in a region or create a users resource, use user to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of users in a region or create a user Nameusers TypeResource DescriptionResource Type definition for AWS::Connect::User -Idaws.connect.users +Id ## Fields - - + +
NameDatatypeDescription
user_arnstringThe Amazon Resource Name (ARN) for the user.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) for the user.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of users in a region or create a user Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/view/index.md b/docs/aws-docs/providers/aws/connect/view/index.md index a60466554c..e69a45f5ac 100644 --- a/docs/aws-docs/providers/aws/connect/view/index.md +++ b/docs/aws-docs/providers/aws/connect/view/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual view resource, use views to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual view resource, use viewsNameview TypeResource DescriptionResource Type definition for AWS::Connect::View -Idaws.connect.view +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
view_arnstringThe Amazon Resource Name (ARN) of the view.
view_idstringThe view id of the view.
namestringThe name of the view.
descriptionstringThe description of the view.
templateobjectThe template of the view as JSON.
actionsarrayThe actions of the view in an array.
view_content_sha256stringThe view content hash.
tagsarrayOne or more tags.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual view resource, use viewsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/view_version/index.md b/docs/aws-docs/providers/aws/connect/view_version/index.md index 1c8cea283f..d0ba446d29 100644 --- a/docs/aws-docs/providers/aws/connect/view_version/index.md +++ b/docs/aws-docs/providers/aws/connect/view_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual view_version resource, use view_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual view_version resource, use Nameview_version TypeResource DescriptionResource Type definition for AWS::Connect::ViewVersion -Idaws.connect.view_version +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
view_arnstringThe Amazon Resource Name (ARN) of the view for which a version is being created.
view_version_arnstringThe Amazon Resource Name (ARN) of the created view version.
version_descriptionstringThe description for the view version.
view_content_sha256stringThe view content hash to be checked.
versionintegerThe version of the view.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual view_version resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connect/view_versions/index.md b/docs/aws-docs/providers/aws/connect/view_versions/index.md index 50e52c5881..23dcb46f63 100644 --- a/docs/aws-docs/providers/aws/connect/view_versions/index.md +++ b/docs/aws-docs/providers/aws/connect/view_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of view_versions in a region or create a view_versions resource, use view_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of view_versions in a region or create a Nameview_versions TypeResource DescriptionResource Type definition for AWS::Connect::ViewVersion -Idaws.connect.view_versions +Id ## Fields - - + +
NameDatatypeDescription
view_version_arnstringThe Amazon Resource Name (ARN) of the created view version.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the created view version.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of view_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connect/views/index.md b/docs/aws-docs/providers/aws/connect/views/index.md index db6a5cf1be..472014513c 100644 --- a/docs/aws-docs/providers/aws/connect/views/index.md +++ b/docs/aws-docs/providers/aws/connect/views/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of views in a region or create a views resource, use view to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of views in a region or create a view Nameviews TypeResource DescriptionResource Type definition for AWS::Connect::View -Idaws.connect.views +Id ## Fields - - + +
NameDatatypeDescription
view_arnstringThe Amazon Resource Name (ARN) of the view.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the view.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of views in a region or create a view Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md index d331169ec2..da49c99982 100644 --- a/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual campaign resource, use campaigns to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual campaign resource, use camp Namecampaign TypeResource DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type -Idaws.connectcampaigns.campaign +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
connect_instance_arnstringAmazon Connect Instance Arn
dialer_configobject
arnstringAmazon Connect Campaign Arn
namestringAmazon Connect Campaign Name
outbound_call_configobject
tagsarrayOne or more tags.
regionstringAWS region.
stringAmazon Connect Instance Arn
object
stringAmazon Connect Campaign Arn
stringAmazon Connect Campaign Name
object
arrayOne or more tags.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual campaign resource, use camp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md index 58682f433f..06b660176f 100644 --- a/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of campaigns in a region or create a campaigns resource, use campaign to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of campaigns in a region or create a Namecampaigns TypeResource DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type -Idaws.connectcampaigns.campaigns +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Connect Campaign Arn
regionstringAWS region.
stringAmazon Connect Campaign Arn
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of campaigns in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md index 11f65e6547..a6a996a221 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual enabled_baseline resource, use enabled_baselines to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual enabled_baseline resource, use Nameenabled_baseline TypeResource DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type -Idaws.controltower.enabled_baseline +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
baseline_identifierstring
baseline_versionstring
enabled_baseline_identifierstring
target_identifierstring
parametersarray
tagsarray
regionstringAWS region.
string
string
string
string
array
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual enabled_baseline resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md index 7364608766..98cdb3da71 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of enabled_baselines in a region or create a enabled_baselines resource, use enabled_baseline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of enabled_baselines in a region or create Nameenabled_baselines TypeResource DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type -Idaws.controltower.enabled_baselines +Id ## Fields - - + +
NameDatatypeDescription
enabled_baseline_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of enabled_baselines in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_control/index.md b/docs/aws-docs/providers/aws/controltower/enabled_control/index.md index a34638c874..a92c0de42f 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_control/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_control/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual enabled_control resource, use enabled_controls to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual enabled_control resource, use Nameenabled_control TypeResource DescriptionEnables a control on a specified target. -Idaws.controltower.enabled_control +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
control_identifierstringArn of the control.
target_identifierstringArn for Organizational unit to which the control needs to be applied
parametersarrayParameters to configure the enabled control behavior.
tagsarrayA set of tags to assign to the enabled control.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual enabled_control resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md index e97bea566d..c1a31935ab 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of enabled_controls in a region or create a enabled_controls resource, use enabled_control to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of enabled_controls in a region or create a Nameenabled_controls TypeResource DescriptionEnables a control on a specified target. -Idaws.controltower.enabled_controls +Id ## Fields - - - + + +
NameDatatypeDescription
target_identifierstringArn for Organizational unit to which the control needs to be applied
control_identifierstringArn of the control.
regionstringAWS region.
stringArn for Organizational unit to which the control needs to be applied
stringArn of the control.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of enabled_controls in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/controltower/landing_zone/index.md b/docs/aws-docs/providers/aws/controltower/landing_zone/index.md index 41bcd36a3a..1fb801ae5d 100644 --- a/docs/aws-docs/providers/aws/controltower/landing_zone/index.md +++ b/docs/aws-docs/providers/aws/controltower/landing_zone/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual landing_zone resource, use landing_zones to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual landing_zone resource, use Namelanding_zone TypeResource DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type -Idaws.controltower.landing_zone +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
landing_zone_identifierstring
arnstring
statusstring
latest_available_versionstring
drift_statusstring
manifestundefined
versionstring
tagsarray
regionstringAWS region.
string
string
string
string
string
undefined
string
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual landing_zone resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/controltower/landing_zones/index.md b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md index a98967dfea..448bfe7550 100644 --- a/docs/aws-docs/providers/aws/controltower/landing_zones/index.md +++ b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of landing_zones in a region or create a landing_zones resource, use landing_zone to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of landing_zones in a region or create a Namelanding_zones TypeResource DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type -Idaws.controltower.landing_zones +Id ## Fields - - + +
NameDatatypeDescription
landing_zone_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of landing_zones in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/cur/report_definition/index.md b/docs/aws-docs/providers/aws/cur/report_definition/index.md index 67c6f49299..02f6380033 100644 --- a/docs/aws-docs/providers/aws/cur/report_definition/index.md +++ b/docs/aws-docs/providers/aws/cur/report_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual report_definition resource, use report_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual report_definition resource, use < Namereport_definition TypeResource DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports. -Idaws.cur.report_definition +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
report_namestringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
time_unitstringThe granularity of the line items in the report.
formatstringThe format that AWS saves the report in.
compressionstringThe compression format that AWS uses for the report.
additional_schema_elementsarrayA list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
s3_bucketstringThe S3 bucket where AWS delivers the report.
s3_prefixstringThe prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.
s3_regionstringThe region of the S3 bucket that AWS delivers the report into.
additional_artifactsarrayA list of manifests that you want Amazon Web Services to create for this report.
refresh_closed_reportsbooleanWhether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.
report_versioningstringWhether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
billing_view_arnstringThe Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual report_definition resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/cur/report_definitions/index.md b/docs/aws-docs/providers/aws/cur/report_definitions/index.md index cc4145590a..29a26c73c0 100644 --- a/docs/aws-docs/providers/aws/cur/report_definitions/index.md +++ b/docs/aws-docs/providers/aws/cur/report_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of report_definitions in a region or create a report_definitions resource, use report_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of report_definitions in a region or create Namereport_definitions TypeResource DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports. -Idaws.cur.report_definitions +Id ## Fields - - + +
NameDatatypeDescription
report_namestringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of report_definitions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md index 66912102cc..ba68ab8d40 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual calculated_attribute_definition resource, use calculated_attribute_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual calculated_attribute_definition r Namecalculated_attribute_definition TypeResource DescriptionA calculated attribute definition for Customer Profiles -Idaws.customerprofiles.calculated_attribute_definition +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
domain_namestring
calculated_attribute_namestring
display_namestring
descriptionstring
attribute_detailsobject
conditionsobject
statisticstring
created_atstringThe timestamp of when the calculated attribute definition was created.
last_updated_atstringThe timestamp of when the calculated attribute definition was most recently edited.
tagsarray
regionstringAWS region.
string
string
string
string
object
object
string
stringThe timestamp of when the calculated attribute definition was created.
stringThe timestamp of when the calculated attribute definition was most recently edited.
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual calculated_attribute_definition r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md index 1f198a565f..0f200281b1 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of calculated_attribute_definitions in a region or create a calculated_attribute_definitions resource, use calculated_attribute_definition to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of calculated_attribute_definitions in a re Namecalculated_attribute_definitions TypeResource DescriptionA calculated attribute definition for Customer Profiles -Idaws.customerprofiles.calculated_attribute_definitions +Id ## Fields - - - + + +
NameDatatypeDescription
domain_nameundefined
calculated_attribute_nameundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of calculated_attribute_definitions in a re Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domain/index.md b/docs/aws-docs/providers/aws/customerprofiles/domain/index.md index d1647c1d41..1f5151f3e5 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/domain/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionA domain defined for 3rd party data source in Profile Service -Idaws.customerprofiles.domain +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
dead_letter_queue_urlstringThe URL of the SQS dead letter queue
default_encryption_keystringThe default encryption key
default_expiration_daysintegerThe default number of days until the data within the domain expires.
matchingobject
rule_based_matchingobject
statsobject
tagsarrayThe tags (keys and values) associated with the domain
created_atstringThe time of this integration got created
last_updated_atstringThe time of this integration got last updated at
regionstringAWS region.
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.
object
object
object
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domains/index.md b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md index b5fe1e033c..39d9a93b7a 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/domains/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionA domain defined for 3rd party data source in Profile Service -Idaws.customerprofiles.domains +Id ## Fields - - + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
regionstringAWS region.
stringThe unique name of the domain.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md index 62ae078195..82b2834d9f 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_stream resource, use event_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual event_stream resource, use Nameevent_stream TypeResource DescriptionAn Event Stream resource of Amazon Connect Customer Profiles -Idaws.customerprofiles.event_stream +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
event_stream_namestringThe name of the event stream.
uristring
event_stream_arnstringA unique identifier for the event stream.
tagsarrayThe tags used to organize, track, or control access for this resource.
created_atstringThe timestamp of when the export was created.
statestringThe operational state of destination stream for export.
destination_detailsobjectDetails regarding the Kinesis stream.
regionstringAWS region.
stringThe unique name of the domain.
stringThe name of the event stream.
string
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual event_stream resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md index 98d1937cad..58fe2a5dd5 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_streams in a region or create a event_streams resource, use event_stream to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of event_streams in a region or create a Nameevent_streams TypeResource DescriptionAn Event Stream resource of Amazon Connect Customer Profiles -Idaws.customerprofiles.event_streams +Id ## Fields - - - + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
event_stream_namestringThe name of the event stream.
regionstringAWS region.
stringThe unique name of the domain.
stringThe name of the event stream.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of event_streams in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/integration/index.md b/docs/aws-docs/providers/aws/customerprofiles/integration/index.md index 4477a9766f..50b6f724bd 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/integration/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/integration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual integration resource, use integrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual integration resource, use i Nameintegration TypeResource DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration. -Idaws.customerprofiles.integration +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
uristringThe URI of the S3 bucket or any other type of data source.
flow_definitionobject
object_type_namestringThe name of the ObjectType defined for the 3rd party data in Profile Service
created_atstringThe time of this integration got created
last_updated_atstringThe time of this integration got last updated at
tagsarrayThe tags (keys and values) associated with the integration
object_type_namesarrayThe mapping between 3rd party event types and ObjectType names
regionstringAWS region.
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
object
stringThe name of the ObjectType defined for the 3rd party data in Profile Service
stringThe time of this integration got created
stringThe time of this integration got last updated at
arrayThe tags (keys and values) associated with the integration
arrayThe mapping between 3rd party event types and ObjectType names
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual integration resource, use i Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md index 0b97befd13..14c2463a8d 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of integrations in a region or create a integrations resource, use integration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of integrations in a region or create a Nameintegrations TypeResource DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration. -Idaws.customerprofiles.integrations +Id ## Fields - - - + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
uristringThe URI of the S3 bucket or any other type of data source.
regionstringAWS region.
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of integrations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md index c03927828d..6e4796af7e 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual object_type resource, use object_types to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual object_type resource, use o Nameobject_type TypeResource DescriptionAn ObjectType resource of Amazon Connect Customer Profiles -Idaws.customerprofiles.object_type +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
object_type_namestringThe name of the profile object type.
allow_profile_creationbooleanIndicates whether a profile should be created when data is received.
descriptionstringDescription of the profile object type.
encryption_keystringThe default encryption key
expiration_daysintegerThe default number of days until the data within the domain expires.
fieldsarrayA list of the name and ObjectType field.
keysarrayA list of unique keys that can be used to map data to the profile.
created_atstringThe time of this integration got created.
last_updated_atstringThe time of this integration got last updated at.
source_last_updated_timestamp_formatstringThe format of your sourceLastUpdatedTimestamp that was previously set up.
tagsarrayThe tags (keys and values) associated with the integration.
template_idstringA unique identifier for the object template.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual object_type resource, use o Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md index b6ea688869..13c804a1a5 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of object_types in a region or create a object_types resource, use object_type to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of object_types in a region or create a Nameobject_types TypeResource DescriptionAn ObjectType resource of Amazon Connect Customer Profiles -Idaws.customerprofiles.object_types +Id ## Fields - - - + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
object_type_namestringThe name of the profile object type.
regionstringAWS region.
stringThe unique name of the domain.
stringThe name of the profile object type.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of object_types in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/dataset/index.md b/docs/aws-docs/providers/aws/databrew/dataset/index.md index 891dd39173..35e934c5e9 100644 --- a/docs/aws-docs/providers/aws/databrew/dataset/index.md +++ b/docs/aws-docs/providers/aws/databrew/dataset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset resource, use datasets to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual dataset resource, use datas Namedataset TypeResource DescriptionResource schema for AWS::DataBrew::Dataset. -Idaws.databrew.dataset +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringDataset name
formatstringDataset format
format_optionsobjectFormat options for dataset
inputobjectInput
path_optionsobjectPathOptions
tagsarray
regionstringAWS region.
stringDataset name
stringDataset format
objectFormat options for dataset
objectInput
objectPathOptions
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual dataset resource, use datas Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/datasets/index.md b/docs/aws-docs/providers/aws/databrew/datasets/index.md index 759757f628..9ffb536a31 100644 --- a/docs/aws-docs/providers/aws/databrew/datasets/index.md +++ b/docs/aws-docs/providers/aws/databrew/datasets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of datasets in a region or create a datasets resource, use dataset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of datasets in a region or create a d Namedatasets TypeResource DescriptionResource schema for AWS::DataBrew::Dataset. -Idaws.databrew.datasets +Id ## Fields - - + +
NameDatatypeDescription
namestringDataset name
regionstringAWS region.
stringDataset name
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of datasets in a region or create a d Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/job/index.md b/docs/aws-docs/providers/aws/databrew/job/index.md index 4aab407777..ec132e9d48 100644 --- a/docs/aws-docs/providers/aws/databrew/job/index.md +++ b/docs/aws-docs/providers/aws/databrew/job/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual job resource, use jobs to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual job resource, use jobsNamejob TypeResource DescriptionResource schema for AWS::DataBrew::Job. -Idaws.databrew.job +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
dataset_namestringDataset name
encryption_key_arnstringEncryption Key Arn
encryption_modestringEncryption mode
namestringJob name
typestringJob type
log_subscriptionstringLog subscription
max_capacityintegerMax capacity
max_retriesintegerMax retries
outputsarray
data_catalog_outputsarray
database_outputsarray
output_locationobjectOutput location
project_namestringProject name
recipeobject
role_arnstringRole arn
tagsarray
timeoutintegerTimeout
job_sampleobjectJob Sample
profile_configurationobjectProfile Job configuration
validation_configurationsarrayData quality rules configuration
regionstringAWS region.
stringDataset name
stringEncryption Key Arn
stringEncryption mode
stringJob name
stringJob type
stringLog subscription
integerMax capacity
integerMax retries
array
array
array
objectOutput location
stringProject name
object
stringRole arn
array
integerTimeout
objectJob Sample
objectProfile Job configuration
arrayData quality rules configuration
stringAWS region.
@@ -60,19 +63,19 @@ Gets or operates on an individual job resource, use jobsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/jobs/index.md b/docs/aws-docs/providers/aws/databrew/jobs/index.md index 952bc3a356..35d8d0ea68 100644 --- a/docs/aws-docs/providers/aws/databrew/jobs/index.md +++ b/docs/aws-docs/providers/aws/databrew/jobs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of jobs in a region or create a jobs resource, use job to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of jobs in a region or create a jobs< Namejobs TypeResource DescriptionResource schema for AWS::DataBrew::Job. -Idaws.databrew.jobs +Id ## Fields - - + +
NameDatatypeDescription
namestringJob name
regionstringAWS region.
stringJob name
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of jobs in a region or create a jobs< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/project/index.md b/docs/aws-docs/providers/aws/databrew/project/index.md index c3eacb5e9e..9b8c5e67ef 100644 --- a/docs/aws-docs/providers/aws/databrew/project/index.md +++ b/docs/aws-docs/providers/aws/databrew/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionResource schema for AWS::DataBrew::Project. -Idaws.databrew.project +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
dataset_namestringDataset name
namestringProject name
recipe_namestringRecipe name
role_arnstringRole arn
sampleobjectSample
tagsarray
regionstringAWS region.
stringDataset name
stringProject name
stringRecipe name
stringRole arn
objectSample
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/projects/index.md b/docs/aws-docs/providers/aws/databrew/projects/index.md index e1cac3fb12..685ef02b7b 100644 --- a/docs/aws-docs/providers/aws/databrew/projects/index.md +++ b/docs/aws-docs/providers/aws/databrew/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionResource schema for AWS::DataBrew::Project. -Idaws.databrew.projects +Id ## Fields - - + +
NameDatatypeDescription
namestringProject name
regionstringAWS region.
stringProject name
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/recipe/index.md b/docs/aws-docs/providers/aws/databrew/recipe/index.md index d231c71316..b1ef090a5a 100644 --- a/docs/aws-docs/providers/aws/databrew/recipe/index.md +++ b/docs/aws-docs/providers/aws/databrew/recipe/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual recipe resource, use recipes to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual recipe resource, use recipe Namerecipe TypeResource DescriptionResource schema for AWS::DataBrew::Recipe. -Idaws.databrew.recipe +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringDescription of the recipe
namestringRecipe name
stepsarray
tagsarray
regionstringAWS region.
stringDescription of the recipe
stringRecipe name
array
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual recipe resource, use recipe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/recipes/index.md b/docs/aws-docs/providers/aws/databrew/recipes/index.md index 143a72c22b..c41125e81c 100644 --- a/docs/aws-docs/providers/aws/databrew/recipes/index.md +++ b/docs/aws-docs/providers/aws/databrew/recipes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of recipes in a region or create a recipes resource, use recipe to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of recipes in a region or create a re Namerecipes TypeResource DescriptionResource schema for AWS::DataBrew::Recipe. -Idaws.databrew.recipes +Id ## Fields - - + +
NameDatatypeDescription
namestringRecipe name
regionstringAWS region.
stringRecipe name
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of recipes in a region or create a re Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/ruleset/index.md b/docs/aws-docs/providers/aws/databrew/ruleset/index.md index d805d71860..aec48b9641 100644 --- a/docs/aws-docs/providers/aws/databrew/ruleset/index.md +++ b/docs/aws-docs/providers/aws/databrew/ruleset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ruleset resource, use rulesets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual ruleset resource, use rules Nameruleset TypeResource DescriptionResource schema for AWS::DataBrew::Ruleset. -Idaws.databrew.ruleset +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringName of the Ruleset
descriptionstringDescription of the Ruleset
target_arnstringArn of the target resource (dataset) to apply the ruleset to
rulesarrayList of the data quality rules in the ruleset
tagsarray
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual ruleset resource, use rules Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/rulesets/index.md b/docs/aws-docs/providers/aws/databrew/rulesets/index.md index ce6c0263b2..6a6e642fd6 100644 --- a/docs/aws-docs/providers/aws/databrew/rulesets/index.md +++ b/docs/aws-docs/providers/aws/databrew/rulesets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rulesets in a region or create a rulesets resource, use ruleset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rulesets in a region or create a r Namerulesets TypeResource DescriptionResource schema for AWS::DataBrew::Ruleset. -Idaws.databrew.rulesets +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the Ruleset
regionstringAWS region.
stringName of the Ruleset
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rulesets in a region or create a r Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/databrew/schedule/index.md b/docs/aws-docs/providers/aws/databrew/schedule/index.md index 29c680c215..cab77cd264 100644 --- a/docs/aws-docs/providers/aws/databrew/schedule/index.md +++ b/docs/aws-docs/providers/aws/databrew/schedule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schedule resource, use schedules to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual schedule resource, use sche Nameschedule TypeResource DescriptionResource schema for AWS::DataBrew::Schedule. -Idaws.databrew.schedule +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
job_namesarray
cron_expressionstringSchedule cron
namestringSchedule Name
tagsarray
regionstringAWS region.
array
stringSchedule cron
stringSchedule Name
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual schedule resource, use sche Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/databrew/schedules/index.md b/docs/aws-docs/providers/aws/databrew/schedules/index.md index 6dccab2fd6..7b1a8d30b9 100644 --- a/docs/aws-docs/providers/aws/databrew/schedules/index.md +++ b/docs/aws-docs/providers/aws/databrew/schedules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schedules in a region or create a schedules resource, use schedule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schedules in a region or create a Nameschedules TypeResource DescriptionResource schema for AWS::DataBrew::Schedule. -Idaws.databrew.schedules +Id ## Fields - - + +
NameDatatypeDescription
namestringSchedule Name
regionstringAWS region.
stringSchedule Name
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schedules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md b/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md index decfb00695..af692ad800 100644 --- a/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md +++ b/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pipeline resource, use pipelines to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual pipeline resource, use pipe Namepipeline TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.datapipeline.pipeline +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
activatebooleanIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
descriptionstringA description of the pipeline.
namestringThe name of the pipeline.
parameter_objectsarrayThe parameter objects used with the pipeline.
parameter_valuesarrayThe parameter values used with the pipeline.
pipeline_objectsarrayThe objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
pipeline_tagsarrayA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
pipeline_idstring
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual pipeline resource, use pipe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md index d84017b4e2..0415c3711e 100644 --- a/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md +++ b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pipelines in a region or create a pipelines resource, use pipeline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pipelines in a region or create a Namepipelines TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.datapipeline.pipelines +Id ## Fields - - + +
NameDatatypeDescription
pipeline_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pipelines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/agent/index.md b/docs/aws-docs/providers/aws/datasync/agent/index.md index 3b61f886bc..9c0be765f7 100644 --- a/docs/aws-docs/providers/aws/datasync/agent/index.md +++ b/docs/aws-docs/providers/aws/datasync/agent/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual agent resource, use agents to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual agent resource, use agents< Nameagent TypeResource DescriptionResource schema for AWS::DataSync::Agent. -Idaws.datasync.agent +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
agent_namestringThe name configured for the agent. Text reference used to identify the agent in the console.
activation_keystringActivation key of the Agent.
security_group_arnsarrayThe ARNs of the security group used to protect your data transfer task subnets.
subnet_arnsarrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
vpc_endpoint_idstringThe ID of the VPC endpoint that the agent has access to.
endpoint_typestringThe service endpoints that the agent will connect to.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual agent resource, use agents< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/agents/index.md b/docs/aws-docs/providers/aws/datasync/agents/index.md index 133fcd180b..745481e88a 100644 --- a/docs/aws-docs/providers/aws/datasync/agents/index.md +++ b/docs/aws-docs/providers/aws/datasync/agents/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of agents in a region or create a agents resource, use agent to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of agents in a region or create a age Nameagents TypeResource DescriptionResource schema for AWS::DataSync::Agent. -Idaws.datasync.agents +Id ## Fields - - + +
NameDatatypeDescription
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.
stringThe DataSync Agent ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of agents in a region or create a age Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md index bcb2c54648..ee81f20ca8 100644 --- a/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_azure_blob resource, use location_azure_blobs to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual location_azure_blob resource, use Namelocation_azure_blob TypeResource DescriptionResource schema for AWS::DataSync::LocationAzureBlob. -Idaws.datasync.location_azure_blob +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
agent_arnsarrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
azure_blob_authentication_typestringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
azure_blob_sas_configurationobject
azure_blob_container_urlstringThe URL of the Azure Blob container that was described.
azure_blob_typestringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
azure_access_tierstringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
subdirectorystringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
location_uristringThe URL of the Azure Blob Location that was described.
regionstringAWS region.
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.
object
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual location_azure_blob resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md index 6a27895a6c..df87b9e248 100644 --- a/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of location_azure_blobs in a region or create a location_azure_blobs resource, use location_azure_blob to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of location_azure_blobs in a region or crea Namelocation_azure_blobs TypeResource DescriptionResource schema for AWS::DataSync::LocationAzureBlob. -Idaws.datasync.location_azure_blobs +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of location_azure_blobs in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/location_efs/index.md b/docs/aws-docs/providers/aws/datasync/location_efs/index.md index 08a4a8c162..a44076ba06 100644 --- a/docs/aws-docs/providers/aws/datasync/location_efs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_efs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_efs resource, use location_efs to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual location_efs resource, use Namelocation_efs TypeResource DescriptionResource schema for AWS::DataSync::LocationEFS. -Idaws.datasync.location_efs +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
ec2_configobject
efs_filesystem_arnstringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
access_point_arnstringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
file_system_access_role_arnstringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
in_transit_encryptionstringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
subdirectorystringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
location_uristringThe URL of the EFS location that was described.
regionstringAWS region.
object
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual location_efs resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md index 8530501fdc..b036bf3df2 100644 --- a/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_hdfs resource, use location_hdfs to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual location_hdfs resource, use Namelocation_hdfs TypeResource DescriptionResource schema for AWS::DataSync::LocationHDFS. -Idaws.datasync.location_hdfs +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
name_nodesarrayAn array of Name Node(s) of the HDFS location.
block_sizeintegerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
replication_factorintegerNumber of copies of each block that exists inside the HDFS cluster.
kms_key_provider_uristringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
qop_configurationobject
authentication_typestringThe authentication mode used to determine identity of user.
simple_userstringThe user name that has read and write permissions on the specified HDFS cluster.
kerberos_principalstringThe unique identity, or principal, to which Kerberos can assign tickets.
kerberos_keytabstringThe Base64 string representation of the Keytab file.
kerberos_krb5_confstringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_arnsarrayARN(s) of the agent(s) to use for an HDFS location.
subdirectorystringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
location_arnstringThe Amazon Resource Name (ARN) of the HDFS location.
location_uristringThe URL of the HDFS location that was described.
regionstringAWS region.
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.
object
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual location_hdfs resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_nfs/index.md b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md index 4ec00b48d2..dfad6970b0 100644 --- a/docs/aws-docs/providers/aws/datasync/location_nfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_nfs resource, use location_nfs to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual location_nfs resource, use Namelocation_nfs TypeResource DescriptionResource schema for AWS::DataSync::LocationNFS -Idaws.datasync.location_nfs +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
mount_optionsobject
on_prem_configobject
server_hostnamestringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
subdirectorystringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the NFS location.
location_uristringThe URL of the NFS location that was described.
regionstringAWS region.
object
object
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual location_nfs resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md index a844486e2f..8c0485d34e 100644 --- a/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_object_storage resource, use location_object_storages to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual location_object_storage resource, Namelocation_object_storage TypeResource DescriptionResource schema for AWS::DataSync::LocationObjectStorage. -Idaws.datasync.location_object_storage +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
access_keystringOptional. The access key is used if credentials are required to access the self-managed object storage server.
agent_arnsarrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
bucket_namestringThe name of the bucket on the self-managed object storage server.
secret_keystringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
server_certificatestringX.509 PEM content containing a certificate authority or chain to trust.
server_hostnamestringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
server_portintegerThe port that your self-managed server accepts inbound network traffic on.
server_protocolstringThe protocol that the object storage server uses to communicate.
subdirectorystringThe subdirectory in the self-managed object storage server that is used to read data from.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the location that is created.
location_uristringThe URL of the object storage location that was described.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual location_object_storage resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md index e759ca1b38..9e4a6facdf 100644 --- a/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of location_object_storages in a region or create a location_object_storages resource, use location_object_storage to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of location_object_storages in a region or Namelocation_object_storages TypeResource DescriptionResource schema for AWS::DataSync::LocationObjectStorage. -Idaws.datasync.location_object_storages +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the location that is created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the location that is created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of location_object_storages in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3/index.md b/docs/aws-docs/providers/aws/datasync/location_s3/index.md index c2e68fa290..0515ee44b8 100644 --- a/docs/aws-docs/providers/aws/datasync/location_s3/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_s3/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_s3 resource, use location_s3s to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual location_s3 resource, use l Namelocation_s3 TypeResource DescriptionResource schema for AWS::DataSync::LocationS3 -Idaws.datasync.location_s3 +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
s3_configobject
s3_bucket_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
subdirectorystringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
s3_storage_classstringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
location_uristringThe URL of the S3 location that was described.
regionstringAWS region.
object
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual location_s3 resource, use l Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3s/index.md b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md index aad48a5abc..c09694b526 100644 --- a/docs/aws-docs/providers/aws/datasync/location_s3s/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of location_s3s in a region or create a location_s3s resource, use location_s3 to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of location_s3s in a region or create a Namelocation_s3s TypeResource DescriptionResource schema for AWS::DataSync::LocationS3 -Idaws.datasync.location_s3s +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of location_s3s in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/location_smb/index.md b/docs/aws-docs/providers/aws/datasync/location_smb/index.md index c4c07183d8..fba3a6d3cf 100644 --- a/docs/aws-docs/providers/aws/datasync/location_smb/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_smb/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location_smb resource, use location_smbs to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual location_smb resource, use Namelocation_smb TypeResource DescriptionResource schema for AWS::DataSync::LocationSMB. -Idaws.datasync.location_smb +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
agent_arnsarrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
domainstringThe name of the Windows domain that the SMB server belongs to.
mount_optionsobject
passwordstringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
server_hostnamestringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
subdirectorystringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
userstringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
location_uristringThe URL of the SMB location that was described.
regionstringAWS region.
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.
object
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual location_smb resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/location_smbs/index.md b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md index 49960dd97a..5f5faef4cf 100644 --- a/docs/aws-docs/providers/aws/datasync/location_smbs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of location_smbs in a region or create a location_smbs resource, use location_smb to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of location_smbs in a region or create a Namelocation_smbs TypeResource DescriptionResource schema for AWS::DataSync::LocationSMB. -Idaws.datasync.location_smbs +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of location_smbs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md index 9c4c7d3dac..b4f43e86eb 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual locationf_sx_lustre resource, use locationf_sx_lustres to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual locationf_sx_lustre resource, use Namelocationf_sx_lustre TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxLustre. -Idaws.datasync.locationf_sx_lustre +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
location_uristringThe URL of the FSx for Lustre location that was described.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual locationf_sx_lustre resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md index 76d14385af..02e2339c55 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of locationf_sx_lustres in a region or create a locationf_sx_lustres resource, use locationf_sx_lustre to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of locationf_sx_lustres in a region or crea Namelocationf_sx_lustres TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxLustre. -Idaws.datasync.locationf_sx_lustres +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of locationf_sx_lustres in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md index fde67843ea..5bf267f1a8 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual locationf_sx_ontap resource, use locationf_sx_ontaps to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual locationf_sx_ontap resource, use Namelocationf_sx_ontap TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxONTAP. -Idaws.datasync.locationf_sx_ontap +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
storage_virtual_machine_arnstringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
protocolobject
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
location_uristringThe URL of the FSx ONTAP file system that was described.
regionstringAWS region.
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.
object
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual locationf_sx_ontap resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md index 8edd051c70..1361b915cf 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of locationf_sx_ontaps in a region or create a locationf_sx_ontaps resource, use locationf_sx_ontap to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of locationf_sx_ontaps in a region or creat Namelocationf_sx_ontaps TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxONTAP. -Idaws.datasync.locationf_sx_ontaps +Id ## Fields - - + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of locationf_sx_ontaps in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md index 5ddbca2659..d9f6cf2733 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual locationf_sx_open_zfs resource, use locationf_sx_open_zfs to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual locationf_sx_open_zfs resource, u Namelocationf_sx_open_zfs TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS. -Idaws.datasync.locationf_sx_open_zfs +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
protocolobject
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
location_uristringThe URL of the FSx OpenZFS that was described.
regionstringAWS region.
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.
object
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual locationf_sx_open_zfs resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md index de0b5a58ce..4f13659d81 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual locationf_sx_windows resource, use locationf_sx_windows to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual locationf_sx_windows resource, us Namelocationf_sx_windows TypeResource DescriptionResource schema for AWS::DataSync::LocationFSxWindows. -Idaws.datasync.locationf_sx_windows +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
domainstringThe name of the Windows domain that the FSx for Windows server belongs to.
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
passwordstringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
subdirectorystringA subdirectory in the location's path.
userstringThe user who has the permissions to access files and folders in the FSx for Windows file system.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
location_uristringThe URL of the FSx for Windows location that was described.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual locationf_sx_windows resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/storage_system/index.md b/docs/aws-docs/providers/aws/datasync/storage_system/index.md index 12ed74a7ff..8b0f78bf97 100644 --- a/docs/aws-docs/providers/aws/datasync/storage_system/index.md +++ b/docs/aws-docs/providers/aws/datasync/storage_system/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual storage_system resource, use storage_systems to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual storage_system resource, use Namestorage_system TypeResource DescriptionResource schema for AWS::DataSync::StorageSystem. -Idaws.datasync.storage_system +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
server_configurationobject
server_credentialsobject
secrets_manager_arnstringThe ARN of a secret stored by AWS Secrets Manager.
system_typestringThe type of on-premises storage system that DataSync Discovery will analyze.
agent_arnsarrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
cloud_watch_log_group_arnstringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
namestringA familiar name for the on-premises storage system.
tagsarrayAn array of key-value pairs to apply to this resource.
storage_system_arnstringThe ARN of the on-premises storage system added to DataSync Discovery.
connectivity_statusstringIndicates whether the DataSync agent can access the on-premises storage system.
regionstringAWS region.
object
object
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual storage_system resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/storage_systems/index.md b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md index a089a018bc..d2cc37d724 100644 --- a/docs/aws-docs/providers/aws/datasync/storage_systems/index.md +++ b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of storage_systems in a region or create a storage_systems resource, use storage_system to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of storage_systems in a region or create a Namestorage_systems TypeResource DescriptionResource schema for AWS::DataSync::StorageSystem. -Idaws.datasync.storage_systems +Id ## Fields - - + +
NameDatatypeDescription
storage_system_arnstringThe ARN of the on-premises storage system added to DataSync Discovery.
regionstringAWS region.
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of storage_systems in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datasync/task/index.md b/docs/aws-docs/providers/aws/datasync/task/index.md index 8ebe1ba23e..306b6cb71c 100644 --- a/docs/aws-docs/providers/aws/datasync/task/index.md +++ b/docs/aws-docs/providers/aws/datasync/task/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual task resource, use tasks to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual task resource, use tasksNametask TypeResource DescriptionResource schema for AWS::DataSync::Task. -Idaws.datasync.task +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
excludesarray
includesarray
tagsarrayAn array of key-value pairs to apply to this resource.
cloud_watch_log_group_arnstringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destination_location_arnstringThe ARN of an AWS storage resource's location.
namestringThe name of a task. This value is a text reference that is used to identify the task in the console.
optionsobject
task_report_configobject
manifest_configobject
scheduleobject
source_location_arnstringThe ARN of the source location for the task.
task_arnstringThe ARN of the task.
statusstringThe status of the task that was described.
source_network_interface_arnsarray
destination_network_interface_arnsarray
regionstringAWS region.
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.
object
object
object
object
stringThe ARN of the source location for the task.
stringThe ARN of the task.
stringThe status of the task that was described.
array
array
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual task resource, use tasksRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datasync/tasks/index.md b/docs/aws-docs/providers/aws/datasync/tasks/index.md index 71f61060e1..b62c5ce6c4 100644 --- a/docs/aws-docs/providers/aws/datasync/tasks/index.md +++ b/docs/aws-docs/providers/aws/datasync/tasks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tasks in a region or create a tasks resource, use task to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of tasks in a region or create a task Nametasks TypeResource DescriptionResource schema for AWS::DataSync::Task. -Idaws.datasync.tasks +Id ## Fields - - + +
NameDatatypeDescription
task_arnstringThe ARN of the task.
regionstringAWS region.
stringThe ARN of the task.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of tasks in a region or create a task Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/data_source/index.md b/docs/aws-docs/providers/aws/datazone/data_source/index.md index df50a66d4d..497e73834a 100644 --- a/docs/aws-docs/providers/aws/datazone/data_source/index.md +++ b/docs/aws-docs/providers/aws/datazone/data_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_source resource, use data_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,35 +24,35 @@ Gets or operates on an individual data_source resource, use d Namedata_source TypeResource DescriptionDefinition of AWS::DataZone::DataSource Resource Type -Idaws.datazone.data_source +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
asset_forms_inputarrayThe metadata forms that are to be attached to the assets that this data source works with.
created_atstringThe timestamp of when the data source was created.
descriptionstringThe description of the data source.
domain_idstringThe ID of the Amazon DataZone domain where the data source is created.
domain_identifierstringThe ID of the Amazon DataZone domain where the data source is created.
enable_settingstringSpecifies whether the data source is enabled.
environment_idstringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
environment_identifierstringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
idstringThe unique identifier of the data source.
configurationundefinedConfiguration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
last_run_asset_countnumberThe number of assets created by the data source during its last run.
last_run_atstringThe timestamp that specifies when the data source was last run.
last_run_statusstringThe status of the last run of this data source.
namestringThe name of the data source.
project_idstringThe ID of the Amazon DataZone project to which the data source is added.
project_identifierstringThe identifier of the Amazon DataZone project in which you want to add the data source.
publish_on_importbooleanSpecifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendationobjectSpecifies whether the business name generation is to be enabled for this data source.
scheduleobjectThe schedule of the data source runs.
statusstringThe status of the data source.
typestringThe type of the data source.
updated_atstringThe timestamp of when this data source was updated.
regionstringAWS region.
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.
@@ -62,19 +65,19 @@ Gets or operates on an individual data_source resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/data_sources/index.md b/docs/aws-docs/providers/aws/datazone/data_sources/index.md index 74411b3a90..fefd03e9c9 100644 --- a/docs/aws-docs/providers/aws/datazone/data_sources/index.md +++ b/docs/aws-docs/providers/aws/datazone/data_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_sources in a region or create a data_sources resource, use data_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of data_sources in a region or create a Namedata_sources TypeResource DescriptionDefinition of AWS::DataZone::DataSource Resource Type -Idaws.datazone.data_sources +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain where the data source is created.
idstringThe unique identifier of the data source.
regionstringAWS region.
stringThe ID of the Amazon DataZone domain where the data source is created.
stringThe unique identifier of the data source.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of data_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/domain/index.md b/docs/aws-docs/providers/aws/datazone/domain/index.md index be6cc31ded..53d27da1cc 100644 --- a/docs/aws-docs/providers/aws/datazone/domain/index.md +++ b/docs/aws-docs/providers/aws/datazone/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionA domain is an organizing entity for connecting together assets, users, and their projects -Idaws.datazone.domain +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Amazon DataZone domain.
created_atstringThe timestamp of when the Amazon DataZone domain was last updated.
descriptionstringThe description of the Amazon DataZone domain.
domain_execution_rolestringThe domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
idstringThe id of the Amazon DataZone domain.
kms_key_identifierstringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
last_updated_atstringThe timestamp of when the Amazon DataZone domain was last updated.
managed_account_idstringThe identifier of the AWS account that manages the domain.
namestringThe name of the Amazon DataZone domain.
portal_urlstringThe URL of the data portal for this Amazon DataZone domain.
single_sign_onobjectThe single-sign on configuration of the Amazon DataZone domain.
statusstringThe status of the Amazon DataZone domain.
tagsarrayThe tags specified for the Amazon DataZone domain.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/domains/index.md b/docs/aws-docs/providers/aws/datazone/domains/index.md index f76a5e6623..eecf06122c 100644 --- a/docs/aws-docs/providers/aws/datazone/domains/index.md +++ b/docs/aws-docs/providers/aws/datazone/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionA domain is an organizing entity for connecting together assets, users, and their projects -Idaws.datazone.domains +Id ## Fields - - + +
NameDatatypeDescription
idstringThe id of the Amazon DataZone domain.
regionstringAWS region.
stringThe id of the Amazon DataZone domain.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/environment/index.md b/docs/aws-docs/providers/aws/datazone/environment/index.md index 1f54873692..96fe5f9f63 100644 --- a/docs/aws-docs/providers/aws/datazone/environment/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionDefinition of AWS::DataZone::Environment Resource Type -Idaws.datazone.environment +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
aws_account_idstringThe AWS account in which the Amazon DataZone environment is created.
aws_account_regionstringThe AWS region in which the Amazon DataZone environment is created.
created_atstringThe timestamp of when the environment was created.
created_bystringThe Amazon DataZone user who created the environment.
descriptionstringThe description of the Amazon DataZone environment.
domain_idstringThe identifier of the Amazon DataZone domain in which the environment is created.
domain_identifierstringThe identifier of the Amazon DataZone domain in which the environment would be created.
environment_blueprint_idstringThe ID of the blueprint with which the Amazon DataZone environment was created.
environment_profile_idstringThe ID of the environment profile with which the Amazon DataZone environment was created.
environment_profile_identifierstringThe ID of the environment profile with which the Amazon DataZone environment would be created.
glossary_termsarrayThe glossary terms that can be used in the Amazon DataZone environment.
idstringThe ID of the Amazon DataZone environment.
namestringThe name of the environment.
project_idstringThe ID of the Amazon DataZone project in which the environment is created.
project_identifierstringThe ID of the Amazon DataZone project in which the environment would be created.
providerstringThe provider of the Amazon DataZone environment.
statusstringThe status of the Amazon DataZone environment.
updated_atstringThe timestamp of when the environment was updated.
user_parametersarrayThe user parameters of the Amazon DataZone environment.
regionstringAWS region.
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which the Amazon DataZone environment is created.
stringThe timestamp of when the environment was created.
stringThe Amazon DataZone user who created the environment.
stringThe description of the Amazon DataZone environment.
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe identifier of the Amazon DataZone domain in which the environment would be created.
stringThe ID of the blueprint with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment would be created.
arrayThe glossary terms that can be used in the Amazon DataZone environment.
stringThe ID of the Amazon DataZone environment.
stringThe name of the environment.
stringThe ID of the Amazon DataZone project in which the environment is created.
stringThe ID of the Amazon DataZone project in which the environment would be created.
stringThe provider of the Amazon DataZone environment.
stringThe status of the Amazon DataZone environment.
stringThe timestamp of when the environment was updated.
arrayThe user parameters of the Amazon DataZone environment.
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md index 4b78f188c1..edd2c65c21 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment_blueprint_configuration resource, use environment_blueprint_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual environment_blueprint_configurationNameenvironment_blueprint_configuration TypeResource DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type -Idaws.datazone.environment_blueprint_configuration +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
regional_parametersarray
provisioning_role_arnstring
domain_idstring
created_atstring
enabled_regionsarray
environment_blueprint_identifierstring
environment_blueprint_idstring
updated_atstring
domain_identifierstring
manage_access_role_arnstring
regionstringAWS region.
array
string
string
string
array
string
string
string
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual environment_blueprint_configurationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md index a93dd7b1b1..d78e55bb3e 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environment_blueprint_configurations in a region or create a environment_blueprint_configurations resource, use environment_blueprint_configuration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of environment_blueprint_configurations in Nameenvironment_blueprint_configurations TypeResource DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type -Idaws.datazone.environment_blueprint_configurations +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstring
environment_blueprint_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of environment_blueprint_configurations in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/environment_profile/index.md b/docs/aws-docs/providers/aws/datazone/environment_profile/index.md index 2a02c7c171..1e1d65d47a 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_profile/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment_profile resource, use environment_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual environment_profile resource, use Nameenvironment_profile TypeResource DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments. -Idaws.datazone.environment_profile +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
aws_account_idstringThe AWS account in which the Amazon DataZone environment is created.
aws_account_regionstringThe AWS region in which this environment profile is created.
created_atstringThe timestamp of when this environment profile was created.
created_bystringThe Amazon DataZone user who created this environment profile.
descriptionstringThe description of this Amazon DataZone environment profile.
domain_idstringThe ID of the Amazon DataZone domain in which this environment profile is created.
domain_identifierstringThe ID of the Amazon DataZone domain in which this environment profile is created.
environment_blueprint_idstringThe ID of the blueprint with which this environment profile is created.
environment_blueprint_identifierstringThe ID of the blueprint with which this environment profile is created.
idstringThe ID of this Amazon DataZone environment profile.
namestringThe name of this Amazon DataZone environment profile.
project_idstringThe identifier of the project in which to create the environment profile.
project_identifierstringThe identifier of the project in which to create the environment profile.
updated_atstringThe timestamp of when this environment profile was updated.
user_parametersarrayThe user parameters of this Amazon DataZone environment profile.
regionstringAWS region.
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual environment_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md index f59b41a1ad..0e04ccf4c6 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environment_profiles in a region or create a environment_profiles resource, use environment_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of environment_profiles in a region or crea Nameenvironment_profiles TypeResource DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments. -Idaws.datazone.environment_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain in which this environment profile is created.
idstringThe ID of this Amazon DataZone environment profile.
regionstringAWS region.
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of this Amazon DataZone environment profile.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of environment_profiles in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/environments/index.md b/docs/aws-docs/providers/aws/datazone/environments/index.md index 7fab4f7433..cb8cec73cf 100644 --- a/docs/aws-docs/providers/aws/datazone/environments/index.md +++ b/docs/aws-docs/providers/aws/datazone/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionDefinition of AWS::DataZone::Environment Resource Type -Idaws.datazone.environments +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstringThe identifier of the Amazon DataZone domain in which the environment is created.
idstringThe ID of the Amazon DataZone environment.
regionstringAWS region.
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe ID of the Amazon DataZone environment.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/project/index.md b/docs/aws-docs/providers/aws/datazone/project/index.md index 7056176205..3814869653 100644 --- a/docs/aws-docs/providers/aws/datazone/project/index.md +++ b/docs/aws-docs/providers/aws/datazone/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics. -Idaws.datazone.project +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
created_atstringThe timestamp of when the project was created.
created_bystringThe Amazon DataZone user who created the project.
descriptionstringThe description of the Amazon DataZone project.
domain_idstringThe identifier of the Amazon DataZone domain in which the project was created.
domain_identifierstringThe ID of the Amazon DataZone domain in which this project is created.
glossary_termsarrayThe glossary terms that can be used in this Amazon DataZone project.
idstringThe ID of the Amazon DataZone project.
last_updated_atstringThe timestamp of when the project was last updated.
namestringThe name of the Amazon DataZone project.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/projects/index.md b/docs/aws-docs/providers/aws/datazone/projects/index.md index 32c870cb90..44af4cc7cc 100644 --- a/docs/aws-docs/providers/aws/datazone/projects/index.md +++ b/docs/aws-docs/providers/aws/datazone/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics. -Idaws.datazone.projects +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstringThe identifier of the Amazon DataZone domain in which the project was created.
idstringThe ID of the Amazon DataZone project.
regionstringAWS region.
stringThe identifier of the Amazon DataZone domain in which the project was created.
stringThe ID of the Amazon DataZone project.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/datazone/subscription_target/index.md b/docs/aws-docs/providers/aws/datazone/subscription_target/index.md index 314b53ef96..ea7b63bfaa 100644 --- a/docs/aws-docs/providers/aws/datazone/subscription_target/index.md +++ b/docs/aws-docs/providers/aws/datazone/subscription_target/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subscription_target resource, use subscription_targets to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual subscription_target resource, use Namesubscription_target TypeResource DescriptionSubscription targets enables one to access the data to which you have subscribed in your projects. -Idaws.datazone.subscription_target +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
applicable_asset_typesarrayThe asset types that can be included in the subscription target.
authorized_principalsarrayThe authorized principals of the subscription target.
created_atstringThe timestamp of when the subscription target was created.
created_bystringThe Amazon DataZone user who created the subscription target.
domain_idstringThe ID of the Amazon DataZone domain in which subscription target is created.
domain_identifierstringThe ID of the Amazon DataZone domain in which subscription target would be created.
environment_idstringThe ID of the environment in which subscription target is created.
environment_identifierstringThe ID of the environment in which subscription target would be created.
idstringThe ID of the subscription target.
manage_access_rolestringThe manage access role that is used to create the subscription target.
namestringThe name of the subscription target.
project_idstringThe identifier of the project specified in the subscription target.
providerstringThe provider of the subscription target.
subscription_target_configarrayThe configuration of the subscription target.
typestringThe type of the subscription target.
updated_atstringThe timestamp of when the subscription target was updated.
updated_bystringThe Amazon DataZone user who updated the subscription target.
regionstringAWS region.
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.
@@ -57,19 +60,19 @@ Gets or operates on an individual subscription_target resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md index 60deb80362..489edf634b 100644 --- a/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md +++ b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subscription_targets in a region or create a subscription_targets resource, use subscription_target to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of subscription_targets in a region or crea Namesubscription_targets TypeResource DescriptionSubscription targets enables one to access the data to which you have subscribed in your projects. -Idaws.datazone.subscription_targets +Id ## Fields - - - - + + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain in which subscription target is created.
environment_idstringThe ID of the environment in which subscription target is created.
idstringThe ID of the subscription target.
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Used to retrieve a list of subscription_targets in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/farm/index.md b/docs/aws-docs/providers/aws/deadline/farm/index.md index b5db588d3c..1aeaff2e23 100644 --- a/docs/aws-docs/providers/aws/deadline/farm/index.md +++ b/docs/aws-docs/providers/aws/deadline/farm/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual farm resource, use farms to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual farm resource, use farmsNamefarm TypeResource DescriptionDefinition of AWS::Deadline::Farm Resource Type -Idaws.deadline.farm +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstring
display_namestring
farm_idstring
kms_key_arnstring
arnstring
regionstringAWS region.
string
string
string
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual farm resource, use farmsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/farms/index.md b/docs/aws-docs/providers/aws/deadline/farms/index.md index 0263528240..1d461655c6 100644 --- a/docs/aws-docs/providers/aws/deadline/farms/index.md +++ b/docs/aws-docs/providers/aws/deadline/farms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of farms in a region or create a farms resource, use farm to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of farms in a region or create a farm Namefarms TypeResource DescriptionDefinition of AWS::Deadline::Farm Resource Type -Idaws.deadline.farms +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of farms in a region or create a farm Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/fleet/index.md b/docs/aws-docs/providers/aws/deadline/fleet/index.md index d7f06c174d..5dfb379cea 100644 --- a/docs/aws-docs/providers/aws/deadline/fleet/index.md +++ b/docs/aws-docs/providers/aws/deadline/fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet resource, use fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual fleet resource, use fleets< Namefleet TypeResource DescriptionDefinition of AWS::Deadline::Fleet Resource Type -Idaws.deadline.fleet +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesobject
configurationundefined
descriptionstring
display_namestring
farm_idstring
fleet_idstring
max_worker_countinteger
min_worker_countinteger
role_arnstring
statusstring
worker_countinteger
arnstring
regionstringAWS region.
object
undefined
string
string
string
string
integer
integer
string
string
integer
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual fleet resource, use fleets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/fleets/index.md b/docs/aws-docs/providers/aws/deadline/fleets/index.md index 6b77bb6e7c..54b2591879 100644 --- a/docs/aws-docs/providers/aws/deadline/fleets/index.md +++ b/docs/aws-docs/providers/aws/deadline/fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleets in a region or create a fleets resource, use fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleets in a region or create a fle Namefleets TypeResource DescriptionDefinition of AWS::Deadline::Fleet Resource Type -Idaws.deadline.fleets +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleets in a region or create a fle Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md index f8275797f4..1bd5b77130 100644 --- a/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md +++ b/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual license_endpoint resource, use license_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual license_endpoint resource, use Namelicense_endpoint TypeResource DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type -Idaws.deadline.license_endpoint +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
dns_namestring
license_endpoint_idstring
security_group_idsarray
statusstring
status_messagestring
subnet_idsarray
vpc_idstring
arnstring
regionstringAWS region.
string
string
array
string
string
array
string
string
stringAWS region.
@@ -48,14 +51,14 @@ Gets or operates on an individual license_endpoint resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md index 7e2853169c..d1510cc098 100644 --- a/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md +++ b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of license_endpoints in a region or create a license_endpoints resource, use license_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of license_endpoints in a region or create Namelicense_endpoints TypeResource DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type -Idaws.deadline.license_endpoints +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of license_endpoints in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/metered_product/index.md b/docs/aws-docs/providers/aws/deadline/metered_product/index.md index 304a4121fb..2f9243917a 100644 --- a/docs/aws-docs/providers/aws/deadline/metered_product/index.md +++ b/docs/aws-docs/providers/aws/deadline/metered_product/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual metered_product resource, use metered_products to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual metered_product resource, use Namemetered_product TypeResource DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type -Idaws.deadline.metered_product +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
license_endpoint_idstring
product_idstring
portinteger
familystring
vendorstring
arnstring
regionstringAWS region.
string
string
integer
string
string
string
stringAWS region.
@@ -46,14 +49,14 @@ Gets or operates on an individual metered_product resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/metered_products/index.md b/docs/aws-docs/providers/aws/deadline/metered_products/index.md index 3fc8b0558e..5758da5197 100644 --- a/docs/aws-docs/providers/aws/deadline/metered_products/index.md +++ b/docs/aws-docs/providers/aws/deadline/metered_products/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of metered_products in a region or create a metered_products resource, use metered_product to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of metered_products in a region or create a Namemetered_products TypeResource DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type -Idaws.deadline.metered_products +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of metered_products in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/queue/index.md b/docs/aws-docs/providers/aws/deadline/queue/index.md index faf6e77aa7..b63d9c87cc 100644 --- a/docs/aws-docs/providers/aws/deadline/queue/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue resource, use queues to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual queue resource, use queues< Namequeue TypeResource DescriptionDefinition of AWS::Deadline::Queue Resource Type -Idaws.deadline.queue +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
allowed_storage_profile_idsarray
default_budget_actionstring
descriptionstring
display_namestring
farm_idstring
job_attachment_settingsobject
job_run_as_userobject
queue_idstring
required_file_system_location_namesarray
role_arnstring
arnstring
regionstringAWS region.
array
string
string
string
string
object
object
string
array
string
string
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual queue resource, use queues< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/queue_environment/index.md b/docs/aws-docs/providers/aws/deadline/queue_environment/index.md index 533743c622..d069d6a1bd 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_environment/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue_environment resource, use queue_environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual queue_environment resource, use < Namequeue_environment TypeResource DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type -Idaws.deadline.queue_environment +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
farm_idstring
namestring
priorityinteger
queue_environment_idstring
queue_idstring
templatestring
template_typestring
regionstringAWS region.
string
string
integer
string
string
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual queue_environment resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/queue_environments/index.md b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md index 711f56fbbb..05db832d74 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_environments/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queue_environments in a region or create a queue_environments resource, use queue_environment to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of queue_environments in a region or create Namequeue_environments TypeResource DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type -Idaws.deadline.queue_environments +Id ## Fields - - - - + + + +
NameDatatypeDescription
farm_idstring
queue_idstring
queue_environment_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of queue_environments in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md index 875e8adc9b..68e989af54 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue_fleet_association resource, use queue_fleet_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual queue_fleet_association resource, Namequeue_fleet_association TypeResource DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type -Idaws.deadline.queue_fleet_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
farm_idstring
fleet_idstring
queue_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual queue_fleet_association resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md index 1890165845..89a064bd3a 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queue_fleet_associations in a region or create a queue_fleet_associations resource, use queue_fleet_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of queue_fleet_associations in a region or Namequeue_fleet_associations TypeResource DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type -Idaws.deadline.queue_fleet_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
farm_idstring
fleet_idstring
queue_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of queue_fleet_associations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/queues/index.md b/docs/aws-docs/providers/aws/deadline/queues/index.md index b2e0f19e0e..c2bb7ee8e1 100644 --- a/docs/aws-docs/providers/aws/deadline/queues/index.md +++ b/docs/aws-docs/providers/aws/deadline/queues/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queues in a region or create a queues resource, use queue to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of queues in a region or create a que Namequeues TypeResource DescriptionDefinition of AWS::Deadline::Queue Resource Type -Idaws.deadline.queues +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of queues in a region or create a que Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/deadline/storage_profile/index.md b/docs/aws-docs/providers/aws/deadline/storage_profile/index.md index cfc04ce9e3..bdad57d4a2 100644 --- a/docs/aws-docs/providers/aws/deadline/storage_profile/index.md +++ b/docs/aws-docs/providers/aws/deadline/storage_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual storage_profile resource, use storage_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual storage_profile resource, use Namestorage_profile TypeResource DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type -Idaws.deadline.storage_profile +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
display_namestring
farm_idstring
file_system_locationsarray
os_familystring
storage_profile_idstring
regionstringAWS region.
string
string
array
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual storage_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md index 320aa09c95..826070a7e2 100644 --- a/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md +++ b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of storage_profiles in a region or create a storage_profiles resource, use storage_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of storage_profiles in a region or create a Namestorage_profiles TypeResource DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type -Idaws.deadline.storage_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
farm_idstring
storage_profile_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of storage_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/detective/graph/index.md b/docs/aws-docs/providers/aws/detective/graph/index.md index 82ff14e6eb..1671690589 100644 --- a/docs/aws-docs/providers/aws/detective/graph/index.md +++ b/docs/aws-docs/providers/aws/detective/graph/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual graph resource, use graphs to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual graph resource, use graphs< Namegraph TypeResource DescriptionResource schema for AWS::Detective::Graph -Idaws.detective.graph +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstringThe Detective graph ARN
tagsarray
auto_enable_membersbooleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
regionstringAWS region.
stringThe Detective graph ARN
array
booleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual graph resource, use graphs< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/detective/graphs/index.md b/docs/aws-docs/providers/aws/detective/graphs/index.md index a169b84fc9..4c2f166ad7 100644 --- a/docs/aws-docs/providers/aws/detective/graphs/index.md +++ b/docs/aws-docs/providers/aws/detective/graphs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of graphs in a region or create a graphs resource, use graph to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of graphs in a region or create a gra Namegraphs TypeResource DescriptionResource schema for AWS::Detective::Graph -Idaws.detective.graphs +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Detective graph ARN
regionstringAWS region.
stringThe Detective graph ARN
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of graphs in a region or create a gra Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/detective/member_invitation/index.md b/docs/aws-docs/providers/aws/detective/member_invitation/index.md index c48c059557..01e1a1ac0d 100644 --- a/docs/aws-docs/providers/aws/detective/member_invitation/index.md +++ b/docs/aws-docs/providers/aws/detective/member_invitation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual member_invitation resource, use member_invitations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual member_invitation resource, use < Namemember_invitation TypeResource DescriptionResource schema for AWS::Detective::MemberInvitation -Idaws.detective.member_invitation +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
graph_arnstringThe ARN of the graph to which the member account will be invited
member_idstringThe AWS account ID to be invited to join the graph as a member
member_email_addressstringThe root email address for the account to be invited, for validation. Updating this field has no effect.
disable_email_notificationbooleanWhen set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect.
messagestringA message to be included in the email invitation sent to the invited account. Updating this field has no effect.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual member_invitation resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/detective/member_invitations/index.md b/docs/aws-docs/providers/aws/detective/member_invitations/index.md index 75c8cf960b..369fed340b 100644 --- a/docs/aws-docs/providers/aws/detective/member_invitations/index.md +++ b/docs/aws-docs/providers/aws/detective/member_invitations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of member_invitations in a region or create a member_invitations resource, use member_invitation to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of member_invitations in a region or create Namemember_invitations TypeResource DescriptionResource schema for AWS::Detective::MemberInvitation -Idaws.detective.member_invitations +Id ## Fields - - - + + +
NameDatatypeDescription
graph_arnstringThe ARN of the graph to which the member account will be invited
member_idstringThe AWS account ID to be invited to join the graph as a member
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of member_invitations in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/detective/organization_admin/index.md b/docs/aws-docs/providers/aws/detective/organization_admin/index.md index 0828164f3f..cb7877ff2f 100644 --- a/docs/aws-docs/providers/aws/detective/organization_admin/index.md +++ b/docs/aws-docs/providers/aws/detective/organization_admin/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual organization_admin resource, use organization_admins to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual organization_admin resource, use Nameorganization_admin TypeResource DescriptionResource schema for AWS::Detective::OrganizationAdmin -Idaws.detective.organization_admin +Id ## Fields - - - + + +
NameDatatypeDescription
account_idstringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
graph_arnstringThe Detective graph ARN
regionstringAWS region.
stringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
stringThe Detective graph ARN
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual organization_admin resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/detective/organization_admins/index.md b/docs/aws-docs/providers/aws/detective/organization_admins/index.md index 2cca1af6a1..117c468d17 100644 --- a/docs/aws-docs/providers/aws/detective/organization_admins/index.md +++ b/docs/aws-docs/providers/aws/detective/organization_admins/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of organization_admins in a region or create a organization_admins resource, use organization_admin to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of organization_admins in a region or creat Nameorganization_admins TypeResource DescriptionResource schema for AWS::Detective::OrganizationAdmin -Idaws.detective.organization_admins +Id ## Fields - - + +
NameDatatypeDescription
account_idstringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
regionstringAWS region.
stringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of organization_admins in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md index 85806c1e36..daefb31125 100644 --- a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual log_anomaly_detection_integration resource, use log_anomaly_detection_integrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,14 +24,14 @@ Gets or operates on an individual log_anomaly_detection_integration Namelog_anomaly_detection_integration TypeResource DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru. -Idaws.devopsguru.log_anomaly_detection_integration +Id ## Fields - - + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,19 +44,19 @@ Gets or operates on an individual log_anomaly_detection_integration Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md index e75aff1567..663091d864 100644 --- a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of log_anomaly_detection_integrations in a region or create a log_anomaly_detection_integrations resource, use log_anomaly_detection_integration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of log_anomaly_detection_integrations in a Namelog_anomaly_detection_integrations TypeResource DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru. -Idaws.devopsguru.log_anomaly_detection_integrations +Id ## Fields - - + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of log_anomaly_detection_integrations in a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md index f3875b3b70..81603afd97 100644 --- a/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual notification_channel resource, use notification_channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual notification_channel resource, us Namenotification_channel TypeResource DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru. -Idaws.devopsguru.notification_channel +Id ## Fields - - - + + +
NameDatatypeDescription
configobject
idstringThe ID of a notification channel.
regionstringAWS region.
object
stringThe ID of a notification channel.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual notification_channel resource, us Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md index 6c51f9eef1..27a4c275c1 100644 --- a/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of notification_channels in a region or create a notification_channels resource, use notification_channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of notification_channels in a region or cre Namenotification_channels TypeResource DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru. -Idaws.devopsguru.notification_channels +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of a notification channel.
regionstringAWS region.
stringThe ID of a notification channel.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of notification_channels in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md index b7046a0531..7b5db91bec 100644 --- a/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_collection resource, use resource_collections to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual resource_collection resource, use Nameresource_collection TypeResource DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru. -Idaws.devopsguru.resource_collection +Id ## Fields - - - + + +
NameDatatypeDescription
resource_collection_filterobject
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
object
stringThe type of ResourceCollection
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual resource_collection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md index 44fb951776..2e6194f929 100644 --- a/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_collections in a region or create a resource_collections resource, use resource_collection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_collections in a region or crea Nameresource_collections TypeResource DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru. -Idaws.devopsguru.resource_collections +Id ## Fields - - + +
NameDatatypeDescription
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
stringThe type of ResourceCollection
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_collections in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md index 56aeeb6e51..a321d2298c 100644 --- a/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual simple_ad resource, use simple_ads to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual simple_ad resource, use sim Namesimple_ad TypeResource DescriptionResource Type definition for AWS::DirectoryService::SimpleAD -Idaws.directoryservice.simple_ad +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
directory_idstringThe unique identifier for a directory.
aliasstringThe alias for a directory.
dns_ip_addressesarrayThe IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
create_aliasbooleanThe name of the configuration set.
descriptionstringDescription for the directory.
enable_ssobooleanWhether to enable single sign-on for a Simple Active Directory in AWS.
namestringThe fully qualified domain name for the AWS Managed Simple AD directory.
passwordstringThe password for the default administrative user named Admin.
short_namestringThe NetBIOS name for your domain.
sizestringThe size of the directory.
vpc_settingsobjectVPC settings of the Simple AD directory server in AWS.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual simple_ad resource, use sim Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md index f2158bcede..a2af41a7a7 100644 --- a/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of simple_ads in a region or create a simple_ads resource, use simple_ad to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of simple_ads in a region or create a Namesimple_ads TypeResource DescriptionResource Type definition for AWS::DirectoryService::SimpleAD -Idaws.directoryservice.simple_ads +Id ## Fields - - + +
NameDatatypeDescription
directory_idstringThe unique identifier for a directory.
regionstringAWS region.
stringThe unique identifier for a directory.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of simple_ads in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dms/data_provider/index.md b/docs/aws-docs/providers/aws/dms/data_provider/index.md index 7d2a58fbba..6846cd0d9b 100644 --- a/docs/aws-docs/providers/aws/dms/data_provider/index.md +++ b/docs/aws-docs/providers/aws/dms/data_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_provider resource, use data_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual data_provider resource, use Namedata_provider TypeResource DescriptionResource schema for AWS::DMS::DataProvider -Idaws.dms.data_provider +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
data_provider_namestringThe property describes a name to identify the data provider.
data_provider_identifierstringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
data_provider_arnstringThe data provider ARN.
data_provider_creation_timestringThe data provider creation time.
descriptionstringThe optional description of the data provider.
enginestringThe property describes a data engine for the data provider.
exact_settingsbooleanThe property describes the exact settings which can be modified
settingsobjectThe property identifies the exact type of settings for the data provider.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual data_provider resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dms/data_providers/index.md b/docs/aws-docs/providers/aws/dms/data_providers/index.md index d051fe3085..18b5ad36b6 100644 --- a/docs/aws-docs/providers/aws/dms/data_providers/index.md +++ b/docs/aws-docs/providers/aws/dms/data_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_providers in a region or create a data_providers resource, use data_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_providers in a region or create a < Namedata_providers TypeResource DescriptionResource schema for AWS::DMS::DataProvider -Idaws.dms.data_providers +Id ## Fields - - + +
NameDatatypeDescription
data_provider_arnstringThe data provider ARN.
regionstringAWS region.
stringThe data provider ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_providers in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dms/instance_profile/index.md b/docs/aws-docs/providers/aws/dms/instance_profile/index.md index f918a5f176..3387511ae8 100644 --- a/docs/aws-docs/providers/aws/dms/instance_profile/index.md +++ b/docs/aws-docs/providers/aws/dms/instance_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance_profile resource, use instance_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual instance_profile resource, use Nameinstance_profile TypeResource DescriptionResource schema for AWS::DMS::InstanceProfile. -Idaws.dms.instance_profile +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
instance_profile_arnstringThe property describes an ARN of the instance profile.
instance_profile_identifierstringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
availability_zonestringThe property describes an availability zone of the instance profile.
descriptionstringThe optional description of the instance profile.
kms_key_arnstringThe property describes kms key arn for the instance profile.
publicly_accessiblebooleanThe property describes the publicly accessible of the instance profile
network_typestringThe property describes a network type for the instance profile.
instance_profile_namestringThe property describes a name for the instance profile.
instance_profile_creation_timestringThe property describes a creating time of the instance profile.
subnet_group_identifierstringThe property describes a subnet group identifier for the instance profile.
vpc_security_groupsarrayThe property describes vps security groups for the instance profile.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual instance_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dms/instance_profiles/index.md b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md index c3d332ad1f..cf2075c936 100644 --- a/docs/aws-docs/providers/aws/dms/instance_profiles/index.md +++ b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instance_profiles in a region or create a instance_profiles resource, use instance_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instance_profiles in a region or create Nameinstance_profiles TypeResource DescriptionResource schema for AWS::DMS::InstanceProfile. -Idaws.dms.instance_profiles +Id ## Fields - - + +
NameDatatypeDescription
instance_profile_arnstringThe property describes an ARN of the instance profile.
regionstringAWS region.
stringThe property describes an ARN of the instance profile.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instance_profiles in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dms/migration_project/index.md b/docs/aws-docs/providers/aws/dms/migration_project/index.md index 1c8065f846..c5aee491c6 100644 --- a/docs/aws-docs/providers/aws/dms/migration_project/index.md +++ b/docs/aws-docs/providers/aws/dms/migration_project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual migration_project resource, use migration_projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual migration_project resource, use < Namemigration_project TypeResource DescriptionResource schema for AWS::DMS::MigrationProject -Idaws.dms.migration_project +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
migration_project_namestringThe property describes a name to identify the migration project.
migration_project_identifierstringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
migration_project_arnstringThe property describes an ARN of the migration project.
migration_project_creation_timestringThe property describes a creating time of the migration project.
instance_profile_identifierstringThe property describes an instance profile identifier for the migration project. For create
instance_profile_namestringThe property describes an instance profile name for the migration project. For read
instance_profile_arnstringThe property describes an instance profile arn for the migration project. For read
transformation_rulesstringThe property describes transformation rules for the migration project.
descriptionstringThe optional description of the migration project.
schema_conversion_application_attributesobjectThe property describes schema conversion application attributes for the migration project.
source_data_provider_descriptorsarrayThe property describes source data provider descriptors for the migration project.
target_data_provider_descriptorsarrayThe property describes target data provider descriptors for the migration project.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual migration_project resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dms/migration_projects/index.md b/docs/aws-docs/providers/aws/dms/migration_projects/index.md index 073e9fd072..a478c46910 100644 --- a/docs/aws-docs/providers/aws/dms/migration_projects/index.md +++ b/docs/aws-docs/providers/aws/dms/migration_projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of migration_projects in a region or create a migration_projects resource, use migration_project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of migration_projects in a region or create Namemigration_projects TypeResource DescriptionResource schema for AWS::DMS::MigrationProject -Idaws.dms.migration_projects +Id ## Fields - - + +
NameDatatypeDescription
migration_project_arnstringThe property describes an ARN of the migration project.
regionstringAWS region.
stringThe property describes an ARN of the migration project.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of migration_projects in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dms/replication_config/index.md b/docs/aws-docs/providers/aws/dms/replication_config/index.md index 6bc70b8dbf..07d3b3e889 100644 --- a/docs/aws-docs/providers/aws/dms/replication_config/index.md +++ b/docs/aws-docs/providers/aws/dms/replication_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual replication_config resource, use replication_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual replication_config resource, use Namereplication_config TypeResource DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication -Idaws.dms.replication_config +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
replication_config_identifierstringA unique identifier of replication configuration
replication_config_arnstringThe Amazon Resource Name (ARN) of the Replication Config
source_endpoint_arnstringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
target_endpoint_arnstringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
replication_typestringThe type of AWS DMS Serverless replication to provision using this replication configuration
compute_configobject
replication_settingsobjectJSON settings for Servereless replications that are provisioned using this replication configuration
supplemental_settingsobjectJSON settings for specifying supplemental data
resource_identifierstringA unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
table_mappingsobjectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
regionstringAWS region.
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
object
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<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual replication_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dms/replication_configs/index.md b/docs/aws-docs/providers/aws/dms/replication_configs/index.md index a765c7fed8..6f57e261df 100644 --- a/docs/aws-docs/providers/aws/dms/replication_configs/index.md +++ b/docs/aws-docs/providers/aws/dms/replication_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of replication_configs in a region or create a replication_configs resource, use replication_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of replication_configs in a region or creat Namereplication_configs TypeResource DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication -Idaws.dms.replication_configs +Id ## Fields - - + +
NameDatatypeDescription
replication_config_arnstringThe Amazon Resource Name (ARN) of the Replication Config
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the Replication Config
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of replication_configs in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md b/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md index 4aa52fa696..948ffa9dbc 100644 --- a/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md +++ b/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster -Idaws.docdbelastic.cluster +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestring
cluster_arnstring
cluster_endpointstring
admin_user_namestring
admin_user_passwordstring
shard_capacityinteger
shard_countinteger
vpc_security_group_idsarray
subnet_idsarray
preferred_maintenance_windowstring
preferred_backup_windowstring
backup_retention_periodinteger
shard_instance_countinteger
kms_key_idstring
tagsarray
auth_typestring
regionstringAWS region.
string
string
string
string
string
integer
integer
array
array
string
string
integer
integer
string
array
string
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual cluster resource, use clust Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md index 2ea37ea2db..3f5529c1d6 100644 --- a/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md +++ b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster -Idaws.docdbelastic.clusters +Id ## Fields - - + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dynamodb/global_table/index.md b/docs/aws-docs/providers/aws/dynamodb/global_table/index.md index 6098f68609..45d7d47ade 100644 --- a/docs/aws-docs/providers/aws/dynamodb/global_table/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/global_table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual global_table resource, use global_tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual global_table resource, use Nameglobal_table TypeResource DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable -Idaws.dynamodb.global_table +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
table_idstring
sse_specificationobject
stream_specificationobject
replicasarray
write_provisioned_throughput_settingsobject
table_namestring
attribute_definitionsarray
billing_modestring
global_secondary_indexesarray
key_schemaarray
local_secondary_indexesarray
arnstring
stream_arnstring
time_to_live_specificationobject
regionstringAWS region.
string
object
object
array
object
string
array
string
array
array
array
string
string
object
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual global_table resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md index 5f3bbb8221..e10b8c85a0 100644 --- a/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of global_tables in a region or create a global_tables resource, use global_table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of global_tables in a region or create a Nameglobal_tables TypeResource DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable -Idaws.dynamodb.global_tables +Id ## Fields - - + +
NameDatatypeDescription
table_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of global_tables in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/dynamodb/table/index.md b/docs/aws-docs/providers/aws/dynamodb/table/index.md index 1d4d310cf1..334166901d 100644 --- a/docs/aws-docs/providers/aws/dynamodb/table/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual table resource, use tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual table resource, use tables< Nametable TypeResource DescriptionThe ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.<br/> You should be aware of the following behaviors when working with DDB tables:<br/> + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).<br/> <br/> Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes. -Idaws.dynamodb.table +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
sse_specificationobjectSpecifies the settings to enable server-side encryption.
kinesis_stream_specificationobjectThe Kinesis Data Streams configuration for the specified table.
stream_specificationobjectThe settings for the DDB table stream, which capture changes to items stored in the table.
contributor_insights_specificationobjectThe settings used to enable or disable CloudWatch Contributor Insights for the specified table.
import_source_specificationobjectSpecifies the properties of data being imported from the S3 bucket source to the table.<br/> If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission.
point_in_time_recovery_specificationobjectThe settings used to enable point in time recovery.
provisioned_throughputobjectThroughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). <br/> If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property.
table_namestringA name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
attribute_definitionsarrayA list of attributes that describe the key schema for the table and indexes.<br/> This property is required to create a DDB table.<br/> Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.
billing_modestringSpecify how you are charged for read and write throughput and how you manage capacity.<br/> Valid values include:<br/> + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).<br/> + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).<br/> <br/> If not specified, the default is ``PROVISIONED``.
global_secondary_indexesarrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.<br/> If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.<br/> If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. <br/> Updates are not supported. The following are exceptions:<br/> + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.<br/> + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
resource_policyobjectA resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).<br/> When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
key_schemaundefinedSpecifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.
local_secondary_indexesarrayLocal secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
arnstring
stream_arnstring
deletion_protection_enabledbooleanDetermines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.
table_classstringThe table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.
tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
time_to_live_specificationobjectSpecifies the Time to Live (TTL) settings for the table.<br/> For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
regionstringAWS region.
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.<br/> If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission.
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). <br/> If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property.
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).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
arrayA list of attributes that describe the key schema for the table and indexes.<br/> This property is required to create a DDB table.<br/> Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.
stringSpecify how you are charged for read and write throughput and how you manage capacity.<br/> Valid values include:<br/> + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).<br/> + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).<br/> <br/> If not specified, the default is ``PROVISIONED``.
arrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.<br/> If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.<br/> If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. <br/> Updates are not supported. The following are exceptions:<br/> + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.<br/> + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
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).<br/> When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
undefinedSpecifies 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.<br/> 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.<br/> For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
stringAWS region.
@@ -60,19 +63,19 @@ Gets or operates on an individual table resource, use tables< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/dynamodb/tables/index.md b/docs/aws-docs/providers/aws/dynamodb/tables/index.md index 096803567c..9830c2f249 100644 --- a/docs/aws-docs/providers/aws/dynamodb/tables/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tables in a region or create a tables resource, use table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of tables in a region or create a tab Nametables TypeResource DescriptionThe ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.<br/> You should be aware of the following behaviors when working with DDB tables:<br/> + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).<br/> <br/> Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes. -Idaws.dynamodb.tables +Id ## Fields - - + +
NameDatatypeDescription
table_namestringA name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
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).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of tables in a region or create a tab Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md index 8cb14f2552..cf7ce35e51 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual capacity_reservation resource, use capacity_reservations to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual capacity_reservation resource, us Namecapacity_reservation TypeResource DescriptionResource Type definition for AWS::EC2::CapacityReservation -Idaws.ec2.capacity_reservation +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tenancystring
end_date_typestring
tag_specificationsarray
availability_zonestring
total_instance_countinteger
end_datestring
ebs_optimizedboolean
out_post_arnstring
instance_countinteger
placement_group_arnstring
available_instance_countinteger
instance_platformstring
idstring
instance_typestring
ephemeral_storageboolean
instance_match_criteriastring
regionstringAWS region.
string
string
array
string
integer
string
boolean
string
integer
string
integer
string
string
string
boolean
string
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual capacity_reservation resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md index 2c6fbacfc1..316025fb3c 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual capacity_reservation_fleet resource, use capacity_reservation_fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual capacity_reservation_fleet resour Namecapacity_reservation_fleet TypeResource DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet -Idaws.ec2.capacity_reservation_fleet +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
allocation_strategystring
tag_specificationsarray
instance_type_specificationsarray
total_target_capacityinteger
end_datestring
instance_match_criteriastring
capacity_reservation_fleet_idstring
tenancystring
remove_end_dateboolean
no_remove_end_dateboolean
regionstringAWS region.
string
array
array
integer
string
string
string
string
boolean
boolean
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual capacity_reservation_fleet resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md index 9e29f3f5c2..da598cebf1 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of capacity_reservation_fleets in a region or create a capacity_reservation_fleets resource, use capacity_reservation_fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of capacity_reservation_fleets in a region Namecapacity_reservation_fleets TypeResource DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet -Idaws.ec2.capacity_reservation_fleets +Id ## Fields - - + +
NameDatatypeDescription
capacity_reservation_fleet_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of capacity_reservation_fleets in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md index 6728cefa6c..acbf6fc31d 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of capacity_reservations in a region or create a capacity_reservations resource, use capacity_reservation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of capacity_reservations in a region or cre Namecapacity_reservations TypeResource DescriptionResource Type definition for AWS::EC2::CapacityReservation -Idaws.ec2.capacity_reservations +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of capacity_reservations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md index 08b8f4815d..0609657767 100644 --- a/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual carrier_gateway resource, use carrier_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual carrier_gateway resource, use Namecarrier_gateway TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.ec2.carrier_gateway +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
statestringThe state of the carrier gateway.
vpc_idstringThe ID of the VPC.
owner_idstringThe ID of the owner.
tagsarrayThe tags for the carrier gateway.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual carrier_gateway resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md index 0f3a3747ff..4fb1ca4307 100644 --- a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of carrier_gateways in a region or create a carrier_gateways resource, use carrier_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of carrier_gateways in a region or create a Namecarrier_gateways TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.ec2.carrier_gateways +Id ## Fields - - + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
regionstringAWS region.
stringThe ID of the carrier gateway.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of carrier_gateways in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md index 616c444194..95f997b8a0 100644 --- a/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual customer_gateway resource, use customer_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual customer_gateway resource, use Namecustomer_gateway TypeResource DescriptionSpecifies a customer gateway. -Idaws.ec2.customer_gateway +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
certificate_arnstring
customer_gateway_idstring
bgp_asnintegerFor devices that support BGP, the customer gateway's BGP ASN.<br/> Default: 65000
ip_addressstringIPv4 address for the customer gateway device's outside interface. The address must be static.
tagsarrayOne or more tags for the customer gateway.
typestringThe type of VPN connection that this customer gateway supports (``ipsec.1``).
device_namestringThe name of customer gateway device.
regionstringAWS region.
string
string
integerFor devices that support BGP, the customer gateway's BGP ASN.<br/> Default: 65000
stringIPv4 address for the customer gateway device's outside interface. The address must be static.
arrayOne or more tags for the customer gateway.
stringThe type of VPN connection that this customer gateway supports (``ipsec.1``).
stringThe name of customer gateway device.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual customer_gateway resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md index a9b10ecdd8..bd02ca32c4 100644 --- a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of customer_gateways in a region or create a customer_gateways resource, use customer_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of customer_gateways in a region or create Namecustomer_gateways TypeResource DescriptionSpecifies a customer gateway. -Idaws.ec2.customer_gateways +Id ## Fields - - + +
NameDatatypeDescription
customer_gateway_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of customer_gateways in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md index d24d4e8bb2..0a61a00f2d 100644 --- a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md +++ b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dhcp_options resource, use dhcp_options to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual dhcp_options resource, use Namedhcp_options TypeResource DescriptionResource Type definition for AWS::EC2::DHCPOptions -Idaws.ec2.dhcp_options +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
dhcp_options_idstring
domain_namestringThis value is used to complete unqualified DNS hostnames.
domain_name_serversarrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
netbios_name_serversarrayThe IPv4 addresses of up to four NetBIOS name servers.
netbios_node_typeintegerThe NetBIOS node type (1, 2, 4, or 8).
ntp_serversarrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
ipv6_address_preferred_lease_timeintegerThe preferred Lease Time for ipV6 address in seconds.
tagsarrayAny tags assigned to the DHCP options set.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual dhcp_options resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md index 4eab5c4d29..8eb14fdb75 100644 --- a/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md +++ b/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ec2fleet resource, use ec2fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual ec2fleet resource, use ec2f Nameec2fleet TypeResource DescriptionResource Type definition for AWS::EC2::EC2Fleet -Idaws.ec2.ec2fleet +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
target_capacity_specificationobject
on_demand_optionsobject
typestring
excess_capacity_termination_policystring
tag_specificationsarray
spot_optionsobject
valid_fromstring
replace_unhealthy_instancesboolean
launch_template_configsarray
fleet_idstring
terminate_instances_with_expirationboolean
valid_untilstring
contextstring
regionstringAWS region.
object
object
string
string
array
object
string
boolean
array
string
boolean
string
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual ec2fleet resource, use ec2f Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md index bd18b60ab6..18251b34d3 100644 --- a/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ec2fleets in a region or create a ec2fleets resource, use ec2fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ec2fleets in a region or create a Nameec2fleets TypeResource DescriptionResource Type definition for AWS::EC2::EC2Fleet -Idaws.ec2.ec2fleets +Id ## Fields - - + +
NameDatatypeDescription
fleet_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ec2fleets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md index 4ea480baf9..7642adf16a 100644 --- a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual egress_only_internet_gateway resource, use egress_only_internet_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual egress_only_internet_gateway reso Nameegress_only_internet_gateway TypeResource DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway -Idaws.ec2.egress_only_internet_gateway +Id ## Fields - - - + + +
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
vpc_idstringThe ID of the VPC for which to create the egress-only internet gateway.
regionstringAWS region.
stringService Generated ID of the EgressOnlyInternetGateway
stringThe ID of the VPC for which to create the egress-only internet gateway.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual egress_only_internet_gateway reso Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md index d27ddac703..07b960751a 100644 --- a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of egress_only_internet_gateways in a region or create a egress_only_internet_gateways resource, use egress_only_internet_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of egress_only_internet_gateways in a regio Nameegress_only_internet_gateways TypeResource DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway -Idaws.ec2.egress_only_internet_gateways +Id ## Fields - - + +
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
regionstringAWS region.
stringService Generated ID of the EgressOnlyInternetGateway
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of egress_only_internet_gateways in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/eip/index.md b/docs/aws-docs/providers/aws/ec2/eip/index.md index 94ec255cfc..a0192f05f4 100644 --- a/docs/aws-docs/providers/aws/ec2/eip/index.md +++ b/docs/aws-docs/providers/aws/ec2/eip/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual eip resource, use eips to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual eip resource, use eipsNameeip TypeResource DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.<br/> You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.<br/> For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. -Idaws.ec2.eip +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
public_ipstring
allocation_idstring
domainstringThe network (``vpc``).<br/> If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
network_border_groupstringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.<br/> Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
transfer_addressstringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
instance_idstringThe ID of the instance.<br/> Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
public_ipv4_poolstringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.<br/> Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
tagsarrayAny tags assigned to the Elastic IP address.<br/> Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
regionstringAWS region.
string
string
stringThe network (``vpc``).<br/> If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
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.<br/> 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.<br/> 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.<br/> Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
arrayAny tags assigned to the Elastic IP address.<br/> Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual eip resource, use eipsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/eip_association/index.md b/docs/aws-docs/providers/aws/ec2/eip_association/index.md index d3d9e86190..b21921b2eb 100644 --- a/docs/aws-docs/providers/aws/ec2/eip_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/eip_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual eip_association resource, use eip_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual eip_association resource, use Nameeip_association TypeResource DescriptionResource schema for EC2 EIP association. -Idaws.ec2.eip_association +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
allocation_idstringThe allocation ID. This is required for EC2-VPC.
network_interface_idstringThe ID of the network interface.
instance_idstringThe ID of the instance.
private_ip_addressstringThe primary or secondary private IP address to associate with the Elastic IP address.
e_ipstringThe Elastic IP address to associate with the instance.
regionstringAWS region.
stringComposite ID of non-empty properties, to determine the identification.
stringThe allocation ID. This is required for EC2-VPC.
stringThe ID of the network interface.
stringThe ID of the instance.
stringThe primary or secondary private IP address to associate with the Elastic IP address.
stringThe Elastic IP address to associate with the instance.
stringAWS region.
@@ -46,14 +49,14 @@ Gets or operates on an individual eip_association resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/eip_associations/index.md b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md index 374d6173c9..7fb1d3d8d8 100644 --- a/docs/aws-docs/providers/aws/ec2/eip_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of eip_associations in a region or create a eip_associations resource, use eip_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of eip_associations in a region or create a Nameeip_associations TypeResource DescriptionResource schema for EC2 EIP association. -Idaws.ec2.eip_associations +Id ## Fields - - + +
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
regionstringAWS region.
stringComposite ID of non-empty properties, to determine the identification.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of eip_associations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/eips/index.md b/docs/aws-docs/providers/aws/ec2/eips/index.md index a1345bba23..4d3c3e91b3 100644 --- a/docs/aws-docs/providers/aws/ec2/eips/index.md +++ b/docs/aws-docs/providers/aws/ec2/eips/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of eips in a region or create a eips resource, use eip to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of eips in a region or create a eips< Nameeips TypeResource DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.<br/> You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.<br/> For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. -Idaws.ec2.eips +Id ## Fields - - - + + +
NameDatatypeDescription
public_ipstring
allocation_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of eips in a region or create a eips< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md index 121e48a668..840854c8a4 100644 --- a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual enclave_certificate_iam_role_association resource, use enclave_certificate_iam_role_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual enclave_certificate_iam_role_association Nameenclave_certificate_iam_role_association TypeResource DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. -Idaws.ec2.enclave_certificate_iam_role_association +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
certificate_s3_bucket_namestringThe name of the Amazon S3 bucket to which the certificate was uploaded.
certificate_s3_object_keystringThe Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
encryption_kms_key_idstringThe ID of the AWS KMS CMK used to encrypt the private key of the certificate.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual enclave_certificate_iam_role_association Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md index 5b9942d2d3..4dade03366 100644 --- a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of enclave_certificate_iam_role_associations in a region or create a enclave_certificate_iam_role_associations resource, use enclave_certificate_iam_role_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of enclave_certificate_iam_role_associationsNameenclave_certificate_iam_role_associations TypeResource DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. -Idaws.ec2.enclave_certificate_iam_role_associations +Id ## Fields - - - + + +
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of enclave_certificate_iam_role_associationsRequired Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/flow_log/index.md b/docs/aws-docs/providers/aws/ec2/flow_log/index.md index 31c9f485f7..d1d99fb5e7 100644 --- a/docs/aws-docs/providers/aws/ec2/flow_log/index.md +++ b/docs/aws-docs/providers/aws/ec2/flow_log/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow_log resource, use flow_logs to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual flow_log resource, use flow Nameflow_log TypeResource DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC. -Idaws.ec2.flow_log +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe Flow Log ID
deliver_cross_account_rolestringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
deliver_logs_permission_arnstringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
log_destinationstringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
log_destination_typestringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
log_formatstringThe fields to include in the flow log record, in the order in which they should appear.
log_group_namestringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
max_aggregation_intervalintegerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
resource_idstringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
resource_typestringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
tagsarrayThe tags to apply to the flow logs.
traffic_typestringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
destination_optionsobject
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual flow_log resource, use flow Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md index d0e8924145..041f10ef38 100644 --- a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md +++ b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flow_logs in a region or create a flow_logs resource, use flow_log to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flow_logs in a region or create a Nameflow_logs TypeResource DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC. -Idaws.ec2.flow_logs +Id ## Fields - - + +
NameDatatypeDescription
idstringThe Flow Log ID
regionstringAWS region.
stringThe Flow Log ID
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flow_logs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md index 314a6422a5..4135de3cc7 100644 --- a/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual gateway_route_table_association resource, use gateway_route_table_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual gateway_route_table_association r Namegateway_route_table_association TypeResource DescriptionAssociates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table. -Idaws.ec2.gateway_route_table_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
route_table_idstringThe ID of the route table.
gateway_idstringThe ID of the gateway.
association_idstringThe route table association ID.
regionstringAWS region.
stringThe ID of the route table.
stringThe ID of the gateway.
stringThe route table association ID.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual gateway_route_table_association r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md index 1f3d531ad5..ada3b6c138 100644 --- a/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of gateway_route_table_associations in a region or create a gateway_route_table_associations resource, use gateway_route_table_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of gateway_route_table_associations in a re Namegateway_route_table_associations TypeResource DescriptionAssociates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table. -Idaws.ec2.gateway_route_table_associations +Id ## Fields - - + +
NameDatatypeDescription
gateway_idstringThe ID of the gateway.
regionstringAWS region.
stringThe ID of the gateway.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of gateway_route_table_associations in a re Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/host/index.md b/docs/aws-docs/providers/aws/ec2/host/index.md index de4b2e69ba..9dff7358bc 100644 --- a/docs/aws-docs/providers/aws/ec2/host/index.md +++ b/docs/aws-docs/providers/aws/ec2/host/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual host resource, use hosts to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual host resource, use hostsNamehost TypeResource DescriptionResource Type definition for AWS::EC2::Host -Idaws.ec2.host +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
host_idstringID of the host created.
auto_placementstringIndicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
availability_zonestringThe Availability Zone in which to allocate the Dedicated Host.
host_recoverystringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
instance_typestringSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
instance_familystringSpecifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
outpost_arnstringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
host_maintenancestringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
asset_idstringThe ID of the Outpost hardware asset.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual host resource, use hostsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/hosts/index.md b/docs/aws-docs/providers/aws/ec2/hosts/index.md index 97a33e7c02..9c2996fce7 100644 --- a/docs/aws-docs/providers/aws/ec2/hosts/index.md +++ b/docs/aws-docs/providers/aws/ec2/hosts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hosts in a region or create a hosts resource, use host to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hosts in a region or create a host Namehosts TypeResource DescriptionResource Type definition for AWS::EC2::Host -Idaws.ec2.hosts +Id ## Fields - - + +
NameDatatypeDescription
host_idstringID of the host created.
regionstringAWS region.
stringID of the host created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hosts in a region or create a host Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/instance/index.md b/docs/aws-docs/providers/aws/ec2/instance/index.md index baf9982dd1..c6f0e1c59f 100644 --- a/docs/aws-docs/providers/aws/ec2/instance/index.md +++ b/docs/aws-docs/providers/aws/ec2/instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance resource, use instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,59 +24,59 @@ Gets or operates on an individual instance resource, use inst Nameinstance TypeResource DescriptionResource Type definition for AWS::EC2::Instance -Idaws.ec2.instance +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tenancystringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
security_groupsarraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
private_dns_namestringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
private_ip_addressstring[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
user_datastringThe user data to make available to the instance.
block_device_mappingsarrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
iam_instance_profilestringThe IAM instance profile.
ipv6_addressesarray[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
kernel_idstringThe ID of the kernel.
subnet_idstring[EC2-VPC] The ID of the subnet to launch the instance into.<br/><br/>
ebs_optimizedbooleanIndicates whether the instance is optimized for Amazon EBS I/O.
propagate_tags_to_volume_on_creationbooleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
elastic_gpu_specificationsarrayAn elastic GPU to associate with the instance.
elastic_inference_acceleratorsarrayAn elastic inference accelerator to associate with the instance.
volumesarrayThe volumes to attach to the instance.
private_ipstringThe private IP address of the specified instance. For example: 10.24.34.0.
ipv6_address_countinteger[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
launch_templateobjectThe launch template to use to launch the instances.
enclave_optionsobjectIndicates whether the instance is enabled for AWS Nitro Enclaves.
network_interfacesarrayThe network interfaces to associate with the instance.
image_idstringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
instance_typestringThe instance type.
monitoringbooleanSpecifies whether detailed monitoring is enabled for the instance.
tagsarrayThe tags to add to the instance.
additional_infostringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
hibernation_optionsobjectIndicates whether an instance is enabled for hibernation.
license_specificationsarrayThe license configurations.
instance_idstringThe EC2 Instance ID.
public_ipstringThe public IP address of the specified instance. For example: 192.0.2.0.
instance_initiated_shutdown_behaviorstringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
cpu_optionsobjectThe CPU options for the instance.
availability_zonestringThe Availability Zone of the instance.
private_dns_name_optionsobjectThe options for the instance hostname.
host_idstringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
host_resource_group_arnstringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
public_dns_namestringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
security_group_idsarrayThe IDs of the security groups.
disable_api_terminationbooleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
key_namestringThe name of the key pair.
ramdisk_idstringThe ID of the RAM disk to select.
source_dest_checkbooleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
placement_group_namestringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
ssm_associationsarrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
vpc_idstringThe ID of the VPC that the instance is running in.
affinitystringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
credit_specificationobjectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
regionstringAWS region.
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.<br/><br/>
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.
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.
@@ -86,19 +89,19 @@ Gets or operates on an individual instance resource, use inst Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md index 580c1a3711..461ab839c3 100644 --- a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance_connect_endpoint resource, use instance_connect_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual instance_connect_endpoint resourc Nameinstance_connect_endpoint TypeResource DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint -Idaws.ec2.instance_connect_endpoint +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstringThe id of the instance connect endpoint
subnet_idstringThe subnet id of the instance connect endpoint
client_tokenstringThe client token of the instance connect endpoint.
preserve_client_ipbooleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
tagsarrayThe tags of the instance connect endpoint.
security_group_idsarrayThe security group IDs of the instance connect endpoint.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual instance_connect_endpoint resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md index b7c95a46d9..dd6e52c9bb 100644 --- a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instance_connect_endpoints in a region or create a instance_connect_endpoints resource, use instance_connect_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instance_connect_endpoints in a region o Nameinstance_connect_endpoints TypeResource DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint -Idaws.ec2.instance_connect_endpoints +Id ## Fields - - + +
NameDatatypeDescription
idstringThe id of the instance connect endpoint
regionstringAWS region.
stringThe id of the instance connect endpoint
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instance_connect_endpoints in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/instances/index.md b/docs/aws-docs/providers/aws/ec2/instances/index.md index 9516c04fe2..9388368881 100644 --- a/docs/aws-docs/providers/aws/ec2/instances/index.md +++ b/docs/aws-docs/providers/aws/ec2/instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instances in a region or create a instances resource, use instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instances in a region or create a Nameinstances TypeResource DescriptionResource Type definition for AWS::EC2::Instance -Idaws.ec2.instances +Id ## Fields - - + +
NameDatatypeDescription
instance_idstringThe EC2 Instance ID.
regionstringAWS region.
stringThe EC2 Instance ID.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instances in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md index 04a35e72ff..c94fb56924 100644 --- a/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual internet_gateway resource, use internet_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual internet_gateway resource, use Nameinternet_gateway TypeResource DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC. -Idaws.ec2.internet_gateway +Id ## Fields - - - + + +
NameDatatypeDescription
internet_gateway_idstring
tagsarrayAny tags to assign to the internet gateway.
regionstringAWS region.
string
arrayAny tags to assign to the internet gateway.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual internet_gateway resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md index 0620a02b31..eb6ebe589e 100644 --- a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of internet_gateways in a region or create a internet_gateways resource, use internet_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of internet_gateways in a region or create Nameinternet_gateways TypeResource DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC. -Idaws.ec2.internet_gateways +Id ## Fields - - + +
NameDatatypeDescription
internet_gateway_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of internet_gateways in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam/index.md b/docs/aws-docs/providers/aws/ec2/ipam/index.md index 8495b44664..80cfba6978 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam resource, use ipams to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual ipam resource, use ipamsNameipam TypeResource DescriptionResource Schema of AWS::EC2::IPAM Type -Idaws.ec2.ipam +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
ipam_idstringId of the IPAM.
arnstringThe Amazon Resource Name (ARN) of the IPAM.
default_resource_discovery_idstringThe Id of the default resource discovery, created with this IPAM.
default_resource_discovery_association_idstringThe Id of the default association to the default resource discovery, created with this IPAM.
resource_discovery_association_countintegerThe count of resource discoveries associated with this IPAM.
descriptionstring
public_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
private_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
scope_countintegerThe number of scopes that currently exist in this IPAM.
operating_regionsarrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tierstringThe tier of the IPAM.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringId of the IPAM.
stringThe Amazon Resource Name (ARN) of the IPAM.
stringThe Id of the default resource discovery, created with this IPAM.
stringThe Id of the default association to the default resource discovery, created with this IPAM.
integerThe count of resource discoveries associated with this IPAM.
string
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
integerThe number of scopes that currently exist in this IPAM.
arrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
stringThe tier of the IPAM.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual ipam resource, use ipamsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md index 537eecf0c1..78297b73ea 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_allocation resource, use ipam_allocations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual ipam_allocation resource, use Nameipam_allocation TypeResource DescriptionResource Schema of AWS::EC2::IPAMAllocation Type -Idaws.ec2.ipam_allocation +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
ipam_pool_allocation_idstringId of the allocation.
ipam_pool_idstringId of the IPAM Pool.
cidrstring
netmask_lengthintegerThe desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
descriptionstring
regionstringAWS region.
stringId of the allocation.
stringId of the IPAM Pool.
string
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual ipam_allocation resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md index 6d7a4d0cc8..c81c467f89 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_allocations in a region or create a ipam_allocations resource, use ipam_allocation to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of ipam_allocations in a region or create a Nameipam_allocations TypeResource DescriptionResource Schema of AWS::EC2::IPAMAllocation Type -Idaws.ec2.ipam_allocations +Id ## Fields - - - - + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_allocation_idstringId of the allocation.
cidrundefined
regionstringAWS region.
stringId of the IPAM Pool.
stringId of the allocation.
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of ipam_allocations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md index 60fa2d44b9..9ade5a082b 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_pool resource, use ipam_pools to retrieve a list of resources or to create a resource. ## Overview @@ -21,37 +24,37 @@ Gets or operates on an individual ipam_pool resource, use ipa Nameipam_pool TypeResource DescriptionResource Schema of AWS::EC2::IPAMPool Type -Idaws.ec2.ipam_pool +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
address_familystringThe address family of the address space in this pool. Either IPv4 or IPv6.
allocation_min_netmask_lengthintegerThe minimum allowed netmask length for allocations made from this pool.
allocation_default_netmask_lengthintegerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
allocation_max_netmask_lengthintegerThe maximum allowed netmask length for allocations made from this pool.
allocation_resource_tagsarrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
arnstringThe Amazon Resource Name (ARN) of the IPAM Pool.
auto_importbooleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
aws_servicestringLimits which service in Amazon Web Services that the pool can be used in.
descriptionstring
ipam_scope_idstringThe Id of the scope this pool is a part of.
ipam_scope_arnstringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
localestringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
pool_depthintegerThe depth of this pool in the source pool hierarchy.
provisioned_cidrsarrayA list of cidrs representing the address space available for allocation in this pool.
public_ip_sourcestringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
publicly_advertisablebooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
source_ipam_pool_idstringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
source_resourceobject
statestringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
state_messagestringAn explanation of how the pool arrived at it current state.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
object
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.
@@ -64,19 +67,19 @@ Gets or operates on an individual ipam_pool resource, use ipa Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md index 59c1905213..34e39cfc4e 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_pool_cidr resource, use ipam_pool_cidrs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual ipam_pool_cidr resource, use Nameipam_pool_cidr TypeResource DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type -Idaws.ec2.ipam_pool_cidr +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
ipam_pool_idstringId of the IPAM Pool.
cidrstringRepresents a single IPv4 or IPv6 CIDR
netmask_lengthintegerThe desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
statestringProvisioned state of the cidr.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual ipam_pool_cidr resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md index e46d90eb65..d59007d4e6 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_pool_cidrs in a region or create a ipam_pool_cidrs resource, use ipam_pool_cidr to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of ipam_pool_cidrs in a region or create a Nameipam_pool_cidrs TypeResource DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type -Idaws.ec2.ipam_pool_cidrs +Id ## Fields - - - + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
regionstringAWS region.
stringId of the IPAM Pool.
stringId of the IPAM Pool Cidr.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of ipam_pool_cidrs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md index 115f30317e..c2aa7aa23e 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_pools in a region or create a ipam_pools resource, use ipam_pool to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ipam_pools in a region or create a Nameipam_pools TypeResource DescriptionResource Schema of AWS::EC2::IPAMPool Type -Idaws.ec2.ipam_pools +Id ## Fields - - + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
regionstringAWS region.
stringId of the IPAM Pool.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ipam_pools in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md index d8c8665e94..b680cc750d 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_resource_discoveries in a region or create a ipam_resource_discoveries resource, use ipam_resource_discovery to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ipam_resource_discoveries in a region or Nameipam_resource_discoveries TypeResource DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type -Idaws.ec2.ipam_resource_discoveries +Id ## Fields - - + +
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
regionstringAWS region.
stringId of the IPAM Pool.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ipam_resource_discoveries in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md index 01512eddfd..045834ed82 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_resource_discovery resource, use ipam_resource_discoveries to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual ipam_resource_discovery resource, Nameipam_resource_discovery TypeResource DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type -Idaws.ec2.ipam_resource_discovery +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
owner_idstringOwner Account ID of the Resource Discovery
operating_regionsarrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
ipam_resource_discovery_regionstringThe region the resource discovery is setup in.
descriptionstring
is_defaultbooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
ipam_resource_discovery_arnstringAmazon Resource Name (Arn) for the Resource Discovery.
statestringThe state of this Resource Discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual ipam_resource_discovery resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md index fb1c929ffe..895119316b 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_resource_discovery_association resource, use ipam_resource_discovery_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual ipam_resource_discovery_associationNameipam_resource_discovery_association TypeResource DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type -Idaws.ec2.ipam_resource_discovery_association +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
ipam_arnstringArn of the IPAM.
ipam_regionstringThe home region of the IPAM.
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
ipam_resource_discovery_idstringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
ipam_idstringThe Id of the IPAM this Resource Discovery is associated to.
ipam_resource_discovery_association_arnstringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
is_defaultbooleanIf the Resource Discovery Association exists due as part of CreateIpam.
owner_idstringThe AWS Account ID for the account where the shared IPAM exists.
statestringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
resource_discovery_statusstringThe status of the resource discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual ipam_resource_discovery_associationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md index 69bde765d3..972a2ca7c0 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_resource_discovery_associations in a region or create a ipam_resource_discovery_associations resource, use ipam_resource_discovery_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ipam_resource_discovery_associations in Nameipam_resource_discovery_associations TypeResource DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type -Idaws.ec2.ipam_resource_discovery_associations +Id ## Fields - - + +
NameDatatypeDescription
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
regionstringAWS region.
stringId of the IPAM Resource Discovery Association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ipam_resource_discovery_associations in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md index fed8adca87..bb7dc6e284 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ipam_scope resource, use ipam_scopes to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual ipam_scope resource, use ip Nameipam_scope TypeResource DescriptionResource Schema of AWS::EC2::IPAMScope Type -Idaws.ec2.ipam_scope +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
arnstringThe Amazon Resource Name (ARN) of the IPAM scope.
ipam_idstringThe Id of the IPAM this scope is a part of.
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
is_defaultbooleanIs this one of the default scopes created with the IPAM.
descriptionstring
pool_countintegerThe number of pools that currently exist in this scope.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual ipam_scope resource, use ip Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md index dfea85ff85..c6114377ff 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipam_scopes in a region or create a ipam_scopes resource, use ipam_scope to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ipam_scopes in a region or create a Nameipam_scopes TypeResource DescriptionResource Schema of AWS::EC2::IPAMScope Type -Idaws.ec2.ipam_scopes +Id ## Fields - - + +
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
regionstringAWS region.
stringId of the IPAM scope.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ipam_scopes in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/ipams/index.md b/docs/aws-docs/providers/aws/ec2/ipams/index.md index bd8e5e7ce8..956f16a856 100644 --- a/docs/aws-docs/providers/aws/ec2/ipams/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ipams in a region or create a ipams resource, use ipam to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ipams in a region or create a ipam Nameipams TypeResource DescriptionResource Schema of AWS::EC2::IPAM Type -Idaws.ec2.ipams +Id ## Fields - - + +
NameDatatypeDescription
ipam_idstringId of the IPAM.
regionstringAWS region.
stringId of the IPAM.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ipams in a region or create a ipam Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/key_pair/index.md b/docs/aws-docs/providers/aws/ec2/key_pair/index.md index 10de569913..f45cd5b9b8 100644 --- a/docs/aws-docs/providers/aws/ec2/key_pair/index.md +++ b/docs/aws-docs/providers/aws/ec2/key_pair/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual key_pair resource, use key_pairs to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual key_pair resource, use key_ Namekey_pair TypeResource DescriptionThe AWS::EC2::KeyPair creates an SSH key pair -Idaws.ec2.key_pair +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
key_namestringThe name of the SSH key pair
key_typestringThe crypto-system used to generate a key pair.
key_formatstringThe format of the private key
public_key_materialstringPlain text public key to import
key_fingerprintstringA short sequence of bytes used for public key verification
key_pair_idstringAn AWS generated ID for the key pair
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringThe name of the SSH key pair
stringThe crypto-system used to generate a key pair.
stringThe format of the private key
stringPlain text public key to import
stringA short sequence of bytes used for public key verification
stringAn AWS generated ID for the key pair
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -47,14 +50,14 @@ Gets or operates on an individual key_pair resource, use key_ Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md index beeed2392d..809e6bb42c 100644 --- a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md +++ b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of key_pairs in a region or create a key_pairs resource, use key_pair to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of key_pairs in a region or create a Namekey_pairs TypeResource DescriptionThe AWS::EC2::KeyPair creates an SSH key pair -Idaws.ec2.key_pairs +Id ## Fields - - + +
NameDatatypeDescription
key_namestringThe name of the SSH key pair
regionstringAWS region.
stringThe name of the SSH key pair
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of key_pairs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/launch_template/index.md b/docs/aws-docs/providers/aws/ec2/launch_template/index.md index 47b11dca80..57727cf8fb 100644 --- a/docs/aws-docs/providers/aws/ec2/launch_template/index.md +++ b/docs/aws-docs/providers/aws/ec2/launch_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual launch_template resource, use launch_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual launch_template resource, use Namelaunch_template TypeResource DescriptionSpecifies the properties for creating a launch template.<br/> The minimum required properties for specifying a launch template are as follows:<br/> + You must specify at least one property for the launch template data.<br/> + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you.<br/> <br/> A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.<br/> For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. -Idaws.ec2.launch_template +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
launch_template_namestringA name for the launch template.
launch_template_dataobjectThe information for the launch template.
version_descriptionstringA description for the first version of the launch template.
tag_specificationsarrayThe tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.<br/> To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
latest_version_numberstring
launch_template_idstring
default_version_numberstring
regionstringAWS region.
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``.<br/> To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
string
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual launch_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md index 41d5cd759c..981d0c9e1b 100644 --- a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md +++ b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of launch_templates in a region or create a launch_templates resource, use launch_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of launch_templates in a region or create a Namelaunch_templates TypeResource DescriptionSpecifies the properties for creating a launch template.<br/> The minimum required properties for specifying a launch template are as follows:<br/> + You must specify at least one property for the launch template data.<br/> + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you.<br/> <br/> A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.<br/> For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. -Idaws.ec2.launch_templates +Id ## Fields - - + +
NameDatatypeDescription
launch_template_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of launch_templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md index 80212d500f..96cb3455e7 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual local_gateway_route resource, use local_gateway_routes to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual local_gateway_route resource, use Namelocal_gateway_route TypeResource DescriptionDescribes a route for a local gateway route table. -Idaws.ec2.local_gateway_route +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the virtual interface group.
network_interface_idstringThe ID of the network interface.
statestringThe state of the route.
typestringThe route type.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual local_gateway_route resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md index 4a3de22936..cc97017a07 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual local_gateway_route_table resource, use local_gateway_route_tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual local_gateway_route_table resourc Namelocal_gateway_route_table TypeResource DescriptionDescribes a route table for a local gateway. -Idaws.ec2.local_gateway_route_table +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_idstringThe ID of the local gateway.
outpost_arnstringThe ARN of the outpost.
owner_idstringThe owner of the local gateway route table.
statestringThe state of the local gateway route table.
modestringThe mode of the local gateway route table.
tagsarrayThe tags for the local gateway route table.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual local_gateway_route_table resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md index c22f89ed8f..76b34f6ac4 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual local_gateway_route_table_virtual_interface_group_association resource, use local_gateway_route_table_virtual_interface_group_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual local_gateway_route_table_virtual_interf Namelocal_gateway_route_table_virtual_interface_group_association TypeResource DescriptionDescribes a local gateway route table virtual interface group association for a local gateway. -Idaws.ec2.local_gateway_route_table_virtual_interface_group_association +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the local gateway route table virtual interface group.
owner_idstringThe owner of the local gateway route table virtual interface group association.
statestringThe state of the local gateway route table virtual interface group association.
tagsarrayThe tags for the local gateway route table virtual interface group association.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual local_gateway_route_table_virtual_interf Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md index b5a2fc3a8f..3c25576a58 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of local_gateway_route_table_virtual_interface_group_associations in a region or create a local_gateway_route_table_virtual_interface_group_associations resource, use local_gateway_route_table_virtual_interface_group_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of local_gateway_route_table_virtual_interface_gro Namelocal_gateway_route_table_virtual_interface_group_associations TypeResource DescriptionDescribes a local gateway route table virtual interface group association for a local gateway. -Idaws.ec2.local_gateway_route_table_virtual_interface_group_associations +Id ## Fields - - + +
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
regionstringAWS region.
stringThe ID of the local gateway route table virtual interface group association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of local_gateway_route_table_virtual_interface_gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md index 434821aebd..366ef4bb43 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of local_gateway_route_tables in a region or create a local_gateway_route_tables resource, use local_gateway_route_table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of local_gateway_route_tables in a region o Namelocal_gateway_route_tables TypeResource DescriptionDescribes a route table for a local gateway. -Idaws.ec2.local_gateway_route_tables +Id ## Fields - - + +
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
stringThe ID of the local gateway route table.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of local_gateway_route_tables in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md index c1e074820a..3e6a267f12 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual local_gateway_route_tablevpc_association resource, use local_gateway_route_tablevpc_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual local_gateway_route_tablevpc_association Namelocal_gateway_route_tablevpc_association TypeResource DescriptionDescribes an association between a local gateway route table and a VPC. -Idaws.ec2.local_gateway_route_tablevpc_association +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_vpc_association_idstringThe ID of the association.
statestringThe state of the association.
vpc_idstringThe ID of the VPC.
tagsarrayThe tags for the association.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual local_gateway_route_tablevpc_association Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md index 690381c464..3f36389dd1 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of local_gateway_route_tablevpc_associations in a region or create a local_gateway_route_tablevpc_associations resource, use local_gateway_route_tablevpc_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of local_gateway_route_tablevpc_associationsNamelocal_gateway_route_tablevpc_associations TypeResource DescriptionDescribes an association between a local gateway route table and a VPC. -Idaws.ec2.local_gateway_route_tablevpc_associations +Id ## Fields - - + +
NameDatatypeDescription
local_gateway_route_table_vpc_association_idstringThe ID of the association.
regionstringAWS region.
stringThe ID of the association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of local_gateway_route_tablevpc_associationsRequired Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md index 003eb6c9ba..3c33d6821c 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of local_gateway_routes in a region or create a local_gateway_routes resource, use local_gateway_route to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of local_gateway_routes in a region or crea Namelocal_gateway_routes TypeResource DescriptionDescribes a route for a local gateway route table. -Idaws.ec2.local_gateway_routes +Id ## Fields - - - + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
stringThe CIDR block used for destination matches.
stringThe ID of the local gateway route table.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of local_gateway_routes in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md index 501bf25c39..8f367f89c9 100644 --- a/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual nat_gateway resource, use nat_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual nat_gateway resource, use n Namenat_gateway TypeResource DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.<br/> With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.<br/> If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.<br/> When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*. -Idaws.ec2.nat_gateway +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
secondary_allocation_idsarraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
private_ip_addressstringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
connectivity_typestringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
secondary_private_ip_addressesarraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
secondary_private_ip_address_countinteger[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
allocation_idstring[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
subnet_idstringThe ID of the subnet in which the NAT gateway is located.
nat_gateway_idstring
tagsarrayThe tags for the NAT gateway.
max_drain_duration_secondsintegerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
regionstringAWS region.
arraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
stringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
stringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
arraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``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*.<br/> ``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.
@@ -50,19 +53,19 @@ Gets or operates on an individual nat_gateway resource, use n Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md index 36268ae07f..b2e4603ddd 100644 --- a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of nat_gateways in a region or create a nat_gateways resource, use nat_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of nat_gateways in a region or create a Namenat_gateways TypeResource DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.<br/> With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.<br/> If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.<br/> When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*. -Idaws.ec2.nat_gateways +Id ## Fields - - + +
NameDatatypeDescription
nat_gateway_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of nat_gateways in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_acl/index.md b/docs/aws-docs/providers/aws/ec2/network_acl/index.md index 977771d9f8..cb53168e94 100644 --- a/docs/aws-docs/providers/aws/ec2/network_acl/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_acl/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_acl resource, use network_acls to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual network_acl resource, use n Namenetwork_acl TypeResource DescriptionSpecifies a network ACL for your VPC. -Idaws.ec2.network_acl +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
tagsarrayThe tags for the network ACL.
vpc_idstringThe ID of the VPC for the network ACL.
regionstringAWS region.
string
arrayThe tags for the network ACL.
stringThe ID of the VPC for the network ACL.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual network_acl resource, use n Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_acls/index.md b/docs/aws-docs/providers/aws/ec2/network_acls/index.md index adc58374db..918c4645e5 100644 --- a/docs/aws-docs/providers/aws/ec2/network_acls/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_acls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_acls in a region or create a network_acls resource, use network_acl to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_acls in a region or create a Namenetwork_acls TypeResource DescriptionSpecifies a network ACL for your VPC. -Idaws.ec2.network_acls +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_acls in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md index a4fbd2fd0b..123a5d5a68 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_insights_access_scope resource, use network_insights_access_scopes to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual network_insights_access_scope res Namenetwork_insights_access_scope TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope -Idaws.ec2.network_insights_access_scope +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
network_insights_access_scope_idstring
network_insights_access_scope_arnstring
created_datestring
updated_datestring
tagsarray
match_pathsarray
exclude_pathsarray
regionstringAWS region.
string
string
string
string
array
array
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual network_insights_access_scope res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md index f91eb20f62..a90015e21f 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_insights_access_scope_analyses in a region or create a network_insights_access_scope_analyses resource, use network_insights_access_scope_analysis to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_insights_access_scope_analyses i Namenetwork_insights_access_scope_analyses TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis -Idaws.ec2.network_insights_access_scope_analyses +Id ## Fields - - + +
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_insights_access_scope_analyses i Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md index 8b2bb7e146..e44e73ed0a 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_insights_access_scope_analysis resource, use network_insights_access_scope_analyses to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual network_insights_access_scope_analysisNamenetwork_insights_access_scope_analysis TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis -Idaws.ec2.network_insights_access_scope_analysis +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
network_insights_access_scope_analysis_arnstring
network_insights_access_scope_idstring
statusstring
status_messagestring
start_datestring
end_datestring
findings_foundstring
analyzed_eni_countinteger
tagsarray
regionstringAWS region.
string
string
string
string
string
string
string
string
integer
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual network_insights_access_scope_analysisRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md index c63372aa37..d63472377b 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_insights_access_scopes in a region or create a network_insights_access_scopes resource, use network_insights_access_scope to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_insights_access_scopes in a regi Namenetwork_insights_access_scopes TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope -Idaws.ec2.network_insights_access_scopes +Id ## Fields - - + +
NameDatatypeDescription
network_insights_access_scope_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_insights_access_scopes in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md index 82486a1261..1a304ff746 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_insights_analyses in a region or create a network_insights_analyses resource, use network_insights_analysis to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_insights_analyses in a region or Namenetwork_insights_analyses TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis -Idaws.ec2.network_insights_analyses +Id ## Fields - - + +
NameDatatypeDescription
network_insights_analysis_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_insights_analyses in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md index b7922f83a9..0291c8a172 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_insights_analysis resource, use network_insights_analyses to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual network_insights_analysis resourc Namenetwork_insights_analysis TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis -Idaws.ec2.network_insights_analysis +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
statusstring
return_path_componentsarray
network_insights_analysis_idstring
network_insights_path_idstring
network_path_foundboolean
suggested_accountsarray
filter_in_arnsarray
network_insights_analysis_arnstring
status_messagestring
start_datestring
alternate_path_hintsarray
explanationsarray
forward_path_componentsarray
additional_accountsarray
tagsarray
regionstringAWS region.
string
array
string
string
boolean
array
array
string
string
string
array
array
array
array
array
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual network_insights_analysis resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md index 858f661080..79e78c3849 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_insights_path resource, use network_insights_paths to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual network_insights_path resource, u Namenetwork_insights_path TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsPath -Idaws.ec2.network_insights_path +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
network_insights_path_idstring
network_insights_path_arnstring
created_datestring
source_ipstring
filter_at_sourceobject
filter_at_destinationobject
destination_ipstring
sourcestring
destinationstring
source_arnstring
destination_arnstring
protocolstring
destination_portinteger
tagsarray
regionstringAWS region.
string
string
string
string
object
object
string
string
string
string
string
string
integer
array
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual network_insights_path resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md index 8035f38f09..f1b12503c1 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_insights_paths in a region or create a network_insights_paths resource, use network_insights_path to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_insights_paths in a region or cr Namenetwork_insights_paths TypeResource DescriptionResource schema for AWS::EC2::NetworkInsightsPath -Idaws.ec2.network_insights_paths +Id ## Fields - - + +
NameDatatypeDescription
network_insights_path_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_insights_paths in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface/index.md b/docs/aws-docs/providers/aws/ec2/network_interface/index.md index 5a30de054d..d26ab78b55 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interface/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interface/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_interface resource, use network_interfaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,35 +24,35 @@ Gets or operates on an individual network_interface resource, use < Namenetwork_interface TypeResource DescriptionThe AWS::EC2::NetworkInterface resource creates network interface -Idaws.ec2.network_interface +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description for the network interface.
private_ip_addressstringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
private_ip_addressesarrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
secondary_private_ip_address_countintegerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
primary_private_ip_addressstringReturns the primary private IP address of the network interface.
ipv4_prefixesarrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv4_prefix_countintegerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
group_setarrayA list of security group IDs associated with this network interface.
ipv6_addressesarrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
ipv6_prefixesarrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
ipv6_prefix_countintegerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
subnet_idstringThe ID of the subnet to associate with the network interface.
source_dest_checkbooleanIndicates whether traffic to or from the instance is validated.
interface_typestringIndicates the type of network interface.
secondary_private_ip_addressesarrayReturns the secondary private IP addresses of the network interface.
ipv6_address_countintegerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
enable_primary_ipv6booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
primary_ipv6_addressstringThe primary IPv6 address
connection_tracking_specificationobject
idstringNetwork interface id.
tagsarrayAn arbitrary set of tags (key-value pairs) for this network interface.
vpc_idstringThe ID of the VPC
regionstringAWS region.
stringA description for the network interface.
stringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
arrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
integerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
stringReturns the primary private IP address of the network interface.
arrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
integerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
arrayA list of security group IDs associated with this network interface.
arrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
arrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
integerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringThe ID of the subnet to associate with the network interface.
booleanIndicates whether traffic to or from the instance is validated.
stringIndicates the type of network interface.
arrayReturns the secondary private IP addresses of the network interface.
integerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
stringThe primary IPv6 address
object
stringNetwork interface id.
arrayAn arbitrary set of tags (key-value pairs) for this network interface.
stringThe ID of the VPC
stringAWS region.
@@ -62,19 +65,19 @@ Gets or operates on an individual network_interface resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md index f6ed95a529..871da96b24 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_interface_attachment resource, use network_interface_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual network_interface_attachment reso Namenetwork_interface_attachment TypeResource DescriptionResource Type definition for AWS::EC2::NetworkInterfaceAttachment -Idaws.ec2.network_interface_attachment +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
delete_on_terminationbooleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
device_indexstringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
instance_idstringThe ID of the instance to which you will attach the ENI.
network_interface_idstringThe ID of the ENI that you want to attach.
ena_srd_specificationobject
regionstringAWS region.
stringThe ID of the network interface attachment.
booleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
stringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
stringThe ID of the instance to which you will attach the ENI.
stringThe ID of the ENI that you want to attach.
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual network_interface_attachment reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md index ae53bba608..bd02340058 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_interface_attachments in a region or create a network_interface_attachments resource, use network_interface_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_interface_attachments in a regio Namenetwork_interface_attachments TypeResource DescriptionResource Type definition for AWS::EC2::NetworkInterfaceAttachment -Idaws.ec2.network_interface_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
regionstringAWS region.
stringThe ID of the network interface attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_interface_attachments in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md index ec0b3dbffd..b4b6c3aa6f 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_interfaces in a region or create a network_interfaces resource, use network_interface to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_interfaces in a region or create Namenetwork_interfaces TypeResource DescriptionThe AWS::EC2::NetworkInterface resource creates network interface -Idaws.ec2.network_interfaces +Id ## Fields - - + +
NameDatatypeDescription
idstringNetwork interface id.
regionstringAWS region.
stringNetwork interface id.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_interfaces in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md index a5fc06b319..e4b6718164 100644 --- a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_performance_metric_subscription resource, use network_performance_metric_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual network_performance_metric_subscription< Namenetwork_performance_metric_subscription TypeResource DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription -Idaws.ec2.network_performance_metric_subscription +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual network_performance_metric_subscription< Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md index 48827a8298..732720f046 100644 --- a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_performance_metric_subscriptions in a region or create a network_performance_metric_subscriptions resource, use network_performance_metric_subscription to operate on an individual resource. ## Overview @@ -21,17 +24,17 @@ Used to retrieve a list of network_performance_metric_subscriptions Namenetwork_performance_metric_subscriptions TypeResource DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription -Idaws.ec2.network_performance_metric_subscriptions +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Used to retrieve a list of network_performance_metric_subscriptions Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/placement_group/index.md b/docs/aws-docs/providers/aws/ec2/placement_group/index.md index 2d900ce857..df41348531 100644 --- a/docs/aws-docs/providers/aws/ec2/placement_group/index.md +++ b/docs/aws-docs/providers/aws/ec2/placement_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual placement_group resource, use placement_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual placement_group resource, use Nameplacement_group TypeResource DescriptionResource Type definition for AWS::EC2::PlacementGroup -Idaws.ec2.placement_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
strategystringThe placement strategy.
group_namestringThe Group Name of Placement Group.
spread_levelstringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
partition_countintegerThe number of partitions. Valid only when **Strategy** is set to `partition`
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual placement_group resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md index b88f560cba..8323cc5ae8 100644 --- a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of placement_groups in a region or create a placement_groups resource, use placement_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of placement_groups in a region or create a Nameplacement_groups TypeResource DescriptionResource Type definition for AWS::EC2::PlacementGroup -Idaws.ec2.placement_groups +Id ## Fields - - + +
NameDatatypeDescription
group_namestringThe Group Name of Placement Group.
regionstringAWS region.
stringThe Group Name of Placement Group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of placement_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_list/index.md b/docs/aws-docs/providers/aws/ec2/prefix_list/index.md index d6f6cad33d..10af9ee4ae 100644 --- a/docs/aws-docs/providers/aws/ec2/prefix_list/index.md +++ b/docs/aws-docs/providers/aws/ec2/prefix_list/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual prefix_list resource, use prefix_lists to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual prefix_list resource, use p Nameprefix_list TypeResource DescriptionResource schema of AWS::EC2::PrefixList Type -Idaws.ec2.prefix_list +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
prefix_list_namestringName of Prefix List.
prefix_list_idstringId of Prefix List.
owner_idstringOwner Id of Prefix List.
address_familystringIp Version of Prefix List.
max_entriesintegerMax Entries of Prefix List.
versionintegerVersion of Prefix List.
tagsarrayTags for Prefix List
entriesarrayEntries of Prefix List.
arnstringThe Amazon Resource Name (ARN) of the Prefix List.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual prefix_list resource, use p Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md index cf142cef2d..1936a4b7c6 100644 --- a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md +++ b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of prefix_lists in a region or create a prefix_lists resource, use prefix_list to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of prefix_lists in a region or create a Nameprefix_lists TypeResource DescriptionResource schema of AWS::EC2::PrefixList Type -Idaws.ec2.prefix_lists +Id ## Fields - - + +
NameDatatypeDescription
prefix_list_idstringId of Prefix List.
regionstringAWS region.
stringId of Prefix List.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of prefix_lists in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/route/index.md b/docs/aws-docs/providers/aws/ec2/route/index.md index cf9c780cae..413cd2b1b7 100644 --- a/docs/aws-docs/providers/aws/ec2/route/index.md +++ b/docs/aws-docs/providers/aws/ec2/route/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route resource, use routes to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual route resource, use routes< Nameroute TypeResource DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.<br/> You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.<br/> If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource. -Idaws.ec2.route +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.<br/> You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
cidr_blockstring
core_network_arnstringThe Amazon Resource Name (ARN) of the core network.
destination_cidr_blockstringThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.
destination_ipv6_cidr_blockstringThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
destination_prefix_list_idstringThe ID of a prefix list used for the destination match.
egress_only_internet_gateway_idstring[IPv6 traffic only] The ID of an egress-only internet gateway.
gateway_idstringThe ID of an internet gateway or virtual private gateway attached to your VPC.
instance_idstringThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
local_gateway_idstringThe ID of the local gateway.
nat_gateway_idstring[IPv4 traffic only] The ID of a NAT gateway.
network_interface_idstringThe ID of a network interface.
route_table_idstringThe ID of the route table for the route.
transit_gateway_idstringThe ID of a transit gateway.
vpc_endpoint_idstringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
vpc_peering_connection_idstringThe ID of a VPC peering connection.
regionstringAWS region.
stringThe ID of the carrier gateway.<br/> You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual route resource, use routes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/route_table/index.md b/docs/aws-docs/providers/aws/ec2/route_table/index.md index d189f97e4a..6cec306268 100644 --- a/docs/aws-docs/providers/aws/ec2/route_table/index.md +++ b/docs/aws-docs/providers/aws/ec2/route_table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route_table resource, use route_tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual route_table resource, use r Nameroute_table TypeResource DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.<br/> For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. -Idaws.ec2.route_table +Id ## Fields - - - - + + + +
NameDatatypeDescription
route_table_idstring
tagsarrayAny tags assigned to the route table.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
string
arrayAny tags assigned to the route table.
stringThe ID of the VPC.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual route_table resource, use r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/route_tables/index.md b/docs/aws-docs/providers/aws/ec2/route_tables/index.md index 48e2c9c0d3..5e434bb920 100644 --- a/docs/aws-docs/providers/aws/ec2/route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/route_tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of route_tables in a region or create a route_tables resource, use route_table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of route_tables in a region or create a Nameroute_tables TypeResource DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.<br/> For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. -Idaws.ec2.route_tables +Id ## Fields - - + +
NameDatatypeDescription
route_table_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of route_tables in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/routes/index.md b/docs/aws-docs/providers/aws/ec2/routes/index.md index 496a33777a..0ca9ecc778 100644 --- a/docs/aws-docs/providers/aws/ec2/routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/routes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of routes in a region or create a routes resource, use route to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of routes in a region or create a rou Nameroutes TypeResource DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.<br/> You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.<br/> If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource. -Idaws.ec2.routes +Id ## Fields - - - + + +
NameDatatypeDescription
route_table_idstringThe ID of the route table for the route.
cidr_blockstring
regionstringAWS region.
stringThe ID of the route table for the route.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of routes in a region or create a rou Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/security_group/index.md b/docs/aws-docs/providers/aws/ec2/security_group/index.md index 9b6951a118..ef5807c792 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_group resource, use security_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual security_group resource, use Namesecurity_group TypeResource DescriptionResource Type definition for AWS::EC2::SecurityGroup -Idaws.ec2.security_group +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
group_descriptionstringA description for the security group.
group_namestringThe name of the security group.
vpc_idstringThe ID of the VPC for the security group.
idstringThe group name or group ID depending on whether the SG is created in default or specific VPC
security_group_ingressarrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
security_group_egressarray[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
tagsarrayAny tags assigned to the security group.
group_idstringThe group ID of the specified security group.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual security_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md index 54c859d306..942cb2c823 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_group_egress resource, use security_group_egresses to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual security_group_egress resource, u Namesecurity_group_egress TypeResource DescriptionAdds the specified outbound (egress) rule to a security group.<br/> An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).<br/> You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.<br/> You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.<br/> Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. -Idaws.ec2.security_group_egress +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
cidr_ipstringThe IPv4 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
cidr_ipv6stringThe IPv6 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
descriptionstringThe description of an egress (outbound) security group rule.<br/> Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
from_portintegerIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
to_portintegerIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
ip_protocolstringThe IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).<br/> Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
destination_security_group_idstringThe ID of the security group.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
idstring
destination_prefix_list_idstringThe prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
regionstringAWS region.
stringThe IPv4 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe IPv6 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe description of an egress (outbound) security group rule.<br/> Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
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)).<br/> Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
stringThe ID of the security group.<br/> 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.<br/> 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.
@@ -50,19 +53,19 @@ Gets or operates on an individual security_group_egress resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md index 19bd77d2c5..b77abc2ba9 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_group_egresses in a region or create a security_group_egresses resource, use security_group_egress to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_group_egresses in a region or c Namesecurity_group_egresses TypeResource DescriptionAdds the specified outbound (egress) rule to a security group.<br/> An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).<br/> You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.<br/> You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.<br/> Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. -Idaws.ec2.security_group_egresses +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_group_egresses in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md index 8f986618fd..80a9a6fa75 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_group_ingress resource, use security_group_ingresses to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual security_group_ingress resource, Namesecurity_group_ingress TypeResource DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress -Idaws.ec2.security_group_ingress +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe Security Group Rule Id
cidr_ipstringThe IPv4 ranges
cidr_ipv6string[VPC only] The IPv6 ranges
descriptionstringUpdates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
from_portintegerThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
group_namestringThe name of the security group.
ip_protocolstringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).<br/><br/>[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
source_prefix_list_idstring[EC2-VPC only] The ID of a prefix list.<br/><br/>
source_security_group_idstringThe ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
source_security_group_namestring[EC2-Classic, default VPC] The name of the source security group.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
source_security_group_owner_idstring[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.<br/><br/>If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
to_portintegerThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
regionstringAWS region.
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.<br/><br/>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.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
stringThe name of the security group.
stringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).<br/><br/>[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
string[EC2-VPC only] The ID of a prefix list.<br/><br/>
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.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
string[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.<br/><br/>If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
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.<br/><br/>Use this for ICMP and any protocol that uses ports.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual security_group_ingress resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md index c6268244b1..7f9639fb30 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_group_ingresses in a region or create a security_group_ingresses resource, use security_group_ingress to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_group_ingresses in a region or Namesecurity_group_ingresses TypeResource DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress -Idaws.ec2.security_group_ingresses +Id ## Fields - - + +
NameDatatypeDescription
idstringThe Security Group Rule Id
regionstringAWS region.
stringThe Security Group Rule Id
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_group_ingresses in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/security_groups/index.md b/docs/aws-docs/providers/aws/ec2/security_groups/index.md index 36d70738ef..f9fe366cd7 100644 --- a/docs/aws-docs/providers/aws/ec2/security_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_groups in a region or create a security_groups resource, use security_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_groups in a region or create a Namesecurity_groups TypeResource DescriptionResource Type definition for AWS::EC2::SecurityGroup -Idaws.ec2.security_groups +Id ## Fields - - + +
NameDatatypeDescription
idstringThe group name or group ID depending on whether the SG is created in default or specific VPC
regionstringAWS region.
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md index 88b10637eb..d28624e644 100644 --- a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual snapshot_block_public_access resource, use snapshot_block_public_accesses to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual snapshot_block_public_access reso Namesnapshot_block_public_access TypeResource DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess -Idaws.ec2.snapshot_block_public_access +Id ## Fields - - - + + +
NameDatatypeDescription
statestringThe state of EBS Snapshot Block Public Access.
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
stringThe state of EBS Snapshot Block Public Access.
stringThe identifier for the specified AWS account.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual snapshot_block_public_access reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md index 4f3d5dcf48..9243056b9d 100644 --- a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of snapshot_block_public_accesses in a region or create a snapshot_block_public_accesses resource, use snapshot_block_public_access to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of snapshot_block_public_accesses in a regi Namesnapshot_block_public_accesses TypeResource DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess -Idaws.ec2.snapshot_block_public_accesses +Id ## Fields - - + +
NameDatatypeDescription
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
stringThe identifier for the specified AWS account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of snapshot_block_public_accesses in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/snapshots/index.md b/docs/aws-docs/providers/aws/ec2/snapshots/index.md index 659f620e19..9f324d8e2f 100644 --- a/docs/aws-docs/providers/aws/ec2/snapshots/index.md +++ b/docs/aws-docs/providers/aws/ec2/snapshots/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + List of snapshots by region (requires `aws` provider to be installed) ## Overview @@ -21,31 +24,31 @@ List of snapshots by region (requires `aws` provider to be installed) Namesnapshots TypeResource DescriptionList of snapshots by region (requires `aws` provider to be installed) -Idaws.ec2.snapshots +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description for the snapshot.
data_encryption_key_idstringThe data encryption key identifier for the snapshot.
encryptedbooleanIndicates whether the snapshot is encrypted.
kms_key_idstringThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
outpost_arnstring
owner_aliasstringThe Amazon Web Services owner alias.
owner_idstring
progressstringThe progress of the snapshot, as a percentage.
restore_expiry_timestringOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_idstringThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.
start_timestringThe time stamp when the snapshot was initiated.
statusstringThe snapshot state.
status_messagestringEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details.
storage_tierstringThe storage tier in which the snapshot is stored.
tag_setarray
volume_idstringThe ID of the volume that was used to create the snapshot.
volume_sizeintegerThe size of the volume, in GiB.
regionstring
regionstringAWS region.
stringThe description for the snapshot.
stringThe data encryption key identifier for the snapshot.
booleanIndicates whether the snapshot is encrypted.
stringThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
string
stringThe Amazon Web Services owner alias.
string
stringThe progress of the snapshot, as a percentage.
stringOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
stringThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.
stringThe time stamp when the snapshot was initiated.
stringThe snapshot state.
stringEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details.
stringThe storage tier in which the snapshot is stored.
array
stringThe ID of the volume that was used to create the snapshot.
integerThe size of the volume, in GiB.
string
stringAWS region.
@@ -58,9 +61,9 @@ List of snapshots by region (requires `aws` provider to be installed) Required Params - view + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md index f328e06588..31cfe3a063 100644 --- a/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md +++ b/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual spot_fleet resource, use spot_fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual spot_fleet resource, use sp Namespot_fleet TypeResource DescriptionResource Type definition for AWS::EC2::SpotFleet -Idaws.ec2.spot_fleet +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
spot_fleet_request_config_dataobject
regionstringAWS region.
string
object
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual spot_fleet resource, use sp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md index 9d140b5177..18b86c2de4 100644 --- a/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of spot_fleets in a region or create a spot_fleets resource, use spot_fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of spot_fleets in a region or create a Namespot_fleets TypeResource DescriptionResource Type definition for AWS::EC2::SpotFleet -Idaws.ec2.spot_fleets +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of spot_fleets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet/index.md b/docs/aws-docs/providers/aws/ec2/subnet/index.md index 1a99a12079..e49548eba7 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet resource, use subnets to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual subnet resource, use subnet Namesubnet TypeResource DescriptionSpecifies a subnet for the specified VPC.<br/> For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.<br/> For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*. -Idaws.ec2.subnet +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
assign_ipv6_address_on_creationbooleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
vpc_idstringThe ID of the VPC the subnet is in.<br/> If you update this property, you must also update the ``CidrBlock`` property.
map_public_ip_on_launchbooleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.<br/> AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
enable_lni_at_device_indexintegerIndicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).
network_acl_association_idstring
availability_zonestringThe Availability Zone of the subnet.<br/> If you update this property, you must also update the ``CidrBlock`` property.
availability_zone_idstringThe AZ ID of the subnet.
cidr_blockstringThe IPv4 CIDR block assigned to the subnet.<br/> If you update this property, we create a new subnet, and then delete the existing one.
subnet_idstring
ipv6_cidr_blocksarrayThe IPv6 network ranges for the subnet, in CIDR notation.
ipv6_cidr_blockstringThe IPv6 CIDR block.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
ipv6_nativebooleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
enable_dns64booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
private_dns_name_options_on_launchobjectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.<br/> Available options:<br/> + EnableResourceNameDnsAAAARecord (true | false)<br/> + EnableResourceNameDnsARecord (true | false)<br/> + HostnameType (ip-name | resource-name)
tagsarrayAny tags assigned to the subnet.
ipv4_ipam_pool_idstringAn IPv4 IPAM pool ID for the subnet.
ipv4_netmask_lengthintegerAn IPv4 netmask length for the subnet.
ipv6_ipam_pool_idstringAn IPv6 IPAM pool ID for the subnet.
ipv6_netmask_lengthintegerAn IPv6 netmask length for the subnet.
regionstringAWS region.
booleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
stringThe ID of the VPC the subnet is in.<br/> 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``.<br/> AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
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.<br/> 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.<br/> If you update this property, we create a new subnet, and then delete the existing one.
string
arrayThe IPv6 network ranges for the subnet, in CIDR notation.
stringThe IPv6 CIDR block.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
stringThe Amazon Resource Name (ARN) of the Outpost.
booleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
objectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.<br/> Available options:<br/> + EnableResourceNameDnsAAAARecord (true | false)<br/> + EnableResourceNameDnsARecord (true | false)<br/> + 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.
@@ -60,19 +63,19 @@ Gets or operates on an individual subnet resource, use subnet Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md index bf22266d1e..545db9c856 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet_cidr_block resource, use subnet_cidr_blocks to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual subnet_cidr_block resource, use < Namesubnet_cidr_block TypeResource DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR -Idaws.ec2.subnet_cidr_block +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstringInformation about the IPv6 association.
ipv6_cidr_blockstringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
ipv6_ipam_pool_idstringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
ipv6_netmask_lengthintegerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
subnet_idstringThe ID of the subnet
regionstringAWS region.
stringInformation about the IPv6 association.
stringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
stringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
integerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
stringThe ID of the subnet
stringAWS region.
@@ -45,14 +48,14 @@ Gets or operates on an individual subnet_cidr_block resource, use < Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md index 2a30ea5443..b9237930c0 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnet_cidr_blocks in a region or create a subnet_cidr_blocks resource, use subnet_cidr_block to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnet_cidr_blocks in a region or create Namesubnet_cidr_blocks TypeResource DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR -Idaws.ec2.subnet_cidr_blocks +Id ## Fields - - + +
NameDatatypeDescription
idstringInformation about the IPv6 association.
regionstringAWS region.
stringInformation about the IPv6 association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnet_cidr_blocks in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md index 1cb191f427..b9a939d94f 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet_network_acl_association resource, use subnet_network_acl_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual subnet_network_acl_association re Namesubnet_network_acl_association TypeResource DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation -Idaws.ec2.subnet_network_acl_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
subnet_idstringThe ID of the subnet
network_acl_idstringThe ID of the network ACL
association_idstring
regionstringAWS region.
stringThe ID of the subnet
stringThe ID of the network ACL
string
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual subnet_network_acl_association re Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md index e67e8231f1..82eb93d623 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnet_network_acl_associations in a region or create a subnet_network_acl_associations resource, use subnet_network_acl_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnet_network_acl_associations in a reg Namesubnet_network_acl_associations TypeResource DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation -Idaws.ec2.subnet_network_acl_associations +Id ## Fields - - + +
NameDatatypeDescription
association_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnet_network_acl_associations in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md index 330cb68142..5c44a526d7 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet_route_table_association resource, use subnet_route_table_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual subnet_route_table_association re Namesubnet_route_table_association TypeResource DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html). -Idaws.ec2.subnet_route_table_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
route_table_idstringThe ID of the route table.<br/> The physical ID changes when the route table ID is changed.
subnet_idstringThe ID of the subnet.
regionstringAWS region.
string
stringThe ID of the route table.<br/> The physical ID changes when the route table ID is changed.
stringThe ID of the subnet.
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual subnet_route_table_association re Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md index e50b76e5fc..49b92f9087 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnet_route_table_associations in a region or create a subnet_route_table_associations resource, use subnet_route_table_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnet_route_table_associations in a reg Namesubnet_route_table_associations TypeResource DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html). -Idaws.ec2.subnet_route_table_associations +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnet_route_table_associations in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/subnets/index.md b/docs/aws-docs/providers/aws/ec2/subnets/index.md index 0a81a2d264..5ed2f7e3bb 100644 --- a/docs/aws-docs/providers/aws/ec2/subnets/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnets in a region or create a subnets resource, use subnet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnets in a region or create a su Namesubnets TypeResource DescriptionSpecifies a subnet for the specified VPC.<br/> For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.<br/> For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*. -Idaws.ec2.subnets +Id ## Fields - - + +
NameDatatypeDescription
subnet_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnets in a region or create a su Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md index 22daadfb81..54a6534d94 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway resource, use transit_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual transit_gateway resource, use Nametransit_gateway TypeResource DescriptionResource Type definition for AWS::EC2::TransitGateway -Idaws.ec2.transit_gateway +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
association_default_route_table_idstring
auto_accept_shared_attachmentsstring
transit_gateway_arnstring
default_route_table_propagationstring
transit_gateway_cidr_blocksarray
propagation_default_route_table_idstring
default_route_table_associationstring
idstring
vpn_ecmp_supportstring
dns_supportstring
multicast_supportstring
amazon_side_asninteger
tagsarray
regionstringAWS region.
string
string
string
string
string
array
string
string
string
string
string
string
integer
array
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual transit_gateway resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md index 4fcae413dc..d4cc706cc4 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_attachment resource, use transit_gateway_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual transit_gateway_attachment resour Nametransit_gateway_attachment TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment -Idaws.ec2.transit_gateway_attachment +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
transit_gateway_idstring
vpc_idstring
subnet_idsarray
tagsarray
optionsobjectThe options for the transit gateway vpc attachment.
regionstringAWS region.
string
string
string
array
array
objectThe options for the transit gateway vpc attachment.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual transit_gateway_attachment resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md index cc3d44569a..7959b776ba 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_attachments in a region or create a transit_gateway_attachments resource, use transit_gateway_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_attachments in a region Nametransit_gateway_attachments TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment -Idaws.ec2.transit_gateway_attachments +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_attachments in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md index 295722f116..c4bf0d4b25 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_connect resource, use transit_gateway_connects to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual transit_gateway_connect resource, Nametransit_gateway_connect TypeResource DescriptionThe AWS::EC2::TransitGatewayConnect type -Idaws.ec2.transit_gateway_connect +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
transport_transit_gateway_attachment_idstringThe ID of the attachment from which the Connect attachment was created.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the attachment.
creation_timestringThe creation time.
tagsarrayThe tags for the attachment.
optionsobjectThe Connect attachment options.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual transit_gateway_connect resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md index 46688b41be..1351cf54cc 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_connects in a region or create a transit_gateway_connects resource, use transit_gateway_connect to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_connects in a region or Nametransit_gateway_connects TypeResource DescriptionThe AWS::EC2::TransitGatewayConnect type -Idaws.ec2.transit_gateway_connects +Id ## Fields - - + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
regionstringAWS region.
stringThe ID of the Connect attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_connects in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md index 5ead2cb115..f00efacaaa 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_multicast_domain resource, use transit_gateway_multicast_domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual transit_gateway_multicast_domain Nametransit_gateway_multicast_domain TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type -Idaws.ec2.transit_gateway_multicast_domain +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_multicast_domain_arnstringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the transit gateway multicast domain.
creation_timestringThe time the transit gateway multicast domain was created.
tagsarrayThe tags for the transit gateway multicast domain.
optionsobjectThe options for the transit gateway multicast domain.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual transit_gateway_multicast_domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md index 383243d354..cf5ba5bc8a 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_multicast_domain_association resource, use transit_gateway_multicast_domain_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual transit_gateway_multicast_domain_associa Nametransit_gateway_multicast_domain_association TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type -Idaws.ec2.transit_gateway_multicast_domain_association +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
statestringThe state of the subnet association.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual transit_gateway_multicast_domain_associa Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md index 62be2f9ce9..28c746bea0 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_multicast_domain_associations in a region or create a transit_gateway_multicast_domain_associations resource, use transit_gateway_multicast_domain_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of transit_gateway_multicast_domain_associationsNametransit_gateway_multicast_domain_associations TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type -Idaws.ec2.transit_gateway_multicast_domain_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Used to retrieve a list of transit_gateway_multicast_domain_associationsRequired Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md index 282b71972b..241c1392dd 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_multicast_domains in a region or create a transit_gateway_multicast_domains resource, use transit_gateway_multicast_domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_multicast_domains in a r Nametransit_gateway_multicast_domains TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type -Idaws.ec2.transit_gateway_multicast_domains +Id ## Fields - - + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
regionstringAWS region.
stringThe ID of the transit gateway multicast domain.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_multicast_domains in a r Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md index b1f049a07f..110727bc2b 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_multicast_group_member resource, use transit_gateway_multicast_group_members to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual transit_gateway_multicast_group_memberNametransit_gateway_multicast_group_member TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group -Idaws.ec2.transit_gateway_multicast_group_member +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe member type (for example, static).
stringThe source type.
stringAWS region.
@@ -51,14 +54,14 @@ Gets or operates on an individual transit_gateway_multicast_group_memberRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md index 8806430b93..5c36be0def 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_multicast_group_members in a region or create a transit_gateway_multicast_group_members resource, use transit_gateway_multicast_group_member to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of transit_gateway_multicast_group_members Nametransit_gateway_multicast_group_members TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group -Idaws.ec2.transit_gateway_multicast_group_members +Id ## Fields - - - - + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
stringThe ID of the transit gateway multicast domain.
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of transit_gateway_multicast_group_members Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md index 392b71b75e..d832a672df 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_multicast_group_source resource, use transit_gateway_multicast_group_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual transit_gateway_multicast_group_sourceNametransit_gateway_multicast_group_source TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group -Idaws.ec2.transit_gateway_multicast_group_source +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe member type (for example, static).
stringThe source type.
stringAWS region.
@@ -51,14 +54,14 @@ Gets or operates on an individual transit_gateway_multicast_group_sourceRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md index 289e2ff980..4a94b63069 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_multicast_group_sources in a region or create a transit_gateway_multicast_group_sources resource, use transit_gateway_multicast_group_source to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of transit_gateway_multicast_group_sources Nametransit_gateway_multicast_group_sources TypeResource DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group -Idaws.ec2.transit_gateway_multicast_group_sources +Id ## Fields - - - - + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
stringThe ID of the transit gateway multicast domain.
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of transit_gateway_multicast_group_sources Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md index 39fbaf4d4b..9877ff570e 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_peering_attachment resource, use transit_gateway_peering_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual transit_gateway_peering_attachmentNametransit_gateway_peering_attachment TypeResource DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type -Idaws.ec2.transit_gateway_peering_attachment +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
statusobjectThe status of the transit gateway peering attachment.
transit_gateway_idstringThe ID of the transit gateway.
peer_transit_gateway_idstringThe ID of the peer transit gateway.
peer_account_idstringThe ID of the peer account
statestringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
creation_timestringThe time the transit gateway peering attachment was created.
peer_regionstringPeer Region
tagsarrayThe tags for the transit gateway peering attachment.
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual transit_gateway_peering_attachmentRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md index 723b99f373..d61fe068c8 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_peering_attachments in a region or create a transit_gateway_peering_attachments resource, use transit_gateway_peering_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_peering_attachments in a Nametransit_gateway_peering_attachments TypeResource DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type -Idaws.ec2.transit_gateway_peering_attachments +Id ## Fields - - + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
stringThe ID of the transit gateway peering attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_peering_attachments in a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md index f50a5041d0..52394da445 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_route_table resource, use transit_gateway_route_tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual transit_gateway_route_table resou Nametransit_gateway_route_table TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable -Idaws.ec2.transit_gateway_route_table +Id ## Fields - - - - + + + +
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
transit_gateway_idstringThe ID of the transit gateway.
tagsarrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Gets or operates on an individual transit_gateway_route_table resou Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md index ac763dec23..b0ba97cee2 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_route_table_association resource, use transit_gateway_route_table_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual transit_gateway_route_table_association< Nametransit_gateway_route_table_association TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation -Idaws.ec2.transit_gateway_route_table_association +Id ## Fields - - - + + +
NameDatatypeDescription
transit_gateway_route_table_idstringThe ID of transit gateway route table.
transit_gateway_attachment_idstringThe ID of transit gateway attachment.
regionstringAWS region.
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual transit_gateway_route_table_association< Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md index bf30b5831d..21c0ff0b3f 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_route_table_associations in a region or create a transit_gateway_route_table_associations resource, use transit_gateway_route_table_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of transit_gateway_route_table_associations Nametransit_gateway_route_table_associations TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation -Idaws.ec2.transit_gateway_route_table_associations +Id ## Fields - - - + + +
NameDatatypeDescription
transit_gateway_route_table_idstringThe ID of transit gateway route table.
transit_gateway_attachment_idstringThe ID of transit gateway attachment.
regionstringAWS region.
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of transit_gateway_route_table_associations Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md index f4eb58fbac..48e25600ea 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_route_tables in a region or create a transit_gateway_route_tables resource, use transit_gateway_route_table to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_route_tables in a region Nametransit_gateway_route_tables TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable -Idaws.ec2.transit_gateway_route_tables +Id ## Fields - - + +
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
regionstringAWS region.
stringTransit Gateway Route Table primary identifier
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_route_tables in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md index cf80e52a37..7b77f3bdbe 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_vpc_attachment resource, use transit_gateway_vpc_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual transit_gateway_vpc_attachment re Nametransit_gateway_vpc_attachment TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment -Idaws.ec2.transit_gateway_vpc_attachment +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
optionsobjectThe options for the transit gateway vpc attachment.
transit_gateway_idstring
vpc_idstring
remove_subnet_idsarray
idstring
subnet_idsarray
add_subnet_idsarray
tagsarray
regionstringAWS region.
objectThe options for the transit gateway vpc attachment.
string
string
array
string
array
array
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual transit_gateway_vpc_attachment re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md index c990d2b210..88543dd28d 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_vpc_attachments in a region or create a transit_gateway_vpc_attachments resource, use transit_gateway_vpc_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_vpc_attachments in a reg Nametransit_gateway_vpc_attachments TypeResource DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment -Idaws.ec2.transit_gateway_vpc_attachments +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_vpc_attachments in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md index 59c3e4d1f7..5c4392b517 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateways in a region or create a transit_gateways resource, use transit_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateways in a region or create a Nametransit_gateways TypeResource DescriptionResource Type definition for AWS::EC2::TransitGateway -Idaws.ec2.transit_gateways +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateways in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md index e78c0af220..da4d644ba3 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual verified_access_endpoint resource, use verified_access_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,34 +24,34 @@ Gets or operates on an individual verified_access_endpoint resource Nameverified_access_endpoint TypeResource DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint. -Idaws.ec2.verified_access_endpoint +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
statusstringThe endpoint status.
security_group_idsarrayThe IDs of the security groups for the endpoint.
network_interface_optionsobjectThe options for network-interface type endpoint.
load_balancer_optionsobjectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
endpoint_typestringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
endpoint_domainstringA DNS name that is generated for the endpoint.
endpoint_domain_prefixstringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
device_validation_domainstringReturned if endpoint has a device trust provider attached.
domain_certificate_arnstringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
attachment_typestringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
application_domainstringThe DNS name for users to reach your application.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
descriptionstringA description for the AWS Verified Access endpoint.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
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.
@@ -61,19 +64,19 @@ Gets or operates on an individual verified_access_endpoint resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md index 162d7a2266..854a7213fd 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of verified_access_endpoints in a region or create a verified_access_endpoints resource, use verified_access_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of verified_access_endpoints in a region or Nameverified_access_endpoints TypeResource DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint. -Idaws.ec2.verified_access_endpoints +Id ## Fields - - + +
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
regionstringAWS region.
stringThe ID of the AWS Verified Access endpoint.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of verified_access_endpoints in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md index 63d9bdc096..dd7c75f17a 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual verified_access_group resource, use verified_access_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual verified_access_group resource, u Nameverified_access_group TypeResource DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group. -Idaws.ec2.verified_access_group +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_group_arnstringThe ARN of the Verified Access group.
ownerstringThe AWS account number that owns the group.
creation_timestringTime this Verified Access Group was created.
last_updated_timestringTime this Verified Access Group was last updated.
descriptionstringA description for the AWS Verified Access group.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual verified_access_group resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md index 302c0a226d..575f95dfc9 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of verified_access_groups in a region or create a verified_access_groups resource, use verified_access_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of verified_access_groups in a region or cr Nameverified_access_groups TypeResource DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group. -Idaws.ec2.verified_access_groups +Id ## Fields - - + +
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
regionstringAWS region.
stringThe ID of the AWS Verified Access group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of verified_access_groups in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md index 05a875c904..13d2ed4004 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual verified_access_instance resource, use verified_access_instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual verified_access_instance resource Nameverified_access_instance TypeResource DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance. -Idaws.ec2.verified_access_instance +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_trust_providersarrayAWS Verified Access trust providers.
verified_access_trust_provider_idsarrayThe IDs of the AWS Verified Access trust providers.
creation_timestringTime this Verified Access Instance was created.
last_updated_timestringTime this Verified Access Instance was last updated.
descriptionstringA description for the AWS Verified Access instance.
logging_configurationsobjectThe configuration options for AWS Verified Access instances.
tagsarrayAn array of key-value pairs to apply to this resource.
fips_enabledbooleanIndicates whether FIPS is enabled
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual verified_access_instance resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md index 710371eb08..83d9f66c16 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of verified_access_instances in a region or create a verified_access_instances resource, use verified_access_instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of verified_access_instances in a region or Nameverified_access_instances TypeResource DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance. -Idaws.ec2.verified_access_instances +Id ## Fields - - + +
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
regionstringAWS region.
stringThe ID of the AWS Verified Access instance.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of verified_access_instances in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md index c17b5f0573..8aa7b22f59 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual verified_access_trust_provider resource, use verified_access_trust_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual verified_access_trust_provider re Nameverified_access_trust_provider TypeResource DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider -Idaws.ec2.verified_access_trust_provider +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
trust_provider_typestringType of trust provider. Possible values: user|device
device_trust_provider_typestringThe type of device-based trust provider. Possible values: jamf|crowdstrike
user_trust_provider_typestringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
oidc_optionsobject
device_optionsobject
policy_reference_namestringThe identifier to be used when working with policy rules.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
descriptionstringA description for the Amazon Web Services Verified Access trust provider.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
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
object
object
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual verified_access_trust_provider re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md index 19533ce8de..58840fe783 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of verified_access_trust_providers in a region or create a verified_access_trust_providers resource, use verified_access_trust_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of verified_access_trust_providers in a reg Nameverified_access_trust_providers TypeResource DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider -Idaws.ec2.verified_access_trust_providers +Id ## Fields - - + +
NameDatatypeDescription
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
regionstringAWS region.
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of verified_access_trust_providers in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/volume/index.md b/docs/aws-docs/providers/aws/ec2/volume/index.md index 7960f30bef..93e7e9e1ae 100644 --- a/docs/aws-docs/providers/aws/ec2/volume/index.md +++ b/docs/aws-docs/providers/aws/ec2/volume/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual volume resource, use volumes to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual volume resource, use volume Namevolume TypeResource DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.<br/> When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.<br/> Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.<br/> Some common scenarios when you might encounter a cooldown period for Amazon EBS include:<br/> + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.<br/> + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.<br/> <br/> For more information on the coo -Idaws.ec2.volume +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
multi_attach_enabledbooleanIndicates whether Amazon EBS Multi-Attach is enabled.<br/> CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
kms_key_idstringThe identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.<br/> If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.<br/> Alternatively, if you want to specify a different key, you can specify one of the following:<br/> + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.<br/> + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
encryptedbooleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
sizeintegerThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.<br/> The following are the supported volumes sizes for each volume type:<br/> + ``gp2`` and ``gp3``: 1 - 16,384 GiB<br/> + ``io1``: 4 - 16,384 GiB<br/> + ``io2``: 4 - 65,536 GiB<br/> + ``st1`` and ``sc1``: 125 - 16,384 GiB<br/> + ``standard``: 1 - 1024 GiB
auto_enable_iobooleanIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
availability_zonestringThe ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.
throughputintegerThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.<br/> This parameter is valid only for ``gp3`` volumes. The default value is 125.<br/> Valid Range: Minimum value of 125. Maximum value of 1000.
iopsintegerThe number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.<br/> The following are the supported values for each volume type:<br/> + ``gp3``: 3,000 - 16,000 IOPS<br/> + ``io1``: 100 - 64,000 IOPS<br/> + ``io2``: 100 - 256,000 IOPS<br/> <br/> For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.<br/> This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
snapshot_idstringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
volume_typestringThe volume type. This parameter can be one of the following values:<br/> + General Purpose SSD: ``gp2`` | ``gp3`` <br/> + Provisioned IOPS SSD: ``io1`` | ``io2`` <br/> + Throughput Optimized HDD: ``st1`` <br/> + Cold HDD: ``sc1`` <br/> + Magnetic: ``standard`` <br/> <br/> For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Default: ``gp2``
volume_idstring
tagsarrayThe tags to apply to the volume during creation.
regionstringAWS region.
booleanIndicates whether Amazon EBS Multi-Attach is enabled.<br/> CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
stringThe identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.<br/> If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.<br/> Alternatively, if you want to specify a different key, you can specify one of the following:<br/> + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.<br/> + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
booleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
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.<br/> The following are the supported volumes sizes for each volume type:<br/> + ``gp2`` and ``gp3``: 1 - 16,384 GiB<br/> + ``io1``: 4 - 16,384 GiB<br/> + ``io2``: 4 - 65,536 GiB<br/> + ``st1`` and ``sc1``: 125 - 16,384 GiB<br/> + ``standard``: 1 - 1024 GiB
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.<br/> This parameter is valid only for ``gp3`` volumes. The default value is 125.<br/> Valid Range: Minimum value of 125. Maximum value of 1000.
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.<br/> The following are the supported values for each volume type:<br/> + ``gp3``: 3,000 - 16,000 IOPS<br/> + ``io1``: 100 - 64,000 IOPS<br/> + ``io2``: 100 - 256,000 IOPS<br/> <br/> For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.<br/> This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
stringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
stringThe volume type. This parameter can be one of the following values:<br/> + General Purpose SSD: ``gp2`` | ``gp3`` <br/> + Provisioned IOPS SSD: ``io1`` | ``io2`` <br/> + Throughput Optimized HDD: ``st1`` <br/> + Cold HDD: ``sc1`` <br/> + Magnetic: ``standard`` <br/> <br/> For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Default: ``gp2``
string
arrayThe tags to apply to the volume during creation.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual volume resource, use volume Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md index 5586f20157..f5408e1a3b 100644 --- a/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual volume_attachment resource, use volume_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual volume_attachment resource, use < Namevolume_attachment TypeResource DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.<br/> Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.<br/> If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.<br/> If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance. -Idaws.ec2.volume_attachment +Id ## Fields - - - - + + + +
NameDatatypeDescription
volume_idstringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idstringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
devicestringThe device name (for example, ``/dev/sdh`` or ``xvdh``).
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Gets or operates on an individual volume_attachment resource, use < Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md index 8388289dfa..0170a82331 100644 --- a/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of volume_attachments in a region or create a volume_attachments resource, use volume_attachment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of volume_attachments in a region or create Namevolume_attachments TypeResource DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.<br/> Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.<br/> If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.<br/> If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance. -Idaws.ec2.volume_attachments +Id ## Fields - - - + + +
NameDatatypeDescription
volume_idundefinedThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idundefinedThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
regionstringAWS region.
undefinedThe 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.
undefinedThe 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.
@@ -42,14 +45,14 @@ Used to retrieve a list of volume_attachments in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/volumes/index.md b/docs/aws-docs/providers/aws/ec2/volumes/index.md index 8140760df8..3569fe394b 100644 --- a/docs/aws-docs/providers/aws/ec2/volumes/index.md +++ b/docs/aws-docs/providers/aws/ec2/volumes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of volumes in a region or create a volumes resource, use volume to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of volumes in a region or create a vo Namevolumes TypeResource DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.<br/> When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.<br/> Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.<br/> Some common scenarios when you might encounter a cooldown period for Amazon EBS include:<br/> + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.<br/> + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.<br/> <br/> For more information on the coo -Idaws.ec2.volumes +Id ## Fields - - + +
NameDatatypeDescription
volume_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of volumes in a region or create a vo Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc/index.md b/docs/aws-docs/providers/aws/ec2/vpc/index.md index 8ae3bd17fb..e4008cace5 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc resource, use vpcs to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual vpc resource, use vpcsNamevpc TypeResource DescriptionSpecifies a virtual private cloud (VPC).<br/> You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).<br/> For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*. -Idaws.ec2.vpc +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
vpc_idstring
instance_tenancystringThe allowed tenancy of instances launched into the VPC.<br/> + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.<br/> + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.<br/> <br/> Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
ipv4_netmask_lengthintegerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
cidr_block_associationsarray
cidr_blockstringThe IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
ipv4_ipam_pool_idstringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
default_network_aclstring
enable_dns_supportbooleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
ipv6_cidr_blocksarray
default_security_groupstring
enable_dns_hostnamesbooleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).<br/> You can only enable DNS hostnames if you've enabled DNS support.
tagsarrayThe tags for the VPC.
regionstringAWS region.
string
stringThe allowed tenancy of instances launched into the VPC.<br/> + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.<br/> + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.<br/> <br/> Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
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``.<br/> You must specify either``CidrBlock`` 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*.<br/> You must specify either``CidrBlock`` 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).<br/> You can only enable DNS hostnames if you've enabled DNS support.
arrayThe tags for the VPC.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual vpc resource, use vpcsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md index 6acb46c517..3851ac7173 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_cidr_block resource, use vpc_cidr_blocks to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual vpc_cidr_block resource, use Namevpc_cidr_block TypeResource DescriptionResource Type definition for AWS::EC2::VPCCidrBlock -Idaws.ec2.vpc_cidr_block +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
cidr_blockstringAn IPv4 CIDR block to associate with the VPC.
ipv6_poolstringThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
idstringThe Id of the VPC associated CIDR Block.
vpc_idstringThe ID of the VPC.
ipv6_cidr_blockstringAn IPv6 CIDR block from the IPv6 address pool.
ipv4_ipam_pool_idstringThe ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
ipv4_netmask_lengthintegerThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
ipv6_ipam_pool_idstringThe ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
ipv6_netmask_lengthintegerThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
amazon_provided_ipv6_cidr_blockbooleanRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
regionstringAWS region.
stringAn IPv4 CIDR block to associate with the VPC.
stringThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
stringThe Id of the VPC associated CIDR Block.
stringThe ID of the VPC.
stringAn IPv6 CIDR block from the IPv6 address pool.
stringThe ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
stringThe ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
booleanRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
stringAWS region.
@@ -50,14 +53,14 @@ Gets or operates on an individual vpc_cidr_block resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md index e472dd5d19..c8511c3de9 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_cidr_blocks in a region or create a vpc_cidr_blocks resource, use vpc_cidr_block to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vpc_cidr_blocks in a region or create a Namevpc_cidr_blocks TypeResource DescriptionResource Type definition for AWS::EC2::VPCCidrBlock -Idaws.ec2.vpc_cidr_blocks +Id ## Fields - - - + + +
NameDatatypeDescription
idstringThe Id of the VPC associated CIDR Block.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
stringThe Id of the VPC associated CIDR Block.
stringThe ID of the VPC.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vpc_cidr_blocks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md index df5bbeb5a4..c3c0884844 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_endpoint resource, use vpc_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual vpc_endpoint resource, use Namevpc_endpoint TypeResource DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).<br/> An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.<br/> An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W -Idaws.ec2.vpc_endpoint +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
idstring
creation_timestampstring
dns_entriesarray
network_interface_idsarray
policy_documentobjectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.<br/> For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
private_dns_enabledbooleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.<br/> To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.<br/> This property is supported only for interface endpoints.<br/> Default: ``false``
route_table_idsarrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
security_group_idsarrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
service_namestringThe name of the endpoint service.
subnet_idsarrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
vpc_endpoint_typestringThe type of endpoint.<br/> Default: Gateway
vpc_idstringThe ID of the VPC.
regionstringAWS region.
string
string
array
array
objectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.<br/> For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
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.<br/> To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.<br/> This property is supported only for interface endpoints.<br/> Default: ``false``
arrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
arrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
stringThe name of the endpoint service.
arrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
stringThe type of endpoint.<br/> Default: Gateway
stringThe ID of the VPC.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual vpc_endpoint resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md index d2aada489b..3945c1399b 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_endpoint_connection_notification resource, use vpc_endpoint_connection_notifications to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual vpc_endpoint_connection_notificationNamevpc_endpoint_connection_notification TypeResource DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification -Idaws.ec2.vpc_endpoint_connection_notification +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
connection_eventsarrayThe endpoint events for which to receive notifications.
connection_notification_arnstringThe ARN of the SNS topic for the notifications.
service_idstringThe ID of the endpoint service.
vpc_endpoint_idstringThe ID of the endpoint.
regionstringAWS region.
stringVPC Endpoint Connection ID generated by service
arrayThe endpoint events for which to receive notifications.
stringThe ARN of the SNS topic for the notifications.
stringThe ID of the endpoint service.
stringThe ID of the endpoint.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual vpc_endpoint_connection_notificationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md index 8c7a00ff3b..f6d9af6090 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_endpoint_connection_notifications in a region or create a vpc_endpoint_connection_notifications resource, use vpc_endpoint_connection_notification to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_endpoint_connection_notifications in Namevpc_endpoint_connection_notifications TypeResource DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification -Idaws.ec2.vpc_endpoint_connection_notifications +Id ## Fields - - + +
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
regionstringAWS region.
stringVPC Endpoint Connection ID generated by service
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_endpoint_connection_notifications in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md index 549fe67788..767fb53d50 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_endpoint_service resource, use vpc_endpoint_services to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual vpc_endpoint_service resource, us Namevpc_endpoint_service TypeResource DescriptionResource Type definition for AWS::EC2::VPCEndpointService -Idaws.ec2.vpc_endpoint_service +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
network_load_balancer_arnsarray
contributor_insights_enabledboolean
payer_responsibilitystring
service_idstring
acceptance_requiredboolean
gateway_load_balancer_arnsarray
regionstringAWS region.
array
boolean
string
string
boolean
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual vpc_endpoint_service resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md index b25af9f783..9424c414b1 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_endpoint_service_permissions resource, use vpc_endpoint_service_permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual vpc_endpoint_service_permissions Namevpc_endpoint_service_permissions TypeResource DescriptionResource Type definition for AWS::EC2::VPCEndpointServicePermissions -Idaws.ec2.vpc_endpoint_service_permissions +Id ## Fields - - - + + +
NameDatatypeDescription
allowed_principalsarray
service_idstring
regionstringAWS region.
array
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual vpc_endpoint_service_permissions Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md index e142fd4cdf..2f09845387 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_endpoint_services in a region or create a vpc_endpoint_services resource, use vpc_endpoint_service to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_endpoint_services in a region or cre Namevpc_endpoint_services TypeResource DescriptionResource Type definition for AWS::EC2::VPCEndpointService -Idaws.ec2.vpc_endpoint_services +Id ## Fields - - + +
NameDatatypeDescription
service_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_endpoint_services in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md index c4b7e39b79..505b47c75a 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_endpoints in a region or create a vpc_endpoints resource, use vpc_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_endpoints in a region or create a Namevpc_endpoints TypeResource DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).<br/> An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.<br/> An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W -Idaws.ec2.vpc_endpoints +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md index bf08a16587..800600d268 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_gateway_attachment resource, use vpc_gateway_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual vpc_gateway_attachment resource, Namevpc_gateway_attachment TypeResource DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment -Idaws.ec2.vpc_gateway_attachment +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
internet_gateway_idstringThe ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
vpc_idstringThe ID of the VPC.
vpn_gateway_idstringThe ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual vpc_gateway_attachment resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md index 94694dd91d..fdf5cdffed 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_gateway_attachments in a region or create a vpc_gateway_attachments resource, use vpc_gateway_attachment to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vpc_gateway_attachments in a region or c Namevpc_gateway_attachments TypeResource DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment -Idaws.ec2.vpc_gateway_attachments +Id ## Fields - - - + + +
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
vpc_idstringThe ID of the VPC.
regionstringAWS region.
stringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
stringThe ID of the VPC.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vpc_gateway_attachments in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md index eb5e64ab01..911134d7c4 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_peering_connection resource, use vpc_peering_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual vpc_peering_connection resource, Namevpc_peering_connection TypeResource DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection -Idaws.ec2.vpc_peering_connection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
peer_owner_idstringThe AWS account ID of the owner of the accepter VPC.
peer_regionstringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
peer_role_arnstringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
peer_vpc_idstringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
vpc_idstringThe ID of the VPC.
tagsarray
regionstringAWS region.
string
stringThe AWS account ID of the owner of the accepter VPC.
stringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
stringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
stringThe ID of the VPC.
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual vpc_peering_connection resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md index 8a46807385..811de214aa 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_peering_connections in a region or create a vpc_peering_connections resource, use vpc_peering_connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_peering_connections in a region or c Namevpc_peering_connections TypeResource DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection -Idaws.ec2.vpc_peering_connections +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_peering_connections in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md index a60042d5af..904e0e5fc8 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpcdhcp_options_association resource, use vpcdhcp_options_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual vpcdhcp_options_association resou Namevpcdhcp_options_association TypeResource DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC. -Idaws.ec2.vpcdhcp_options_association +Id ## Fields - - - + + +
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
stringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
stringThe ID of the VPC.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual vpcdhcp_options_association resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md index 777051fb8a..c78a56c686 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpcdhcp_options_associations in a region or create a vpcdhcp_options_associations resource, use vpcdhcp_options_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vpcdhcp_options_associations in a region Namevpcdhcp_options_associations TypeResource DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC. -Idaws.ec2.vpcdhcp_options_associations +Id ## Fields - - - + + +
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
stringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
stringThe ID of the VPC.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vpcdhcp_options_associations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpcs/index.md b/docs/aws-docs/providers/aws/ec2/vpcs/index.md index 20522db75f..44afe1f12e 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcs/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpcs in a region or create a vpcs resource, use vpc to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpcs in a region or create a vpcs< Namevpcs TypeResource DescriptionSpecifies a virtual private cloud (VPC).<br/> You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).<br/> For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*. -Idaws.ec2.vpcs +Id ## Fields - - + +
NameDatatypeDescription
vpc_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpcs in a region or create a vpcs< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md index ec1737aa08..99248e9222 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpn_connection resource, use vpn_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual vpn_connection resource, use Namevpn_connection TypeResource DescriptionResource Type definition for AWS::EC2::VPNConnection -Idaws.ec2.vpn_connection +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
customer_gateway_idstringThe ID of the customer gateway at your end of the VPN connection.
static_routes_onlybooleanIndicates whether the VPN connection uses static routes only.
tagsarrayAny tags assigned to the VPN connection.
transit_gateway_idstringThe ID of the transit gateway associated with the VPN connection.
typestringThe type of VPN connection.
vpn_gateway_idstringThe ID of the virtual private gateway at the AWS side of the VPN connection.
vpn_tunnel_options_specificationsarrayThe tunnel options for the VPN connection.
regionstringAWS region.
stringThe provider-assigned unique ID for this managed resource
stringThe ID of the customer gateway at your end of the VPN connection.
booleanIndicates whether the VPN connection uses static routes only.
arrayAny tags assigned to the VPN connection.
stringThe ID of the transit gateway associated with the VPN connection.
stringThe type of VPN connection.
stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
arrayThe tunnel options for the VPN connection.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual vpn_connection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md index 9e97826eca..087b8f9c25 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpn_connection_route resource, use vpn_connection_routes to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual vpn_connection_route resource, us Namevpn_connection_route TypeResource DescriptionResource Type definition for AWS::EC2::VPNConnectionRoute -Idaws.ec2.vpn_connection_route +Id ## Fields - - - + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
stringThe CIDR block associated with the local subnet of the customer network.
stringThe ID of the VPN connection.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual vpn_connection_route resource, us Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md index 955567c8ca..ccd8fc5240 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpn_connection_routes in a region or create a vpn_connection_routes resource, use vpn_connection_route to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vpn_connection_routes in a region or cre Namevpn_connection_routes TypeResource DescriptionResource Type definition for AWS::EC2::VPNConnectionRoute -Idaws.ec2.vpn_connection_routes +Id ## Fields - - - + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
stringThe CIDR block associated with the local subnet of the customer network.
stringThe ID of the VPN connection.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vpn_connection_routes in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md index ecf20c282f..e865fcb9c2 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpn_connections in a region or create a vpn_connections resource, use vpn_connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpn_connections in a region or create a Namevpn_connections TypeResource DescriptionResource Type definition for AWS::EC2::VPNConnection -Idaws.ec2.vpn_connections +Id ## Fields - - + +
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
regionstringAWS region.
stringThe provider-assigned unique ID for this managed resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpn_connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md index a2adfaa14d..a8e5af176e 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpn_gateway resource, use vpn_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual vpn_gateway resource, use v Namevpn_gateway TypeResource DescriptionSchema for EC2 VPN Gateway -Idaws.ec2.vpn_gateway +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
amazon_side_asnintegerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
tagsarrayAny tags assigned to the virtual private gateway.
typestringThe type of VPN connection the virtual private gateway supports.
regionstringAWS region.
stringVPN Gateway ID generated by service
integerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
arrayAny tags assigned to the virtual private gateway.
stringThe type of VPN connection the virtual private gateway supports.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual vpn_gateway resource, use v Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md index 61314acdb7..79794e2d8e 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpn_gateways in a region or create a vpn_gateways resource, use vpn_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpn_gateways in a region or create a Namevpn_gateways TypeResource DescriptionSchema for EC2 VPN Gateway -Idaws.ec2.vpn_gateways +Id ## Fields - - + +
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
regionstringAWS region.
stringVPN Gateway ID generated by service
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpn_gateways in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/public_repositories/index.md b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md index cf987ac4d3..b8c138d14b 100644 --- a/docs/aws-docs/providers/aws/ecr/public_repositories/index.md +++ b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of public_repositories in a region or create a public_repositories resource, use public_repository to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of public_repositories in a region or creat Namepublic_repositories TypeResource DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR -Idaws.ecr.public_repositories +Id ## Fields - - + +
NameDatatypeDescription
repository_namestringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of public_repositories in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/public_repository/index.md b/docs/aws-docs/providers/aws/ecr/public_repository/index.md index 71cc42ef61..5ccac05901 100644 --- a/docs/aws-docs/providers/aws/ecr/public_repository/index.md +++ b/docs/aws-docs/providers/aws/ecr/public_repository/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual public_repository resource, use public_repositories to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual public_repository resource, use < Namepublic_repository TypeResource DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR -Idaws.ecr.public_repository +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
repository_namestringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
repository_policy_textobjectThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
arnstring
repository_catalog_dataobjectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual public_repository resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md index 0b0d0224e9..f92d7941ad 100644 --- a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pull_through_cache_rule resource, use pull_through_cache_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual pull_through_cache_rule resource, Namepull_through_cache_rule TypeResource DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache. -Idaws.ecr.pull_through_cache_rule +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
ecr_repository_prefixstringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
upstream_registry_urlstringThe upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
credential_arnstringThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
upstream_registrystringThe name of the upstream registry.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual pull_through_cache_rule resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md index eb141039f3..0a6d2f698f 100644 --- a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pull_through_cache_rules in a region or create a pull_through_cache_rules resource, use pull_through_cache_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pull_through_cache_rules in a region or Namepull_through_cache_rules TypeResource DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache. -Idaws.ecr.pull_through_cache_rules +Id ## Fields - - + +
NameDatatypeDescription
ecr_repository_prefixstringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
regionstringAWS region.
stringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pull_through_cache_rules in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/registry_policies/index.md b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md index 3ccd179613..f5939ff1e9 100644 --- a/docs/aws-docs/providers/aws/ecr/registry_policies/index.md +++ b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of registry_policies in a region or create a registry_policies resource, use registry_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of registry_policies in a region or create Nameregistry_policies TypeResource DescriptionThe ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.<br/> A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*. -Idaws.ecr.registry_policies +Id ## Fields - - + +
NameDatatypeDescription
registry_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of registry_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/registry_policy/index.md b/docs/aws-docs/providers/aws/ecr/registry_policy/index.md index 55bb1b48a4..5d59946e16 100644 --- a/docs/aws-docs/providers/aws/ecr/registry_policy/index.md +++ b/docs/aws-docs/providers/aws/ecr/registry_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual registry_policy resource, use registry_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual registry_policy resource, use Nameregistry_policy TypeResource DescriptionThe ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.<br/> A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*. -Idaws.ecr.registry_policy +Id ## Fields - - - + + +
NameDatatypeDescription
registry_idstring
policy_textobjectThe JSON policy text for your registry.
regionstringAWS region.
string
objectThe JSON policy text for your registry.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual registry_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md b/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md index f6d388203c..46b2aa3526 100644 --- a/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md +++ b/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual replication_configuration resource, use replication_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual replication_configuration resourc Namereplication_configuration TypeResource DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html -Idaws.ecr.replication_configuration +Id ## Fields - - - + + +
NameDatatypeDescription
replication_configurationobject
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
object
stringThe RegistryId associated with the aws account.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual replication_configuration resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md index fd8651429d..201029706b 100644 --- a/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md +++ b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of replication_configurations in a region or create a replication_configurations resource, use replication_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of replication_configurations in a region o Namereplication_configurations TypeResource DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html -Idaws.ecr.replication_configurations +Id ## Fields - - + +
NameDatatypeDescription
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
stringThe RegistryId associated with the aws account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of replication_configurations in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/repositories/index.md b/docs/aws-docs/providers/aws/ecr/repositories/index.md index bb82680186..e587c40811 100644 --- a/docs/aws-docs/providers/aws/ecr/repositories/index.md +++ b/docs/aws-docs/providers/aws/ecr/repositories/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of repositories in a region or create a repositories resource, use repository to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of repositories in a region or create a Namerepositories TypeResource DescriptionThe ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*. -Idaws.ecr.repositories +Id ## Fields - - + +
NameDatatypeDescription
repository_namestringThe name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
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).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of repositories in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecr/repository/index.md b/docs/aws-docs/providers/aws/ecr/repository/index.md index 0f08e65595..71b13e2674 100644 --- a/docs/aws-docs/providers/aws/ecr/repository/index.md +++ b/docs/aws-docs/providers/aws/ecr/repository/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual repository resource, use repositories to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual repository resource, use re Namerepository TypeResource DescriptionThe ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*. -Idaws.ecr.repository +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
empty_on_deletebooleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
lifecycle_policyobjectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
repository_namestringThe name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
repository_policy_textobjectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
repository_uristring
image_tag_mutabilitystringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
image_scanning_configurationobjectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
encryption_configurationobjectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
regionstringAWS region.
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).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual repository resource, use re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md index 170e5f05c5..6d83f17b3f 100644 --- a/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual repository_creation_template resource, use repository_creation_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual repository_creation_template reso Namerepository_creation_template TypeResource DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template. -Idaws.ecr.repository_creation_template +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
prefixstringThe prefix use to match the repository name and apply the template.
descriptionstringThe description of the template.
image_tag_mutabilitystringThe image tag mutability setting for the repository.
repository_policystringThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
lifecycle_policystringThe JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
encryption_configurationobject
resource_tagsarrayAn array of key-value pairs to apply to this resource.
applied_forarrayA list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
created_atstringCreate timestamp of the template.
updated_atstringUpdate timestamp of the template.
regionstringAWS region.
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
object
arrayAn array of key-value pairs to apply to this resource.
arrayA list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
stringCreate timestamp of the template.
stringUpdate timestamp of the template.
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual repository_creation_template reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md index 56375e8427..4f2ae02ee2 100644 --- a/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of repository_creation_templates in a region or create a repository_creation_templates resource, use repository_creation_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of repository_creation_templates in a regio Namerepository_creation_templates TypeResource DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template. -Idaws.ecr.repository_creation_templates +Id ## Fields - - + +
NameDatatypeDescription
prefixstringThe prefix use to match the repository name and apply the template.
regionstringAWS region.
stringThe prefix use to match the repository name and apply the template.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of repository_creation_templates in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md index f3110bd538..94e72ba19e 100644 --- a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md +++ b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster_capacity_provider_associations resource, use cluster_capacity_provider_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual cluster_capacity_provider_associationsNamecluster_capacity_provider_associations TypeResource DescriptionAssociate a set of ECS Capacity Providers with a specified ECS Cluster -Idaws.ecs.cluster_capacity_provider_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
capacity_providersarray
clusterstring
default_capacity_provider_strategyarray
regionstringAWS region.
array
string
array
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual cluster_capacity_provider_associationsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md b/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md index 878caf4407..b61db766e5 100644 --- a/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md +++ b/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual primary_task_set resource, use primary_task_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual primary_task_set resource, use Nameprimary_task_set TypeResource DescriptionA pseudo-resource that manages which of your ECS task sets is primary. -Idaws.ecs.primary_task_set +Id ## Fields - - - - + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
task_set_idstringThe ID or full Amazon Resource Name (ARN) of the task set.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
regionstringAWS region.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
stringThe ID or full Amazon Resource Name (ARN) of the task set.
stringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual primary_task_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md index 9f79e4da54..22e47c971b 100644 --- a/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md +++ b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of primary_task_sets in a region or create a primary_task_sets resource, use primary_task_set to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of primary_task_sets in a region or create Nameprimary_task_sets TypeResource DescriptionA pseudo-resource that manages which of your ECS task sets is primary. -Idaws.ecs.primary_task_sets +Id ## Fields - - - + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of primary_task_sets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecs/service/index.md b/docs/aws-docs/providers/aws/ecs/service/index.md index 5b2db82aaa..1938064042 100644 --- a/docs/aws-docs/providers/aws/ecs/service/index.md +++ b/docs/aws-docs/providers/aws/ecs/service/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service resource, use services to retrieve a list of resources or to create a resource. ## Overview @@ -21,38 +24,38 @@ Gets or operates on an individual service resource, use servi Nameservice TypeResource DescriptionThe ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.<br/> The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.<br/> Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. -Idaws.ecs.service +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
service_arnstring
capacity_provider_strategyarrayThe capacity provider strategy to use for the service.<br/> If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.<br/> A capacity provider strategy may contain a maximum of 6 capacity providers.
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
deployment_configurationobjectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deployment_controllerobjectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used.
desired_countintegerThe number of instantiations of the specified task definition to place and keep running in your service.<br/> For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.<br/> For existing services, if a desired count is not specified, it is omitted from the operation.
enable_ecs_managed_tagsbooleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.
enable_execute_commandbooleanDetermines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.
health_check_grace_period_secondsintegerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.<br/> If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).<br/> If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
launch_typestringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
load_balancersarrayA list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
namestring
network_configurationobjectThe network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
placement_constraintsarrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placement_strategiesarrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
platform_versionstringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
propagate_tagsstringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.<br/> The default is ``NONE``.
rolestringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.<br/> If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
scheduling_strategystringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).<br/> There are two service scheduler strategies available:<br/> + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.<br/> + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.<br/> Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.
service_connect_configurationobjectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.<br/> Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
service_namestringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.<br/> The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.
service_registriesarrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).<br/> Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
tagsarrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.<br/> The following basic restrictions apply to tags:<br/> + Maximum number of tags per resource - 50<br/> + For each resource, each tag key must be unique, and each tag key can have only one value.<br/> + Maximum key length - 128 Unicode characters in UTF-8<br/> + Maximum value length - 256 Unicode characters in UTF-8<br/> + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.<br/> + Tag keys and values are case-sensitive.<br/> + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
task_definitionstringThe ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.<br/> A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.<br/> For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
volume_configurationsarrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
regionstringAWS region.
string
arrayThe capacity provider strategy to use for the service.<br/> If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.<br/> A capacity provider strategy may contain a maximum of 6 capacity providers.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
objectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
objectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used.
integerThe number of instantiations of the specified task definition to place and keep running in your service.<br/> For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.<br/> For existing services, if a desired count is not specified, it is omitted from the operation.
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*.<br/> When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.
booleanDetermines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.
integerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.<br/> If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).<br/> If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
stringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayA list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
string
objectThe network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
arrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
stringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.<br/> The default is ``NONE``.
stringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.<br/> If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
stringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).<br/> There are two service scheduler strategies available:<br/> + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.<br/> + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.<br/> Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.
objectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.<br/> Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
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.<br/> The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.
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).<br/> Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
arrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.<br/> The following basic restrictions apply to tags:<br/> + Maximum number of tags per resource - 50<br/> + For each resource, each tag key must be unique, and each tag key can have only one value.<br/> + Maximum key length - 128 Unicode characters in UTF-8<br/> + Maximum value length - 256 Unicode characters in UTF-8<br/> + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.<br/> + Tag keys and values are case-sensitive.<br/> + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.<br/> A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.<br/> For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
arrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
stringAWS region.
@@ -65,19 +68,19 @@ Gets or operates on an individual service resource, use servi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecs/services/index.md b/docs/aws-docs/providers/aws/ecs/services/index.md index 4bcfb0932a..2cbb3e991f 100644 --- a/docs/aws-docs/providers/aws/ecs/services/index.md +++ b/docs/aws-docs/providers/aws/ecs/services/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of services in a region or create a services resource, use service to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of services in a region or create a s Nameservices TypeResource DescriptionThe ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.<br/> The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.<br/> Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. -Idaws.ecs.services +Id ## Fields - - - + + +
NameDatatypeDescription
service_arnstring
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of services in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecs/task_definition/index.md b/docs/aws-docs/providers/aws/ecs/task_definition/index.md index 1f23da4b5d..1e80cff34f 100644 --- a/docs/aws-docs/providers/aws/ecs/task_definition/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual task_definition resource, use task_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual task_definition resource, use Nametask_definition TypeResource DescriptionRegisters a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.<br/> You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself. -Idaws.ecs.task_definition +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
task_definition_arnstring
familystringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.<br/> A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.<br/> To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
container_definitionsarrayA list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
cpustringThe number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.<br/> The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.<br/> + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)<br/> + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)<br/> + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)<br/> + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)<br/> + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)<br/> + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.
execution_role_arnstringThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.
ephemeral_storageobjectThe ephemeral storage settings to use for tasks run with the task definition.
inference_acceleratorsarrayThe Elastic Inference accelerators to use for the containers in the task.
memorystringThe amount (in MiB) of memory used by the task.<br/> If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).<br/> If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.<br/> + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)<br/> + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)<br/> + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)<br/> + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)<br/> + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)<br/> + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.
network_modestringThe Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.<br/> For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``<default>`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.<br/> With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. <br/> When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.<br/> If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.<br/> For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
placement_constraintsarrayAn array of placement constraint objects to use for tasks.<br/> This parameter isn't supported for tasks run on FARGATElong.
proxy_configurationobjectThe configuration details for the App Mesh proxy.<br/> Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
requires_compatibilitiesarrayThe task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
task_role_arnstringThe short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.
volumesarrayThe list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
pid_modestringThe process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.<br/> If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.<br/> If ``task`` is specified, all containers within the specified task share the same process namespace.<br/> If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.<br/> If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> This parameter is not supported for Windows containers.<br/> This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
runtime_platformobjectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. <br/> When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service.
ipc_modestringThe IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.<br/> If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.<br/> + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.<br/> <br/> This parameter is not supported for Windows containers or tasks run on FARGATElong.
tagsarrayThe metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.<br/> The following basic restrictions apply to tags:<br/> + Maximum number of tags per resource - 50<br/> + For each resource, each tag key must be unique, and each tag key can have only one value.<br/> + Maximum key length - 128 Unicode characters in UTF-8<br/> + Maximum value length - 256 Unicode characters in UTF-8<br/> + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.<br/> + Tag keys and values are case-sensitive.<br/> + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
regionstringAWS region.
string
stringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.<br/> A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.<br/> To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
arrayA list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.<br/> The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.<br/> + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)<br/> + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)<br/> + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)<br/> + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)<br/> + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)<br/> + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.
stringThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe ephemeral storage settings to use for tasks run with the task definition.
arrayThe Elastic Inference accelerators to use for the containers in the task.
stringThe amount (in MiB) of memory used by the task.<br/> If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).<br/> If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.<br/> + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)<br/> + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)<br/> + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)<br/> + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)<br/> + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)<br/> + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.
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``.<br/> For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``<default>`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.<br/> With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. <br/> When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.<br/> If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.<br/> For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
arrayAn array of placement constraint objects to use for tasks.<br/> This parameter isn't supported for tasks run on FARGATElong.
objectThe configuration details for the App Mesh proxy.<br/> Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.
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*.<br/> The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
stringThe process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.<br/> If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.<br/> If ``task`` is specified, all containers within the specified task share the same process namespace.<br/> If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.<br/> If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> This parameter is not supported for Windows containers.<br/> This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
objectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. <br/> When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service.
stringThe IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.<br/> If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.<br/> + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.<br/> <br/> This parameter is not supported for Windows containers or tasks run on FARGATElong.
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.<br/> The following basic restrictions apply to tags:<br/> + Maximum number of tags per resource - 50<br/> + For each resource, each tag key must be unique, and each tag key can have only one value.<br/> + Maximum key length - 128 Unicode characters in UTF-8<br/> + Maximum value length - 256 Unicode characters in UTF-8<br/> + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.<br/> + Tag keys and values are case-sensitive.<br/> + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
stringAWS region.
@@ -58,19 +61,19 @@ Gets or operates on an individual task_definition resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecs/task_definitions/index.md b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md index 3575ea8734..bb5661af7b 100644 --- a/docs/aws-docs/providers/aws/ecs/task_definitions/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of task_definitions in a region or create a task_definitions resource, use task_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of task_definitions in a region or create a Nametask_definitions TypeResource DescriptionRegisters a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.<br/> You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself. -Idaws.ecs.task_definitions +Id ## Fields - - + +
NameDatatypeDescription
task_definition_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of task_definitions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ecs/task_set/index.md b/docs/aws-docs/providers/aws/ecs/task_set/index.md index aab765124f..e5994c448e 100644 --- a/docs/aws-docs/providers/aws/ecs/task_set/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual task_set resource, use task_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual task_set resource, use task Nametask_set TypeResource DescriptionCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide. -Idaws.ecs.task_set +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
external_idstringAn optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
idstringThe ID of the task set.
launch_typestringThe launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
load_balancersarray
network_configurationobject
platform_versionstringThe platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
scaleobjectA floating-point percentage of the desired number of tasks to place and keep running in the task set.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
service_registriesarrayThe details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
tagsarray
task_definitionstringThe short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
regionstringAWS region.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
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 ID of the task set.
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.
array
object
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.
objectA floating-point percentage of the desired number of tasks to place and keep running in the task set.
stringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
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 short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual task_set resource, use task Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ecs/task_sets/index.md b/docs/aws-docs/providers/aws/ecs/task_sets/index.md index 52e015d2f9..77311ca497 100644 --- a/docs/aws-docs/providers/aws/ecs/task_sets/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of task_sets in a region or create a task_sets resource, use task_set to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of task_sets in a region or create a Nametask_sets TypeResource DescriptionCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide. -Idaws.ecs.task_sets +Id ## Fields - - - - + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
idstringThe ID of the task set.
regionstringAWS region.
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.
stringThe ID of the task set.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of task_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/efs/access_point/index.md b/docs/aws-docs/providers/aws/efs/access_point/index.md index 8108f1aaa7..1d40a2f579 100644 --- a/docs/aws-docs/providers/aws/efs/access_point/index.md +++ b/docs/aws-docs/providers/aws/efs/access_point/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_point resource, use access_points to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual access_point resource, use Nameaccess_point TypeResource DescriptionThe ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).<br/> This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action. -Idaws.efs.access_point +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
access_point_idstring
arnstring
client_tokenstringThe opaque string specified in the request to ensure idempotent creation.
access_point_tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
file_system_idstringThe ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``.
posix_userobjectThe full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
root_directoryobjectThe directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
regionstringAWS region.
string
string
stringThe opaque string specified in the request to ensure idempotent creation.
arrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual access_point resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/efs/access_points/index.md b/docs/aws-docs/providers/aws/efs/access_points/index.md index 583a0284d8..177c689ee2 100644 --- a/docs/aws-docs/providers/aws/efs/access_points/index.md +++ b/docs/aws-docs/providers/aws/efs/access_points/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_points in a region or create a access_points resource, use access_point to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_points in a region or create a Nameaccess_points TypeResource DescriptionThe ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).<br/> This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action. -Idaws.efs.access_points +Id ## Fields - - + +
NameDatatypeDescription
access_point_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_points in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/efs/file_system/index.md b/docs/aws-docs/providers/aws/efs/file_system/index.md index 4687aa083e..d1262606b1 100644 --- a/docs/aws-docs/providers/aws/efs/file_system/index.md +++ b/docs/aws-docs/providers/aws/efs/file_system/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual file_system resource, use file_systems to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual file_system resource, use f Namefile_system TypeResource DescriptionThe ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource. -Idaws.efs.file_system +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
file_system_idstring
arnstring
encryptedbooleanA Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.
file_system_tagsarrayUse to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
kms_key_idstringThe ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:<br/> + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.<br/> + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.<br/> <br/> If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
lifecycle_policiesarrayAn array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:<br/> + When to move files in the file system from primary storage to IA storage.<br/> + When to move files in the file system from primary storage or IA storage to Archive storage.<br/> + When to move files that are in IA or Archive storage to primary storage.<br/> <br/> EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
file_system_protectionobjectDescribes the protection on the file system.
performance_modestringThe Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.<br/> Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.<br/> Default is ``generalPurpose``.
provisioned_throughput_in_mibpsnumberThe throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
throughput_modestringSpecifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. <br/> Default is ``bursting``.
file_system_policyobjectThe ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
bypass_policy_lockout_safety_checkboolean(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.
backup_policyobjectUse the ``BackupPolicy`` to turn automatic backups on or off for the file system.
availability_zone_namestringFor One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.<br/> One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
replication_configurationobjectDescribes the replication configuration for a specific file system.
regionstringAWS region.
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:<br/> + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.<br/> + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.<br/> <br/> If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
arrayAn array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:<br/> + When to move files in the file system from primary storage to IA storage.<br/> + When to move files in the file system from primary storage or IA storage to Archive storage.<br/> + When to move files that are in IA or Archive storage to primary storage.<br/> <br/> EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
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.<br/> Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.<br/> Default is ``generalPurpose``.
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*. <br/> 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*.<br/> 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.
@@ -55,19 +58,19 @@ Gets or operates on an individual file_system resource, use f Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/efs/file_systems/index.md b/docs/aws-docs/providers/aws/efs/file_systems/index.md index caa15bfaad..e4aab26f30 100644 --- a/docs/aws-docs/providers/aws/efs/file_systems/index.md +++ b/docs/aws-docs/providers/aws/efs/file_systems/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of file_systems in a region or create a file_systems resource, use file_system to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of file_systems in a region or create a Namefile_systems TypeResource DescriptionThe ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource. -Idaws.efs.file_systems +Id ## Fields - - + +
NameDatatypeDescription
file_system_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of file_systems in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/efs/mount_target/index.md b/docs/aws-docs/providers/aws/efs/mount_target/index.md index 7e985d8f1f..861ca81681 100644 --- a/docs/aws-docs/providers/aws/efs/mount_target/index.md +++ b/docs/aws-docs/providers/aws/efs/mount_target/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual mount_target resource, use mount_targets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual mount_target resource, use Namemount_target TypeResource DescriptionThe ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target. -Idaws.efs.mount_target +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstring
ip_addressstringValid IPv4 address within the address range of the specified subnet.
file_system_idstringThe ID of the file system for which to create the mount target.
security_groupsarrayUp to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.
subnet_idstringThe ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual mount_target resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/efs/mount_targets/index.md b/docs/aws-docs/providers/aws/efs/mount_targets/index.md index 7a771951c6..c41af3ced3 100644 --- a/docs/aws-docs/providers/aws/efs/mount_targets/index.md +++ b/docs/aws-docs/providers/aws/efs/mount_targets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of mount_targets in a region or create a mount_targets resource, use mount_target to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of mount_targets in a region or create a Namemount_targets TypeResource DescriptionThe ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target. -Idaws.efs.mount_targets +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of mount_targets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/access_entries/index.md b/docs/aws-docs/providers/aws/eks/access_entries/index.md index 0a46f28116..f64ad71dc0 100644 --- a/docs/aws-docs/providers/aws/eks/access_entries/index.md +++ b/docs/aws-docs/providers/aws/eks/access_entries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_entries in a region or create a access_entries resource, use access_entry to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of access_entries in a region or create a < Nameaccess_entries TypeResource DescriptionAn object representing an Amazon EKS AccessEntry. -Idaws.eks.access_entries +Id ## Fields - - - + + +
NameDatatypeDescription
principal_arnstringThe principal ARN that the access entry is created for.
cluster_namestringThe cluster that the access entry is created for.
regionstringAWS region.
stringThe principal ARN that the access entry is created for.
stringThe cluster that the access entry is created for.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of access_entries in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/access_entry/index.md b/docs/aws-docs/providers/aws/eks/access_entry/index.md index 978cd88b00..dc0d988625 100644 --- a/docs/aws-docs/providers/aws/eks/access_entry/index.md +++ b/docs/aws-docs/providers/aws/eks/access_entry/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_entry resource, use access_entries to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual access_entry resource, use Nameaccess_entry TypeResource DescriptionAn object representing an Amazon EKS AccessEntry. -Idaws.eks.access_entry +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe cluster that the access entry is created for.
principal_arnstringThe principal ARN that the access entry is created for.
usernamestringThe Kubernetes user that the access entry is associated with.
tagsarrayAn array of key-value pairs to apply to this resource.
access_entry_arnstringThe ARN of the access entry.
kubernetes_groupsarrayThe Kubernetes groups that the access entry is associated with.
access_policiesarrayAn array of access policies that are associated with the access entry.
typestringThe node type to associate with the access entry.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual access_entry resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/addon/index.md b/docs/aws-docs/providers/aws/eks/addon/index.md index 4af4e12266..9967f45505 100644 --- a/docs/aws-docs/providers/aws/eks/addon/index.md +++ b/docs/aws-docs/providers/aws/eks/addon/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual addon resource, use addons to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual addon resource, use addons< Nameaddon TypeResource DescriptionResource Schema for AWS::EKS::Addon -Idaws.eks.addon +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
cluster_namestringName of Cluster
addon_namestringName of Addon
addon_versionstringVersion of Addon
preserve_on_deletebooleanPreserveOnDelete parameter value
resolve_conflictsstringResolve parameter value conflicts
service_account_role_arnstringIAM role to bind to the add-on's service account
configuration_valuesstringThe configuration values to use with the add-on
arnstringAmazon Resource Name (ARN) of the add-on
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual addon resource, use addons< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/addons/index.md b/docs/aws-docs/providers/aws/eks/addons/index.md index 85cd8c5cb9..c1df933d8a 100644 --- a/docs/aws-docs/providers/aws/eks/addons/index.md +++ b/docs/aws-docs/providers/aws/eks/addons/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of addons in a region or create a addons resource, use addon to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of addons in a region or create a add Nameaddons TypeResource DescriptionResource Schema for AWS::EKS::Addon -Idaws.eks.addons +Id ## Fields - - - + + +
NameDatatypeDescription
cluster_namestringName of Cluster
addon_namestringName of Addon
regionstringAWS region.
stringName of Cluster
stringName of Addon
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of addons in a region or create a add Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/cluster/index.md b/docs/aws-docs/providers/aws/eks/cluster/index.md index 6bce09f52a..74434d7b89 100644 --- a/docs/aws-docs/providers/aws/eks/cluster/index.md +++ b/docs/aws-docs/providers/aws/eks/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionAn object representing an Amazon EKS cluster. -Idaws.eks.cluster +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
encryption_configarray
kubernetes_network_configobject
loggingobject
namestringThe unique name to give to your cluster.
idstringThe unique ID given to your cluster.
resources_vpc_configobject
outpost_configobject
access_configobject
role_arnstringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
versionstringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
endpointstringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
certificate_authority_datastringThe certificate-authority-data for your cluster.
cluster_security_group_idstringThe cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
encryption_config_key_arnstringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
open_id_connect_issuer_urlstringThe issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
regionstringAWS region.
array
object
object
stringThe unique name to give to your cluster.
stringThe unique ID given to your cluster.
object
object
object
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.
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual cluster resource, use clust Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/clusters/index.md b/docs/aws-docs/providers/aws/eks/clusters/index.md index 3bbd663cad..ea550ba18b 100644 --- a/docs/aws-docs/providers/aws/eks/clusters/index.md +++ b/docs/aws-docs/providers/aws/eks/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionAn object representing an Amazon EKS cluster. -Idaws.eks.clusters +Id ## Fields - - + +
NameDatatypeDescription
namestringThe unique name to give to your cluster.
regionstringAWS region.
stringThe unique name to give to your cluster.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profile/index.md b/docs/aws-docs/providers/aws/eks/fargate_profile/index.md index 2f19c7946b..0a3452f5dc 100644 --- a/docs/aws-docs/providers/aws/eks/fargate_profile/index.md +++ b/docs/aws-docs/providers/aws/eks/fargate_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fargate_profile resource, use fargate_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual fargate_profile resource, use Namefargate_profile TypeResource DescriptionResource Schema for AWS::EKS::FargateProfile -Idaws.eks.fargate_profile +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
cluster_namestringName of the Cluster
fargate_profile_namestringName of FargateProfile
pod_execution_role_arnstringThe IAM policy arn for pods
arnstring
subnetsarray
selectorsarray
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual fargate_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md index 580d2a0dcd..fbec4da5ac 100644 --- a/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md +++ b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fargate_profiles in a region or create a fargate_profiles resource, use fargate_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of fargate_profiles in a region or create a Namefargate_profiles TypeResource DescriptionResource Schema for AWS::EKS::FargateProfile -Idaws.eks.fargate_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
cluster_namestringName of the Cluster
fargate_profile_namestringName of FargateProfile
regionstringAWS region.
stringName of the Cluster
stringName of FargateProfile
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of fargate_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md index 04973563cc..7f6466708d 100644 --- a/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md +++ b/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_provider_config resource, use identity_provider_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual identity_provider_config resource Nameidentity_provider_config TypeResource DescriptionAn object representing an Amazon EKS IdentityProviderConfig. -Idaws.eks.identity_provider_config +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
cluster_namestringThe name of the identity provider configuration.
typestringThe type of the identity provider configuration.
identity_provider_config_namestringThe name of the OIDC provider configuration.
oidcobject
tagsarrayAn array of key-value pairs to apply to this resource.
identity_provider_config_arnstringThe ARN of the configuration.
regionstringAWS region.
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
object
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the configuration.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual identity_provider_config resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md index 6d48db3893..6f5c2a5b1b 100644 --- a/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md +++ b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_provider_configs in a region or create a identity_provider_configs resource, use identity_provider_config to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of identity_provider_configs in a region or Nameidentity_provider_configs TypeResource DescriptionAn object representing an Amazon EKS IdentityProviderConfig. -Idaws.eks.identity_provider_configs +Id ## Fields - - - - + + + +
NameDatatypeDescription
identity_provider_config_namestringThe name of the OIDC provider configuration.
cluster_namestringThe name of the identity provider configuration.
typestringThe type of the identity provider configuration.
regionstringAWS region.
stringThe name of the OIDC provider configuration.
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of identity_provider_configs in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/nodegroup/index.md b/docs/aws-docs/providers/aws/eks/nodegroup/index.md index dd67b59709..e12533ea5f 100644 --- a/docs/aws-docs/providers/aws/eks/nodegroup/index.md +++ b/docs/aws-docs/providers/aws/eks/nodegroup/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual nodegroup resource, use nodegroups to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual nodegroup resource, use nod Namenodegroup TypeResource DescriptionResource schema for AWS::EKS::Nodegroup -Idaws.eks.nodegroup +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ami_typestringThe AMI type for your node group.
capacity_typestringThe capacity type of your managed node group.
cluster_namestringName of the cluster to create the node group in.
disk_sizeintegerThe root device disk size (in GiB) for your node group instances.
force_update_enabledbooleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
instance_typesarraySpecify the instance types for a node group.
labelsobjectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
launch_templateobjectAn object representing a node group's launch template specification.
nodegroup_namestringThe unique name to give your node group.
node_rolestringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
release_versionstringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
remote_accessobjectThe remote access (SSH) configuration to use with your node group.
scaling_configobjectThe scaling configuration details for the Auto Scaling group that is created for your node group.
subnetsarrayThe subnets to use for the Auto Scaling group that is created for your node group.
tagsobjectThe metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
taintsarrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
update_configobjectThe node group update configuration.
versionstringThe Kubernetes version to use for your managed nodes.
idstring
arnstring
regionstringAWS region.
stringThe AMI type for your node group.
stringThe capacity type of your managed node group.
stringName of the cluster to create the node group in.
integerThe root device disk size (in GiB) for your node group instances.
booleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
arraySpecify the instance types for a node group.
objectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
objectAn object representing a node group's launch template specification.
stringThe unique name to give your node group.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
stringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
objectThe remote access (SSH) configuration to use with your node group.
objectThe scaling configuration details for the Auto Scaling group that is created for your node group.
arrayThe subnets to use for the Auto Scaling group that is created for your node group.
objectThe metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
arrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
objectThe node group update configuration.
stringThe Kubernetes version to use for your managed nodes.
string
string
stringAWS region.
@@ -60,19 +63,19 @@ Gets or operates on an individual nodegroup resource, use nod Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/nodegroups/index.md b/docs/aws-docs/providers/aws/eks/nodegroups/index.md index 77a3651ae5..61e198b499 100644 --- a/docs/aws-docs/providers/aws/eks/nodegroups/index.md +++ b/docs/aws-docs/providers/aws/eks/nodegroups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of nodegroups in a region or create a nodegroups resource, use nodegroup to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of nodegroups in a region or create a Namenodegroups TypeResource DescriptionResource schema for AWS::EKS::Nodegroup -Idaws.eks.nodegroups +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of nodegroups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md index abdf0cf2d9..c85ec59fe2 100644 --- a/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md +++ b/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pod_identity_association resource, use pod_identity_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual pod_identity_association resource Namepod_identity_association TypeResource DescriptionAn object representing an Amazon EKS PodIdentityAssociation. -Idaws.eks.pod_identity_association +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
cluster_namestringThe cluster that the pod identity association is created for.
role_arnstringThe IAM role ARN that the pod identity association is created for.
namespacestringThe Kubernetes namespace that the pod identity association is created for.
service_accountstringThe Kubernetes service account that the pod identity association is created for.
association_arnstringThe ARN of the pod identity association.
association_idstringThe ID of the pod identity association.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual pod_identity_association resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md index 633e50d543..33d5a6d30c 100644 --- a/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md +++ b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pod_identity_associations in a region or create a pod_identity_associations resource, use pod_identity_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pod_identity_associations in a region or Namepod_identity_associations TypeResource DescriptionAn object representing an Amazon EKS PodIdentityAssociation. -Idaws.eks.pod_identity_associations +Id ## Fields - - + +
NameDatatypeDescription
association_arnstringThe ARN of the pod identity association.
regionstringAWS region.
stringThe ARN of the pod identity association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pod_identity_associations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md index 88a83be459..20f7f25375 100644 --- a/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual global_replication_group resource, use global_replication_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual global_replication_group resource Nameglobal_replication_group TypeResource DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group. -Idaws.elasticache.global_replication_group +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
global_replication_group_id_suffixstringThe suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.
automatic_failover_enabledbooleanAutomaticFailoverEnabled
cache_node_typestringThe cache node type of the Global Datastore
engine_versionstringThe engine version of the Global Datastore.
cache_parameter_group_namestringCache parameter group name to use for the new engine version. This parameter cannot be modified independently.
global_node_group_countintegerIndicates the number of node groups in the Global Datastore.
global_replication_group_descriptionstringThe optional description of the Global Datastore
global_replication_group_idstringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
membersarrayThe replication groups that comprise the Global Datastore.
statusstringThe status of the Global Datastore
regional_configurationsarrayDescribes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
regionstringAWS region.
stringThe suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.
booleanAutomaticFailoverEnabled
stringThe cache node type of the Global Datastore
stringThe engine version of the Global Datastore.
stringCache parameter group name to use for the new engine version. This parameter cannot be modified independently.
integerIndicates the number of node groups in the Global Datastore.
stringThe optional description of the Global Datastore
stringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
arrayThe replication groups that comprise the Global Datastore.
stringThe status of the Global Datastore
arrayDescribes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual global_replication_group resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md index baaee10934..8f89c3110f 100644 --- a/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of global_replication_groups in a region or create a global_replication_groups resource, use global_replication_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of global_replication_groups in a region or Nameglobal_replication_groups TypeResource DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group. -Idaws.elasticache.global_replication_groups +Id ## Fields - - + +
NameDatatypeDescription
global_replication_group_idstringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
regionstringAWS region.
stringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of global_replication_groups in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md index e099b31c8a..98d6eabceb 100644 --- a/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md +++ b/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual serverless_cache resource, use serverless_caches to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual serverless_cache resource, use Nameserverless_cache TypeResource DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache. -Idaws.elasticache.serverless_cache +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
serverless_cache_namestringThe name of the Serverless Cache. This value must be unique.
descriptionstringThe description of the Serverless Cache.
enginestringThe engine name of the Serverless Cache.
major_engine_versionstringThe major engine version of the Serverless Cache.
full_engine_versionstringThe full engine version of the Serverless Cache.
cache_usage_limitsobject
kms_key_idstringThe ID of the KMS key used to encrypt the cluster.
security_group_idsarrayOne or more Amazon VPC security groups associated with this Serverless Cache.
snapshot_arns_to_restorearrayThe ARN's of snapshot to restore Serverless Cache.
tagsarrayAn array of key-value pairs to apply to this Serverless Cache.
user_group_idstringThe ID of the user group.
subnet_idsarrayThe subnet id's of the Serverless Cache.
snapshot_retention_limitintegerThe snapshot retention limit of the Serverless Cache.
daily_snapshot_timestringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
create_timestringThe creation time of the Serverless Cache.
statusstringThe status of the Serverless Cache.
endpointobject
reader_endpointobject
arnstringThe ARN of the Serverless Cache.
final_snapshot_namestringThe final snapshot name which is taken before Serverless Cache is deleted.
regionstringAWS region.
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.
object
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.
object
object
stringThe ARN of the Serverless Cache.
stringThe final snapshot name which is taken before Serverless Cache is deleted.
stringAWS region.
@@ -60,19 +63,19 @@ Gets or operates on an individual serverless_cache resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md index d3d67ed534..76fbc47526 100644 --- a/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md +++ b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of serverless_caches in a region or create a serverless_caches resource, use serverless_cach to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of serverless_caches in a region or create Nameserverless_caches TypeResource DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache. -Idaws.elasticache.serverless_caches +Id ## Fields - - + +
NameDatatypeDescription
serverless_cache_namestringThe name of the Serverless Cache. This value must be unique.
regionstringAWS region.
stringThe name of the Serverless Cache. This value must be unique.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of serverless_caches in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md index a789d86e26..6e056b114e 100644 --- a/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md +++ b/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet_group resource, use subnet_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual subnet_group resource, use Namesubnet_group TypeResource DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup -Idaws.elasticache.subnet_group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringThe description for the cache subnet group.
subnet_idsarrayThe EC2 subnet IDs for the cache subnet group.
cache_subnet_group_namestringThe name for the cache subnet group. This value is stored as a lowercase string.
tagsarray
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual subnet_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md index 1308cf7a20..41abd2079d 100644 --- a/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnet_groups in a region or create a subnet_groups resource, use subnet_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnet_groups in a region or create a Namesubnet_groups TypeResource DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup -Idaws.elasticache.subnet_groups +Id ## Fields - - + +
NameDatatypeDescription
cache_subnet_group_namestringThe name for the cache subnet group. This value is stored as a lowercase string.
regionstringAWS region.
stringThe name for the cache subnet group. This value is stored as a lowercase string.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnet_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticache/user/index.md b/docs/aws-docs/providers/aws/elasticache/user/index.md index ed7190fa64..17a3de97ea 100644 --- a/docs/aws-docs/providers/aws/elasticache/user/index.md +++ b/docs/aws-docs/providers/aws/elasticache/user/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user resource, use users to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual user resource, use usersNameuser TypeResource DescriptionResource Type definition for AWS::ElastiCache::User -Idaws.elasticache.user +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates the user status. Can be "active", "modifying" or "deleting".
user_idstringThe ID of the user.
user_namestringThe username of the user.
enginestringMust be redis.
access_stringstringAccess permissions string used for this user account.
no_password_requiredbooleanIndicates a password is not required for this user account.
passwordsarrayPasswords used for this user account. You can create up to two passwords for each user.
arnstringThe Amazon Resource Name (ARN) of the user account.
authentication_modeobject
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe ID of the user.
stringThe username of the user.
stringMust be redis.
stringAccess permissions string used for this user account.
booleanIndicates a password is not required for this user account.
arrayPasswords used for this user account. You can create up to two passwords for each user.
stringThe Amazon Resource Name (ARN) of the user account.
object
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual user resource, use usersRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticache/user_group/index.md b/docs/aws-docs/providers/aws/elasticache/user_group/index.md index bdd3c7c68a..08228dba18 100644 --- a/docs/aws-docs/providers/aws/elasticache/user_group/index.md +++ b/docs/aws-docs/providers/aws/elasticache/user_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_group resource, use user_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual user_group resource, use us Nameuser_group TypeResource DescriptionResource Type definition for AWS::ElastiCache::UserGroup -Idaws.elasticache.user_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
statusstringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
user_group_idstringThe ID of the user group.
enginestringMust be redis.
user_idsarrayList of users associated to this user group.
arnstringThe Amazon Resource Name (ARN) of the user account.
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual user_group resource, use us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticache/user_groups/index.md b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md index bb67448c08..1669154bc1 100644 --- a/docs/aws-docs/providers/aws/elasticache/user_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_groups in a region or create a user_groups resource, use user_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of user_groups in a region or create a Nameuser_groups TypeResource DescriptionResource Type definition for AWS::ElastiCache::UserGroup -Idaws.elasticache.user_groups +Id ## Fields - - + +
NameDatatypeDescription
user_group_idstringThe ID of the user group.
regionstringAWS region.
stringThe ID of the user group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of user_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticache/users/index.md b/docs/aws-docs/providers/aws/elasticache/users/index.md index 6deb3d27fa..3b989c3c46 100644 --- a/docs/aws-docs/providers/aws/elasticache/users/index.md +++ b/docs/aws-docs/providers/aws/elasticache/users/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of users in a region or create a users resource, use user to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of users in a region or create a user Nameusers TypeResource DescriptionResource Type definition for AWS::ElastiCache::User -Idaws.elasticache.users +Id ## Fields - - + +
NameDatatypeDescription
user_idstringThe ID of the user.
regionstringAWS region.
stringThe ID of the user.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of users in a region or create a user Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md index 481f43702b..a186c40856 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application. -Idaws.elasticbeanstalk.application +Id ## Fields - - - - + + + +
NameDatatypeDescription
application_namestringA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
descriptionstringYour description of the application.
resource_lifecycle_configobjectSpecifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md index 92adf90ff2..24b9d62e75 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application_version resource, use application_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual application_version resource, use Nameapplication_version TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion -Idaws.elasticbeanstalk.application_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstring
application_namestringThe name of the Elastic Beanstalk application that is associated with this application version.
descriptionstringA description of this application version.
source_bundleobjectThe Amazon S3 bucket and key that identify the location of the source bundle for this version.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual application_version resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md index 92596891aa..f656c42a3e 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of application_versions in a region or create a application_versions resource, use application_version to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of application_versions in a region or crea Nameapplication_versions TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion -Idaws.elasticbeanstalk.application_versions +Id ## Fields - - - + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application that is associated with this application version.
idstring
regionstringAWS region.
stringThe name of the Elastic Beanstalk application that is associated with this application version.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of application_versions in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md index ec9995e4fe..6c2eee9888 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application. -Idaws.elasticbeanstalk.applications +Id ## Fields - - + +
NameDatatypeDescription
application_namestringA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md index f198a4af7a..57c2e1f9a6 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration_template resource, use configuration_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual configuration_template resource, Nameconfiguration_template TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate -Idaws.elasticbeanstalk.configuration_template +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application to associate with this configuration template.
descriptionstringAn optional description for this configuration.
environment_idstringThe ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
option_settingsarrayOption values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.
platform_arnstringThe Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.
solution_stack_namestringThe name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.<br/><br/> You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.<br/><br/> Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
source_configurationobjectAn Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.<br/><br/>Values specified in OptionSettings override any values obtained from the SourceConfiguration.<br/><br/>You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.<br/><br/>Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
template_namestringThe name of the configuration template
regionstringAWS region.
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.<br/><br/> You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.<br/><br/> Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
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.<br/><br/>Values specified in OptionSettings override any values obtained from the SourceConfiguration.<br/><br/>You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.<br/><br/>Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
stringThe name of the configuration template
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual configuration_template resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md index 02fbc4bd70..c8b30c771a 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configuration_templates in a region or create a configuration_templates resource, use configuration_template to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of configuration_templates in a region or c Nameconfiguration_templates TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate -Idaws.elasticbeanstalk.configuration_templates +Id ## Fields - - - + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application to associate with this configuration template.
template_namestringThe name of the configuration template
regionstringAWS region.
stringThe name of the Elastic Beanstalk application to associate with this configuration template.
stringThe name of the configuration template
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of configuration_templates in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md index 66c4917c7c..ad7ff41d47 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment -Idaws.elasticbeanstalk.environment +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
platform_arnstringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
application_namestringThe name of the application that is associated with this environment.
descriptionstringYour description for this environment.
environment_namestringA unique name for the environment.
operations_rolestringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
tierobjectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
version_labelstringThe name of the application version to deploy.
endpoint_urlstring
option_settingsarrayKey-value pairs defining configuration options for this environment, such as the instance type.
template_namestringThe name of the Elastic Beanstalk configuration template to use with the environment.
solution_stack_namestringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
cname_prefixstringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
tagsarraySpecifies the tags applied to resources in the environment.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md index 5e7ee69847..ed4e8f83fd 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment -Idaws.elasticbeanstalk.environments +Id ## Fields - - + +
NameDatatypeDescription
environment_namestringA unique name for the environment.
regionstringAWS region.
stringA unique name for the environment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md index b3e22a8c59..306f397718 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual listener resource, use listeners to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual listener resource, use list Namelistener TypeResource DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. -Idaws.elasticloadbalancingv2.listener +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
ssl_policystring[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.<br/> Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.<br/> For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.
load_balancer_arnstringThe Amazon Resource Name (ARN) of the load balancer.
default_actionsarrayThe actions for the default rule. You cannot define a condition for a default rule.<br/> To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).
portintegerThe port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
certificatesarrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.<br/> To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).
protocolstringThe protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
listener_arnstring
alpn_policyarray[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
mutual_authenticationobjectThe mutual authentication configuration information.
regionstringAWS region.
string[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.<br/> Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.<br/> For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.
stringThe Amazon Resource Name (ARN) of the load balancer.
arrayThe actions for the default rule. You cannot define a condition for a default rule.<br/> To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).
integerThe port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
arrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.<br/> To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).
stringThe protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
string
array[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
objectThe mutual authentication configuration information.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual listener resource, use list Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md index d16a151362..7760de8048 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual listener_rule resource, use listener_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual listener_rule resource, use Namelistener_rule TypeResource DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.<br/> For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*. -Idaws.elasticloadbalancingv2.listener_rule +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
rule_arnstring
actionsarrayThe actions.<br/> The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.
priorityintegerThe rule priority. A listener can't have multiple rules with the same priority.<br/> If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.
conditionsarrayThe conditions.<br/> The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.
is_defaultboolean
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the listener.
string
arrayThe actions.<br/> The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.
integerThe rule priority. A listener can't have multiple rules with the same priority.<br/> If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.
arrayThe conditions.<br/> The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.
boolean
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual listener_rule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md index 23f93aa77e..1d0be8b02b 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of listener_rules in a region or create a listener_rules resource, use listener_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of listener_rules in a region or create a < Namelistener_rules TypeResource DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.<br/> For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*. -Idaws.elasticloadbalancingv2.listener_rules +Id ## Fields - - + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of listener_rules in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md index 48d63ec82f..855f999479 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of listeners in a region or create a listeners resource, use listener to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of listeners in a region or create a Namelisteners TypeResource DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. -Idaws.elasticloadbalancingv2.listeners +Id ## Fields - - + +
NameDatatypeDescription
listener_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of listeners in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md index a4a60bbf14..3e9b142440 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual load_balancer resource, use load_balancers to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual load_balancer resource, use Nameload_balancer TypeResource DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer. -Idaws.elasticloadbalancingv2.load_balancer +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
ip_address_typestringThe IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.
security_groupsarray[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
load_balancer_attributesarrayThe load balancer attributes.
schemestringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.<br/> The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.<br/> The default is an Internet-facing load balancer.<br/> You cannot specify a scheme for a Gateway Load Balancer.
dns_namestring
namestringThe name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".<br/> If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
load_balancer_namestring
load_balancer_full_namestring
subnetsarrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [Network Load Balancers] You can specify subnets from one or more Availability Zones.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
typestringThe type of load balancer. The default is ``application``.
canonical_hosted_zone_idstring
tagsarrayThe tags to assign to the load balancer.
load_balancer_arnstring
subnet_mappingsarrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
enforce_security_group_inbound_rules_on_private_link_trafficstringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
regionstringAWS region.
stringThe IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.
array[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
arrayThe load balancer attributes.
stringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.<br/> The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.<br/> The default is an Internet-facing load balancer.<br/> You cannot specify a scheme for a Gateway Load Balancer.
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-".<br/> If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
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.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [Network Load Balancers] You can specify subnets from one or more Availability Zones.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
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.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
stringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual load_balancer resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md index c32da7fafb..47b7244383 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of load_balancers in a region or create a load_balancers resource, use load_balancer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of load_balancers in a region or create a < Nameload_balancers TypeResource DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer. -Idaws.elasticloadbalancingv2.load_balancers +Id ## Fields - - + +
NameDatatypeDescription
load_balancer_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of load_balancers in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md index 3a0a139408..06fa9219af 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual target_group resource, use target_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,36 +24,36 @@ Gets or operates on an individual target_group resource, use Nametarget_group TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup -Idaws.elasticloadbalancingv2.target_group +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ip_address_typestringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
health_check_interval_secondsintegerThe approximate amount of time, in seconds, between health checks of an individual target.
load_balancer_arnsarrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
matcherobject[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
health_check_pathstring[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
portintegerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
targetsarrayThe targets.
health_check_enabledbooleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
protocol_versionstring[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
unhealthy_threshold_countintegerThe number of consecutive health check failures required before considering a target unhealthy.
health_check_timeout_secondsintegerThe amount of time, in seconds, during which no response from a target means a failed health check.
namestringThe name of the target group.
vpc_idstringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
target_group_full_namestringThe full name of the target group.
healthy_threshold_countintegerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
health_check_protocolstringThe protocol the load balancer uses when performing health checks on targets.
target_group_attributesarrayThe attributes.
target_typestringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
health_check_portstringThe port the load balancer uses when performing health checks on targets.
target_group_arnstringThe ARN of the Target Group
protocolstringThe protocol to use for routing traffic to the targets.
target_group_namestringThe name of the target group.
tagsarrayThe tags.
regionstringAWS region.
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.
@@ -63,19 +66,19 @@ Gets or operates on an individual target_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md index 44613eb7de..b283d87c52 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of target_groups in a region or create a target_groups resource, use target_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of target_groups in a region or create a Nametarget_groups TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup -Idaws.elasticloadbalancingv2.target_groups +Id ## Fields - - + +
NameDatatypeDescription
target_group_arnstringThe ARN of the Target Group
regionstringAWS region.
stringThe ARN of the Target Group
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of target_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md index d3eac6ac6c..bb09043dc3 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual trust_store resource, use trust_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual trust_store resource, use t Nametrust_store TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore -Idaws.elasticloadbalancingv2.trust_store +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name of the trust store.
ca_certificates_bundle_s3_bucketstringThe name of the S3 bucket to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_keystringThe name of the S3 object to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_object_versionstringThe version of the S3 bucket that contains the CA certificate bundle.
statusstringThe status of the trust store, could be either of ACTIVE or CREATING.
number_of_ca_certificatesintegerThe number of certificates associated with the trust store.
tagsarrayThe tags to assign to the trust store.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual trust_store resource, use t Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md index 4b8648fc3e..7bb1edcfba 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual trust_store_revocation resource, use trust_store_revocations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual trust_store_revocation resource, Nametrust_store_revocation TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation -Idaws.elasticloadbalancingv2.trust_store_revocation +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
revocation_contentsarrayThe attributes required to create a trust store revocation.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
revocation_idintegerThe ID associated with the revocation.
trust_store_revocationsarrayThe data associated with a trust store revocation
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual trust_store_revocation resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md index 995f61942c..a837583332 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trust_store_revocations in a region or create a trust_store_revocations resource, use trust_store_revocation to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of trust_store_revocations in a region or c Nametrust_store_revocations TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation -Idaws.elasticloadbalancingv2.trust_store_revocations +Id ## Fields - - - + + +
NameDatatypeDescription
revocation_idintegerThe ID associated with the revocation.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
integerThe ID associated with the revocation.
stringThe Amazon Resource Name (ARN) of the trust store.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of trust_store_revocations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md index b3082021c8..3fefc5eaf4 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trust_stores in a region or create a trust_stores resource, use trust_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of trust_stores in a region or create a Nametrust_stores TypeResource DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore -Idaws.elasticloadbalancingv2.trust_stores +Id ## Fields - - + +
NameDatatypeDescription
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the trust store.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of trust_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emr/security_configuration/index.md b/docs/aws-docs/providers/aws/emr/security_configuration/index.md index 57483764d0..bc6e36b9d1 100644 --- a/docs/aws-docs/providers/aws/emr/security_configuration/index.md +++ b/docs/aws-docs/providers/aws/emr/security_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_configuration resource, use security_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual security_configuration resource, Namesecurity_configuration TypeResource DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS. -Idaws.emr.security_configuration +Id ## Fields - - - + + +
NameDatatypeDescription
namestringThe name of the security configuration.
security_configurationobjectThe security configuration details in JSON format.
regionstringAWS region.
stringThe name of the security configuration.
objectThe security configuration details in JSON format.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual security_configuration resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emr/security_configurations/index.md b/docs/aws-docs/providers/aws/emr/security_configurations/index.md index 8e0a3fbce7..8bb3d7a2f7 100644 --- a/docs/aws-docs/providers/aws/emr/security_configurations/index.md +++ b/docs/aws-docs/providers/aws/emr/security_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_configurations in a region or create a security_configurations resource, use security_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_configurations in a region or c Namesecurity_configurations TypeResource DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS. -Idaws.emr.security_configurations +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the security configuration.
regionstringAWS region.
stringThe name of the security configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_configurations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emr/studio/index.md b/docs/aws-docs/providers/aws/emr/studio/index.md index f31aab6b85..4e2977d7b5 100644 --- a/docs/aws-docs/providers/aws/emr/studio/index.md +++ b/docs/aws-docs/providers/aws/emr/studio/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual studio resource, use studios to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual studio resource, use studio Namestudio TypeResource DescriptionResource schema for AWS::EMR::Studio -Idaws.emr.studio +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the EMR Studio.
auth_modestringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
default_s3_locationstringThe default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
descriptionstringA detailed description of the Studio.
engine_security_group_idstringThe ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
namestringA descriptive name for the Amazon EMR Studio.
service_rolestringThe IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
studio_idstringThe ID of the EMR Studio.
subnet_idsarrayA list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
tagsarrayA list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
urlstringThe unique Studio access URL.
user_rolestringThe IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
vpc_idstringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
workspace_security_group_idstringThe ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
idp_auth_urlstringYour identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
idp_relay_state_parameter_namestringThe name of relay state parameter for external Identity Provider.
trusted_identity_propagation_enabledbooleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
idc_user_assignmentstringSpecifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
idc_instance_arnstringThe ARN of the IAM Identity Center instance to create the Studio application.
encryption_key_arnstringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
regionstringAWS region.
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.
@@ -60,19 +63,19 @@ Gets or operates on an individual studio resource, use studio Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md index a7d39e50b0..e5a2b71657 100644 --- a/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md +++ b/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual studio_session_mapping resource, use studio_session_mappings to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual studio_session_mapping resource, Namestudio_session_mapping TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.emr.studio_session_mapping +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
identity_namestringThe name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
identity_typestringSpecifies whether the identity to map to the Studio is a user or a group.
session_policy_arnstringThe Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles.
studio_idstringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual studio_session_mapping resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md index 09bbf8a679..8dc7b040b0 100644 --- a/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md +++ b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of studio_session_mappings in a region or create a studio_session_mappings resource, use studio_session_mapping to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of studio_session_mappings in a region or c Namestudio_session_mappings TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.emr.studio_session_mappings +Id ## Fields - - - - + + + +
NameDatatypeDescription
studio_idstringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
identity_typestringSpecifies whether the identity to map to the Studio is a user or a group.
identity_namestringThe name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
regionstringAWS region.
stringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
stringSpecifies whether the identity to map to the Studio is a user or a group.
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.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of studio_session_mappings in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emr/studios/index.md b/docs/aws-docs/providers/aws/emr/studios/index.md index 66eee1e1d3..d2476f7055 100644 --- a/docs/aws-docs/providers/aws/emr/studios/index.md +++ b/docs/aws-docs/providers/aws/emr/studios/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of studios in a region or create a studios resource, use studio to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of studios in a region or create a st Namestudios TypeResource DescriptionResource schema for AWS::EMR::Studio -Idaws.emr.studios +Id ## Fields - - + +
NameDatatypeDescription
studio_idstringThe ID of the EMR Studio.
regionstringAWS region.
stringThe ID of the EMR Studio.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of studios in a region or create a st Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspace/index.md b/docs/aws-docs/providers/aws/emr/wal_workspace/index.md index 752e0276e8..ea3b022840 100644 --- a/docs/aws-docs/providers/aws/emr/wal_workspace/index.md +++ b/docs/aws-docs/providers/aws/emr/wal_workspace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual wal_workspace resource, use wal_workspaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual wal_workspace resource, use Namewal_workspace TypeResource DescriptionResource schema for AWS::EMR::WALWorkspace Type -Idaws.emr.wal_workspace +Id ## Fields - - - + + +
NameDatatypeDescription
wal_workspace_namestringThe name of the emrwal container
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringThe name of the emrwal container
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual wal_workspace resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md index e092308514..4d4b2881c7 100644 --- a/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md +++ b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of wal_workspaces in a region or create a wal_workspaces resource, use wal_workspace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of wal_workspaces in a region or create a < Namewal_workspaces TypeResource DescriptionResource schema for AWS::EMR::WALWorkspace Type -Idaws.emr.wal_workspaces +Id ## Fields - - + +
NameDatatypeDescription
wal_workspace_namestringThe name of the emrwal container
regionstringAWS region.
stringThe name of the emrwal container
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of wal_workspaces in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md index ff41e8f19a..a187dcb328 100644 --- a/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual virtual_cluster resource, use virtual_clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual virtual_cluster resource, use Namevirtual_cluster TypeResource DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type -Idaws.emrcontainers.virtual_cluster +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
container_providerobjectContainer provider of the virtual cluster.
idstringId of the virtual cluster.
namestringName of the virtual cluster.
tagsarrayAn array of key-value pairs to apply to this virtual cluster.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual virtual_cluster resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md index f3ba4cc1b7..83ea9a79ae 100644 --- a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of virtual_clusters in a region or create a virtual_clusters resource, use virtual_cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of virtual_clusters in a region or create a Namevirtual_clusters TypeResource DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type -Idaws.emrcontainers.virtual_clusters +Id ## Fields - - + +
NameDatatypeDescription
idstringId of the virtual cluster.
regionstringAWS region.
stringId of the virtual cluster.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of virtual_clusters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/emrserverless/application/index.md b/docs/aws-docs/providers/aws/emrserverless/application/index.md index e18dcb83f2..1295a03523 100644 --- a/docs/aws-docs/providers/aws/emrserverless/application/index.md +++ b/docs/aws-docs/providers/aws/emrserverless/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource schema for AWS::EMRServerless::Application Type -Idaws.emrserverless.application +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
architecturestring
namestringUser friendly Application name.
release_labelstringEMR release label.
typestringThe type of the application
initial_capacityarrayInitial capacity initialized when an Application is started.
maximum_capacityobjectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
tagsarrayTag map with key and value
auto_start_configurationobjectConfiguration for Auto Start of Application.
auto_stop_configurationobjectConfiguration for Auto Stop of Application.
image_configurationobject
monitoring_configurationobject
runtime_configurationarray
network_configurationobjectNetwork Configuration for customer VPC connectivity.
arnstringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
application_idstringThe ID of the EMR Serverless Application.
worker_type_specificationsobjectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
regionstringAWS region.
string
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.
object
object
array
objectNetwork Configuration for customer VPC connectivity.
stringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
stringThe ID of the EMR Serverless Application.
objectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/emrserverless/applications/index.md b/docs/aws-docs/providers/aws/emrserverless/applications/index.md index 64766b2e29..f69ff5ff98 100644 --- a/docs/aws-docs/providers/aws/emrserverless/applications/index.md +++ b/docs/aws-docs/providers/aws/emrserverless/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource schema for AWS::EMRServerless::Application Type -Idaws.emrserverless.applications +Id ## Fields - - + +
NameDatatypeDescription
application_idstringThe ID of the EMR Serverless Application.
regionstringAWS region.
stringThe ID of the EMR Serverless Application.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md index dd542dcce5..da115b6792 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual id_mapping_workflow resource, use id_mapping_workflows to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual id_mapping_workflow resource, use Nameid_mapping_workflow TypeResource DescriptionIdMappingWorkflow defined in AWS Entity Resolution service -Idaws.entityresolution.id_mapping_workflow +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
workflow_namestringThe name of the IdMappingWorkflow
descriptionstringThe description of the IdMappingWorkflow
input_source_configarray
output_source_configarray
id_mapping_techniquesobject
role_arnstring
tagsarray
workflow_arnstring
created_atstring
updated_atstring
regionstringAWS region.
stringThe name of the IdMappingWorkflow
stringThe description of the IdMappingWorkflow
array
array
object
string
array
string
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual id_mapping_workflow resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md index 9bc1c0d53d..b3d53840b4 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of id_mapping_workflows in a region or create a id_mapping_workflows resource, use id_mapping_workflow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of id_mapping_workflows in a region or crea Nameid_mapping_workflows TypeResource DescriptionIdMappingWorkflow defined in AWS Entity Resolution service -Idaws.entityresolution.id_mapping_workflows +Id ## Fields - - + +
NameDatatypeDescription
workflow_nameundefinedThe name of the IdMappingWorkflow
regionstringAWS region.
undefinedThe name of the IdMappingWorkflow
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of id_mapping_workflows in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md index c6b6b7dbab..8317783d93 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual id_namespace resource, use id_namespaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual id_namespace resource, use Nameid_namespace TypeResource DescriptionIdNamespace defined in AWS Entity Resolution service -Idaws.entityresolution.id_namespace +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
id_namespace_namestring
descriptionstring
input_source_configarray
id_mapping_workflow_propertiesarray
typestring
role_arnstring
id_namespace_arnstringThe arn associated with the IdNamespace
created_atstringThe date and time when the IdNamespace was created
updated_atstringThe date and time when the IdNamespace was updated
tagsarray
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual id_namespace resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md index d06391dbc2..ef6ed58014 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of id_namespaces in a region or create a id_namespaces resource, use id_namespace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of id_namespaces in a region or create a Nameid_namespaces TypeResource DescriptionIdNamespace defined in AWS Entity Resolution service -Idaws.entityresolution.id_namespaces +Id ## Fields - - + +
NameDatatypeDescription
id_namespace_nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of id_namespaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md index 9c2fca76c8..9b4e3b3a3e 100644 --- a/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual matching_workflow resource, use matching_workflows to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual matching_workflow resource, use < Namematching_workflow TypeResource DescriptionMatchingWorkflow defined in AWS Entity Resolution service -Idaws.entityresolution.matching_workflow +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
workflow_namestringThe name of the MatchingWorkflow
descriptionstringThe description of the MatchingWorkflow
input_source_configarray
output_source_configarray
resolution_techniquesobject
role_arnstring
tagsarray
workflow_arnstring
created_atstring
updated_atstring
regionstringAWS region.
stringThe name of the MatchingWorkflow
stringThe description of the MatchingWorkflow
array
array
object
string
array
string
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual matching_workflow resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md index 5655511b12..fc2054551c 100644 --- a/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of matching_workflows in a region or create a matching_workflows resource, use matching_workflow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of matching_workflows in a region or create Namematching_workflows TypeResource DescriptionMatchingWorkflow defined in AWS Entity Resolution service -Idaws.entityresolution.matching_workflows +Id ## Fields - - + +
NameDatatypeDescription
workflow_nameundefinedThe name of the MatchingWorkflow
regionstringAWS region.
undefinedThe name of the MatchingWorkflow
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of matching_workflows in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md index d33ab71a51..dca2f2d8d2 100644 --- a/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy_statement resource, use policy_statements to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual policy_statement resource, use Namepolicy_statement TypeResource DescriptionPolicy Statement defined in AWS Entity Resolution Service -Idaws.entityresolution.policy_statement +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
statement_idstring
effectstring
actionarray
principalarray
conditionstring
regionstringAWS region.
string
string
string
array
array
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual policy_statement resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md index 1706817b33..45f1e4cd56 100644 --- a/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policy_statements in a region or create a policy_statements resource, use policy_statement to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of policy_statements in a region or create Namepolicy_statements TypeResource DescriptionPolicy Statement defined in AWS Entity Resolution Service -Idaws.entityresolution.policy_statements +Id ## Fields - - - + + +
NameDatatypeDescription
arnundefined
statement_idundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of policy_statements in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md index bcb2b5f5f8..16d3ffc0f2 100644 --- a/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schema_mapping resource, use schema_mappings to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual schema_mapping resource, use Nameschema_mapping TypeResource DescriptionSchemaMapping defined in AWS Entity Resolution service -Idaws.entityresolution.schema_mapping +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
schema_namestringThe name of the SchemaMapping
descriptionstringThe description of the SchemaMapping
mapped_input_fieldsarrayThe SchemaMapping attributes input
tagsarray
schema_arnstring
created_atstring
updated_atstring
has_workflowsboolean
regionstringAWS region.
stringThe name of the SchemaMapping
stringThe description of the SchemaMapping
arrayThe SchemaMapping attributes input
array
string
string
string
boolean
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual schema_mapping resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md index 72d894d07c..c9c57eaf46 100644 --- a/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schema_mappings in a region or create a schema_mappings resource, use schema_mapping to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schema_mappings in a region or create a Nameschema_mappings TypeResource DescriptionSchemaMapping defined in AWS Entity Resolution service -Idaws.entityresolution.schema_mappings +Id ## Fields - - + +
NameDatatypeDescription
schema_nameundefinedThe name of the SchemaMapping
regionstringAWS region.
undefinedThe name of the SchemaMapping
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schema_mappings in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/api_destination/index.md b/docs/aws-docs/providers/aws/events/api_destination/index.md index b2840d2a0e..600399742d 100644 --- a/docs/aws-docs/providers/aws/events/api_destination/index.md +++ b/docs/aws-docs/providers/aws/events/api_destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual api_destination resource, use api_destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual api_destination resource, use Nameapi_destination TypeResource DescriptionResource Type definition for AWS::Events::ApiDestination. -Idaws.events.api_destination +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringName of the apiDestination.
descriptionstring
connection_arnstringThe arn of the connection.
arnstringThe arn of the api destination.
invocation_rate_limit_per_secondinteger
invocation_endpointstringUrl endpoint to invoke.
http_methodstring
regionstringAWS region.
stringName of the apiDestination.
string
stringThe arn of the connection.
stringThe arn of the api destination.
integer
stringUrl endpoint to invoke.
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual api_destination resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/api_destinations/index.md b/docs/aws-docs/providers/aws/events/api_destinations/index.md index 443f03160a..d271f90348 100644 --- a/docs/aws-docs/providers/aws/events/api_destinations/index.md +++ b/docs/aws-docs/providers/aws/events/api_destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of api_destinations in a region or create a api_destinations resource, use api_destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of api_destinations in a region or create a Nameapi_destinations TypeResource DescriptionResource Type definition for AWS::Events::ApiDestination. -Idaws.events.api_destinations +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the apiDestination.
regionstringAWS region.
stringName of the apiDestination.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of api_destinations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/archive/index.md b/docs/aws-docs/providers/aws/events/archive/index.md index b1e33f75d1..8dc8be9c37 100644 --- a/docs/aws-docs/providers/aws/events/archive/index.md +++ b/docs/aws-docs/providers/aws/events/archive/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual archive resource, use archives to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual archive resource, use archi Namearchive TypeResource DescriptionResource Type definition for AWS::Events::Archive -Idaws.events.archive +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
archive_namestring
source_arnstring
descriptionstring
event_patternobject
arnstring
retention_daysinteger
regionstringAWS region.
string
string
string
object
string
integer
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual archive resource, use archi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/archives/index.md b/docs/aws-docs/providers/aws/events/archives/index.md index 20423fb419..a9bb2990d6 100644 --- a/docs/aws-docs/providers/aws/events/archives/index.md +++ b/docs/aws-docs/providers/aws/events/archives/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of archives in a region or create a archives resource, use archive to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of archives in a region or create a a Namearchives TypeResource DescriptionResource Type definition for AWS::Events::Archive -Idaws.events.archives +Id ## Fields - - + +
NameDatatypeDescription
archive_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of archives in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/connection/index.md b/docs/aws-docs/providers/aws/events/connection/index.md index eeed0b890f..3791f2bec3 100644 --- a/docs/aws-docs/providers/aws/events/connection/index.md +++ b/docs/aws-docs/providers/aws/events/connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connection resource, use connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual connection resource, use co Nameconnection TypeResource DescriptionResource Type definition for AWS::Events::Connection. -Idaws.events.connection +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringName of the connection.
arnstringThe arn of the connection resource.
secret_arnstringThe arn of the secrets manager secret created in the customer account.
descriptionstringDescription of the connection.
authorization_typestring
auth_parametersobject
regionstringAWS region.
stringName of the connection.
stringThe arn of the connection resource.
stringThe arn of the secrets manager secret created in the customer account.
stringDescription of the connection.
string
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual connection resource, use co Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/connections/index.md b/docs/aws-docs/providers/aws/events/connections/index.md index 916263b331..6945e892dd 100644 --- a/docs/aws-docs/providers/aws/events/connections/index.md +++ b/docs/aws-docs/providers/aws/events/connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connections in a region or create a connections resource, use connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connections in a region or create a Nameconnections TypeResource DescriptionResource Type definition for AWS::Events::Connection. -Idaws.events.connections +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the connection.
regionstringAWS region.
stringName of the connection.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/endpoint/index.md b/docs/aws-docs/providers/aws/events/endpoint/index.md index 5a84657165..539a6cfeed 100644 --- a/docs/aws-docs/providers/aws/events/endpoint/index.md +++ b/docs/aws-docs/providers/aws/events/endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual endpoint resource, use endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual endpoint resource, use endp Nameendpoint TypeResource DescriptionResource Type definition for AWS::Events::Endpoint. -Idaws.events.endpoint +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
role_arnstring
descriptionstring
routing_configobject
replication_configobject
event_busesarray
endpoint_idstring
endpoint_urlstring
statestring
state_reasonstring
regionstringAWS region.
string
string
string
string
object
object
array
string
string
string
string
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual endpoint resource, use endp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/endpoints/index.md b/docs/aws-docs/providers/aws/events/endpoints/index.md index fff41cd8d9..4e6738672e 100644 --- a/docs/aws-docs/providers/aws/events/endpoints/index.md +++ b/docs/aws-docs/providers/aws/events/endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of endpoints in a region or create a endpoints resource, use endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of endpoints in a region or create a Nameendpoints TypeResource DescriptionResource Type definition for AWS::Events::Endpoint. -Idaws.events.endpoints +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/event_bus/index.md b/docs/aws-docs/providers/aws/events/event_bus/index.md index 55805b3997..cec43942f6 100644 --- a/docs/aws-docs/providers/aws/events/event_bus/index.md +++ b/docs/aws-docs/providers/aws/events/event_bus/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_bus resource, use event_buses to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual event_bus resource, use eve Nameevent_bus TypeResource DescriptionResource type definition for AWS::Events::EventBus -Idaws.events.event_bus +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
event_source_namestringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
namestringThe name of the event bus.
tagsarrayAny tags assigned to the event bus.
policyobjectA JSON string that describes the permission policy statement for the event bus.
arnstringThe Amazon Resource Name (ARN) for the event bus.
regionstringAWS region.
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.
objectA JSON string that describes the permission policy statement for the event bus.
stringThe Amazon Resource Name (ARN) for the event bus.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual event_bus resource, use eve Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/event_buses/index.md b/docs/aws-docs/providers/aws/events/event_buses/index.md index 19b508f7d2..aa10de8d6b 100644 --- a/docs/aws-docs/providers/aws/events/event_buses/index.md +++ b/docs/aws-docs/providers/aws/events/event_buses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_buses in a region or create a event_buses resource, use event_bus to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_buses in a region or create a Nameevent_buses TypeResource DescriptionResource type definition for AWS::Events::EventBus -Idaws.events.event_buses +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the event bus.
regionstringAWS region.
stringThe name of the event bus.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_buses in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/events/rule/index.md b/docs/aws-docs/providers/aws/events/rule/index.md index 587248fc61..70f967236b 100644 --- a/docs/aws-docs/providers/aws/events/rule/index.md +++ b/docs/aws-docs/providers/aws/events/rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule resource, use rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual rule resource, use rulesNamerule TypeResource DescriptionResource Type definition for AWS::Events::Rule -Idaws.events.rule +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
event_bus_namestringThe name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
event_patternobjectThe event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
schedule_expressionstringThe scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
descriptionstringThe description of the rule.
statestringThe state of the rule.
targetsarrayAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.<br/>Targets are the resources that are invoked when a rule is triggered.
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
role_arnstringThe Amazon Resource Name (ARN) of the role that is used for target invocation.
namestringThe name of the rule.
regionstringAWS region.
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.<br/>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.
@@ -49,19 +52,19 @@ Gets or operates on an individual rule resource, use rulesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/events/rules/index.md b/docs/aws-docs/providers/aws/events/rules/index.md index d5309935cb..c511a5185a 100644 --- a/docs/aws-docs/providers/aws/events/rules/index.md +++ b/docs/aws-docs/providers/aws/events/rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rules in a region or create a rules resource, use rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rules in a region or create a rule Namerules TypeResource DescriptionResource Type definition for AWS::Events::Rule -Idaws.events.rules +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
regionstringAWS region.
stringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rules in a region or create a rule Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md index 9e5062fe64..0c3b83553e 100644 --- a/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual discoverer resource, use discoverers to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual discoverer resource, use di Namediscoverer TypeResource DescriptionResource Type definition for AWS::EventSchemas::Discoverer -Idaws.eventschemas.discoverer +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
discoverer_arnstringThe ARN of the discoverer.
discoverer_idstringThe Id of the discoverer.
descriptionstringA description for the discoverer.
source_arnstringThe ARN of the event bus.
cross_accountbooleanDefines whether event schemas from other accounts are discovered. Default is True.
statestringDefines the current state of the discoverer.
tagsarrayTags associated with the resource.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual discoverer resource, use di Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md index fe39a6bd44..63d0c72efb 100644 --- a/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of discoverers in a region or create a discoverers resource, use discoverer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of discoverers in a region or create a Namediscoverers TypeResource DescriptionResource Type definition for AWS::EventSchemas::Discoverer -Idaws.eventschemas.discoverers +Id ## Fields - - + +
NameDatatypeDescription
discoverer_arnstringThe ARN of the discoverer.
regionstringAWS region.
stringThe ARN of the discoverer.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of discoverers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md b/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md index f027b66aba..d00083059b 100644 --- a/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual eventschemas_registry resource, use eventschemas_registries to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual eventschemas_registry resource, u Nameeventschemas_registry TypeResource DescriptionResource Type definition for AWS::EventSchemas::Registry -Idaws.eventschemas.eventschemas_registry +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
registry_namestringThe name of the schema registry.
descriptionstringA description of the registry to be created.
registry_arnstringThe ARN of the registry.
tagsarrayTags associated with the resource.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual eventschemas_registry resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eventschemas/registries/index.md b/docs/aws-docs/providers/aws/eventschemas/registries/index.md index 12be7547d0..6787260f38 100644 --- a/docs/aws-docs/providers/aws/eventschemas/registries/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/registries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of registries in a region or create a registries resource, use registry to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of registries in a region or create a Nameregistries TypeResource DescriptionResource Type definition for AWS::EventSchemas::Registry -Idaws.eventschemas.registries +Id ## Fields - - + +
NameDatatypeDescription
registry_arnstringThe ARN of the registry.
regionstringAWS region.
stringThe ARN of the registry.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of registries in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md index d0c6781c85..8f1bd6b266 100644 --- a/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of registry_policies in a region or create a registry_policies resource, use registry_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of registry_policies in a region or create Nameregistry_policies TypeResource DescriptionResource Type definition for AWS::EventSchemas::RegistryPolicy -Idaws.eventschemas.registry_policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of registry_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md index 50f8c6dc50..945552061f 100644 --- a/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual registry_policy resource, use registry_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual registry_policy resource, use Nameregistry_policy TypeResource DescriptionResource Type definition for AWS::EventSchemas::RegistryPolicy -Idaws.eventschemas.registry_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstring
policyobject
registry_namestring
revision_idstring
regionstringAWS region.
string
object
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual registry_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eventschemas/schema/index.md b/docs/aws-docs/providers/aws/eventschemas/schema/index.md index 4b1ae102eb..2847f0173a 100644 --- a/docs/aws-docs/providers/aws/eventschemas/schema/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/schema/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schema resource, use schemata to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual schema resource, use schema Nameschema TypeResource DescriptionResource Type definition for AWS::EventSchemas::Schema -Idaws.eventschemas.schema +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
typestringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
descriptionstringA description of the schema.
schema_versionstringThe version number of the schema.
contentstringThe source of the schema definition.
registry_namestringThe name of the schema registry.
schema_arnstringThe ARN of the schema.
schema_namestringThe name of the schema.
last_modifiedstringThe last modified time of the schema.
version_created_datestringThe date the schema version was created.
tagsarrayTags associated with the resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual schema resource, use schema Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/eventschemas/schemata/index.md b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md index e03e024778..b41a7e046b 100644 --- a/docs/aws-docs/providers/aws/eventschemas/schemata/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schemata in a region or create a schemata resource, use schema to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schemata in a region or create a s Nameschemata TypeResource DescriptionResource Type definition for AWS::EventSchemas::Schema -Idaws.eventschemas.schemata +Id ## Fields - - + +
NameDatatypeDescription
schema_arnstringThe ARN of the schema.
regionstringAWS region.
stringThe ARN of the schema.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schemata in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/evidently/experiment/index.md b/docs/aws-docs/providers/aws/evidently/experiment/index.md index d8598a2a73..944c4b6392 100644 --- a/docs/aws-docs/providers/aws/evidently/experiment/index.md +++ b/docs/aws-docs/providers/aws/evidently/experiment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual experiment resource, use experiments to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual experiment resource, use ex Nameexperiment TypeResource DescriptionResource Type definition for AWS::Evidently::Experiment. -Idaws.evidently.experiment +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
projectstring
descriptionstring
running_statusobjectStart Experiment. Default is False
randomization_saltstring
treatmentsarray
metric_goalsarray
sampling_rateinteger
online_ab_configobject
segmentstring
remove_segmentboolean
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual experiment resource, use ex Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/evidently/experiments/index.md b/docs/aws-docs/providers/aws/evidently/experiments/index.md index 2fc323683f..32e3c2f0c3 100644 --- a/docs/aws-docs/providers/aws/evidently/experiments/index.md +++ b/docs/aws-docs/providers/aws/evidently/experiments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of experiments in a region or create a experiments resource, use experiment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of experiments in a region or create a Nameexperiments TypeResource DescriptionResource Type definition for AWS::Evidently::Experiment. -Idaws.evidently.experiments +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of experiments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/evidently/feature/index.md b/docs/aws-docs/providers/aws/evidently/feature/index.md index d3e919c4ae..60a97be920 100644 --- a/docs/aws-docs/providers/aws/evidently/feature/index.md +++ b/docs/aws-docs/providers/aws/evidently/feature/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual feature resource, use features to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual feature resource, use featu Namefeature TypeResource DescriptionResource Type definition for AWS::Evidently::Feature. -Idaws.evidently.feature +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
projectstring
namestring
descriptionstring
evaluation_strategystring
variationsarray
default_variationstring
entity_overridesarray
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
string
array
string
array
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual feature resource, use featu Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/evidently/features/index.md b/docs/aws-docs/providers/aws/evidently/features/index.md index 259fb20865..cdf24076c4 100644 --- a/docs/aws-docs/providers/aws/evidently/features/index.md +++ b/docs/aws-docs/providers/aws/evidently/features/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of features in a region or create a features resource, use feature to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of features in a region or create a f Namefeatures TypeResource DescriptionResource Type definition for AWS::Evidently::Feature. -Idaws.evidently.features +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of features in a region or create a f Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/evidently/launch/index.md b/docs/aws-docs/providers/aws/evidently/launch/index.md index 591bb21e73..e2a38aa9af 100644 --- a/docs/aws-docs/providers/aws/evidently/launch/index.md +++ b/docs/aws-docs/providers/aws/evidently/launch/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual launch resource, use launches to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual launch resource, use launch Namelaunch TypeResource DescriptionResource Type definition for AWS::Evidently::Launch. -Idaws.evidently.launch +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
projectstring
descriptionstring
randomization_saltstring
scheduled_splits_configarray
groupsarray
metric_monitorsarray
tagsarrayAn array of key-value pairs to apply to this resource.
execution_statusobjectStart or Stop Launch Launch. Default is not started.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual launch resource, use launch Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/evidently/launches/index.md b/docs/aws-docs/providers/aws/evidently/launches/index.md index 625a391f85..8938c9b9f4 100644 --- a/docs/aws-docs/providers/aws/evidently/launches/index.md +++ b/docs/aws-docs/providers/aws/evidently/launches/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of launches in a region or create a launches resource, use launch to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of launches in a region or create a l Namelaunches TypeResource DescriptionResource Type definition for AWS::Evidently::Launch. -Idaws.evidently.launches +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of launches in a region or create a l Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/evidently/project/index.md b/docs/aws-docs/providers/aws/evidently/project/index.md index 5dbf28c52c..58d65ef818 100644 --- a/docs/aws-docs/providers/aws/evidently/project/index.md +++ b/docs/aws-docs/providers/aws/evidently/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionResource Type definition for AWS::Evidently::Project -Idaws.evidently.project +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
namestring
descriptionstring
data_deliveryobject
app_config_resourceobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
object
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/evidently/projects/index.md b/docs/aws-docs/providers/aws/evidently/projects/index.md index 7a985de1f9..c7937a42ff 100644 --- a/docs/aws-docs/providers/aws/evidently/projects/index.md +++ b/docs/aws-docs/providers/aws/evidently/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionResource Type definition for AWS::Evidently::Project -Idaws.evidently.projects +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/evidently/segment/index.md b/docs/aws-docs/providers/aws/evidently/segment/index.md index 90303c2e05..88364642b5 100644 --- a/docs/aws-docs/providers/aws/evidently/segment/index.md +++ b/docs/aws-docs/providers/aws/evidently/segment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual segment resource, use segments to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual segment resource, use segme Namesegment TypeResource DescriptionResource Type definition for AWS::Evidently::Segment -Idaws.evidently.segment +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
namestring
descriptionstring
patternstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -45,14 +48,14 @@ Gets or operates on an individual segment resource, use segme Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/evidently/segments/index.md b/docs/aws-docs/providers/aws/evidently/segments/index.md index bba9be904b..73ad822999 100644 --- a/docs/aws-docs/providers/aws/evidently/segments/index.md +++ b/docs/aws-docs/providers/aws/evidently/segments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of segments in a region or create a segments resource, use segment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of segments in a region or create a s Namesegments TypeResource DescriptionResource Type definition for AWS::Evidently::Segment -Idaws.evidently.segments +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of segments in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/finspace/environment/index.md b/docs/aws-docs/providers/aws/finspace/environment/index.md index 8e8c635746..90b1b9f8a9 100644 --- a/docs/aws-docs/providers/aws/finspace/environment/index.md +++ b/docs/aws-docs/providers/aws/finspace/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.finspace.environment +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
namestringName of the Environment
aws_account_idstringAWS account ID associated with the Environment
descriptionstringDescription of the Environment
statusstringState of the Environment
environment_urlstringURL used to login to the Environment
environment_arnstringARN of the Environment
sage_maker_studio_domain_urlstringSageMaker Studio Domain URL associated with the Environment
kms_key_idstringKMS key used to encrypt customer data within FinSpace Environment infrastructure
dedicated_service_account_idstringID for FinSpace created account used to store Environment artifacts
federation_modestringFederation mode used with the Environment
federation_parametersobject
superuser_parametersobject
data_bundlesarrayARNs of FinSpace Data Bundles to install
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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
object
object
arrayARNs of FinSpace Data Bundles to install
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/finspace/environments/index.md b/docs/aws-docs/providers/aws/finspace/environments/index.md index 4cee274873..4e4e30e559 100644 --- a/docs/aws-docs/providers/aws/finspace/environments/index.md +++ b/docs/aws-docs/providers/aws/finspace/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.finspace.environments +Id ## Fields - - + +
NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
regionstringAWS region.
stringUnique identifier for representing FinSpace Environment
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fis/experiment_template/index.md b/docs/aws-docs/providers/aws/fis/experiment_template/index.md index 40ecb14691..d636e06d91 100644 --- a/docs/aws-docs/providers/aws/fis/experiment_template/index.md +++ b/docs/aws-docs/providers/aws/fis/experiment_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual experiment_template resource, use experiment_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual experiment_template resource, use Nameexperiment_template TypeResource DescriptionResource schema for AWS::FIS::ExperimentTemplate -Idaws.fis.experiment_template +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
idstring
descriptionstring
targetsobject
actionsobject
stop_conditionsarray
log_configurationobject
role_arnstring
tagsobject
experiment_optionsobject
regionstringAWS region.
string
string
object
object
array
object
string
object
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual experiment_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fis/experiment_templates/index.md b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md index 6ff9fb86eb..7344a159f4 100644 --- a/docs/aws-docs/providers/aws/fis/experiment_templates/index.md +++ b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of experiment_templates in a region or create a experiment_templates resource, use experiment_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of experiment_templates in a region or crea Nameexperiment_templates TypeResource DescriptionResource schema for AWS::FIS::ExperimentTemplate -Idaws.fis.experiment_templates +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of experiment_templates in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md b/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md index 7c91271f1d..ae5e57b66b 100644 --- a/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md +++ b/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual target_account_configuration resource, use target_account_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual target_account_configuration reso Nametarget_account_configuration TypeResource DescriptionResource schema for AWS::FIS::TargetAccountConfiguration -Idaws.fis.target_account_configuration +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
experiment_template_idstring
account_idstring
role_arnstring
descriptionstring
regionstringAWS region.
string
string
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual target_account_configuration reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md index 201172d8f0..f4ef6bfd17 100644 --- a/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md +++ b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of target_account_configurations in a region or create a target_account_configurations resource, use target_account_configuration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of target_account_configurations in a regio Nametarget_account_configurations TypeResource DescriptionResource schema for AWS::FIS::TargetAccountConfiguration -Idaws.fis.target_account_configurations +Id ## Fields - - - + + +
NameDatatypeDescription
experiment_template_idundefined
account_idundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of target_account_configurations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fms/notification_channel/index.md b/docs/aws-docs/providers/aws/fms/notification_channel/index.md index 8d8db23e19..f51748e864 100644 --- a/docs/aws-docs/providers/aws/fms/notification_channel/index.md +++ b/docs/aws-docs/providers/aws/fms/notification_channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual notification_channel resource, use notification_channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual notification_channel resource, us Namenotification_channel TypeResource DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. -Idaws.fms.notification_channel +Id ## Fields - - - + + +
NameDatatypeDescription
sns_role_namestring
sns_topic_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual notification_channel resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fms/notification_channels/index.md b/docs/aws-docs/providers/aws/fms/notification_channels/index.md index f4b0a9db34..f29640ed52 100644 --- a/docs/aws-docs/providers/aws/fms/notification_channels/index.md +++ b/docs/aws-docs/providers/aws/fms/notification_channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of notification_channels in a region or create a notification_channels resource, use notification_channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of notification_channels in a region or cre Namenotification_channels TypeResource DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. -Idaws.fms.notification_channels +Id ## Fields - - + +
NameDatatypeDescription
sns_topic_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of notification_channels in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fms/policies/index.md b/docs/aws-docs/providers/aws/fms/policies/index.md index ba1a0f0ffd..42b09d1019 100644 --- a/docs/aws-docs/providers/aws/fms/policies/index.md +++ b/docs/aws-docs/providers/aws/fms/policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policies in a region or create a policies resource, use policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of policies in a region or create a p Namepolicies TypeResource DescriptionCreates an AWS Firewall Manager policy. -Idaws.fms.policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of policies in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fms/policy/index.md b/docs/aws-docs/providers/aws/fms/policy/index.md index 9e5112fe42..955f684ee9 100644 --- a/docs/aws-docs/providers/aws/fms/policy/index.md +++ b/docs/aws-docs/providers/aws/fms/policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy resource, use policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual policy resource, use polici Namepolicy TypeResource DescriptionCreates an AWS Firewall Manager policy. -Idaws.fms.policy +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
exclude_mapobject
exclude_resource_tagsboolean
include_mapobject
idstring
policy_namestring
policy_descriptionstring
remediation_enabledboolean
resource_tagsarray
resource_typestring
resource_type_listarray
resource_set_idsarray
security_service_policy_dataobject
arnstring
delete_all_policy_resourcesboolean
resources_clean_upboolean
tagsarray
regionstringAWS region.
object
boolean
object
string
string
string
boolean
array
string
array
array
object
string
boolean
boolean
array
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual policy resource, use polici Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fms/resource_set/index.md b/docs/aws-docs/providers/aws/fms/resource_set/index.md index 766fa2565a..de82bbc1b0 100644 --- a/docs/aws-docs/providers/aws/fms/resource_set/index.md +++ b/docs/aws-docs/providers/aws/fms/resource_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_set resource, use resource_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual resource_set resource, use Nameresource_set TypeResource DescriptionCreates an AWS Firewall Manager resource set. -Idaws.fms.resource_set +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
namestring
descriptionstring
resource_type_listarray
resourcesarray
tagsarray
regionstringAWS region.
string
string
string
array
array
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual resource_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fms/resource_sets/index.md b/docs/aws-docs/providers/aws/fms/resource_sets/index.md index 0f3284dc73..108aa3f76b 100644 --- a/docs/aws-docs/providers/aws/fms/resource_sets/index.md +++ b/docs/aws-docs/providers/aws/fms/resource_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_sets in a region or create a resource_sets resource, use resource_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_sets in a region or create a Nameresource_sets TypeResource DescriptionCreates an AWS Firewall Manager resource set. -Idaws.fms.resource_sets +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/forecast/dataset/index.md b/docs/aws-docs/providers/aws/forecast/dataset/index.md index 711b4930ba..70ae889733 100644 --- a/docs/aws-docs/providers/aws/forecast/dataset/index.md +++ b/docs/aws-docs/providers/aws/forecast/dataset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset resource, use datasets to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual dataset resource, use datas Namedataset TypeResource DescriptionResource Type Definition for AWS::Forecast::Dataset -Idaws.forecast.dataset +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
dataset_namestringA name for the dataset
dataset_typestringThe dataset type
data_frequencystringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
domainstringThe domain associated with the dataset
encryption_configobject
schemaobject
tagsarray
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual dataset resource, use datas Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_group/index.md b/docs/aws-docs/providers/aws/forecast/dataset_group/index.md index 3f7ff49503..e917ec9345 100644 --- a/docs/aws-docs/providers/aws/forecast/dataset_group/index.md +++ b/docs/aws-docs/providers/aws/forecast/dataset_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset_group resource, use dataset_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual dataset_group resource, use Namedataset_group TypeResource DescriptionRepresents a dataset group that holds a collection of related datasets -Idaws.forecast.dataset_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
dataset_arnsarrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
dataset_group_namestringA name for the dataset group.
domainstringThe domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
tagsarrayThe tags of Application Insights application.
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to delete.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual dataset_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md index e728ea016f..bec6efd028 100644 --- a/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md +++ b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dataset_groups in a region or create a dataset_groups resource, use dataset_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dataset_groups in a region or create a < Namedataset_groups TypeResource DescriptionRepresents a dataset group that holds a collection of related datasets -Idaws.forecast.dataset_groups +Id ## Fields - - + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to delete.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dataset_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/forecast/datasets/index.md b/docs/aws-docs/providers/aws/forecast/datasets/index.md index 743589e0a9..b8703d78a4 100644 --- a/docs/aws-docs/providers/aws/forecast/datasets/index.md +++ b/docs/aws-docs/providers/aws/forecast/datasets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of datasets in a region or create a datasets resource, use dataset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of datasets in a region or create a d Namedatasets TypeResource DescriptionResource Type Definition for AWS::Forecast::Dataset -Idaws.forecast.datasets +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of datasets in a region or create a d Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/detector/index.md b/docs/aws-docs/providers/aws/frauddetector/detector/index.md index 8136b84515..f07fce9f6c 100644 --- a/docs/aws-docs/providers/aws/frauddetector/detector/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/detector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual detector resource, use detectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual detector resource, use dete Namedetector TypeResource DescriptionA resource schema for a Detector in Amazon Fraud Detector. -Idaws.frauddetector.detector +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
detector_idstringThe ID of the detector
detector_version_statusstringThe desired detector version status for the detector
detector_version_idstringThe active version ID of the detector
rule_execution_modestring
tagsarrayTags associated with this detector.
descriptionstringThe description of the detector.
rulesarray
event_typeobjectThe event type to associate this detector with.
arnstringThe ARN of the detector.
created_timestringThe time when the detector was created.
last_updated_timestringThe time when the detector was last updated.
associated_modelsarrayThe models to associate with this detector.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual detector resource, use dete Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/detectors/index.md b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md index f5c7f1103b..860e0602ef 100644 --- a/docs/aws-docs/providers/aws/frauddetector/detectors/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of detectors in a region or create a detectors resource, use detector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of detectors in a region or create a Namedetectors TypeResource DescriptionA resource schema for a Detector in Amazon Fraud Detector. -Idaws.frauddetector.detectors +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the detector.
regionstringAWS region.
stringThe ARN of the detector.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of detectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_type/index.md b/docs/aws-docs/providers/aws/frauddetector/event_type/index.md index f4644a0a66..41ce16d07b 100644 --- a/docs/aws-docs/providers/aws/frauddetector/event_type/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/event_type/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_type resource, use event_types to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual event_type resource, use ev Nameevent_type TypeResource DescriptionA resource schema for an EventType in Amazon Fraud Detector. -Idaws.frauddetector.event_type +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringThe name for the event type
tagsarrayTags associated with this event type.
descriptionstringThe description of the event type.
event_variablesarray
labelsarray
entity_typesarray
arnstringThe ARN of the event type.
created_timestringThe time when the event type was created.
last_updated_timestringThe time when the event type was last updated.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual event_type resource, use ev Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_types/index.md b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md index b3648032b5..4cfb057aa9 100644 --- a/docs/aws-docs/providers/aws/frauddetector/event_types/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_types in a region or create a event_types resource, use event_type to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_types in a region or create a Nameevent_types TypeResource DescriptionA resource schema for an EventType in Amazon Fraud Detector. -Idaws.frauddetector.event_types +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the event type.
regionstringAWS region.
stringThe ARN of the event type.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_types in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md b/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md index c5ba157fa8..79c4e570ac 100644 --- a/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual frauddetector_list resource, use frauddetector_lists to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual frauddetector_list resource, use Namefrauddetector_list TypeResource DescriptionA resource schema for a List in Amazon Fraud Detector. -Idaws.frauddetector.frauddetector_list +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringThe list ARN.
namestringThe name of the list.
descriptionstringThe description of the list.
variable_typestringThe variable type of the list.
created_timestringThe time when the list was created.
last_updated_timestringThe time when the list was last updated.
tagsarrayTags associated with this list.
elementsarrayThe elements in this list.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual frauddetector_list resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/label/index.md b/docs/aws-docs/providers/aws/frauddetector/label/index.md index 1aad40d32a..e9dc13c7f4 100644 --- a/docs/aws-docs/providers/aws/frauddetector/label/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/label/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual label resource, use labels to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual label resource, use labels< Namelabel TypeResource DescriptionAn label for fraud detector. -Idaws.frauddetector.label +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name of the label.
tagsarrayTags associated with this label.
descriptionstringThe label description.
arnstringThe label ARN.
created_timestringThe timestamp when the label was created.
last_updated_timestringThe timestamp when the label was last updated.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual label resource, use labels< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/labels/index.md b/docs/aws-docs/providers/aws/frauddetector/labels/index.md index f046554274..c406889430 100644 --- a/docs/aws-docs/providers/aws/frauddetector/labels/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/labels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of labels in a region or create a labels resource, use label to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of labels in a region or create a lab Namelabels TypeResource DescriptionAn label for fraud detector. -Idaws.frauddetector.labels +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe label ARN.
regionstringAWS region.
stringThe label ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of labels in a region or create a lab Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/lists/index.md b/docs/aws-docs/providers/aws/frauddetector/lists/index.md index 9bb6dbac40..e7e7a98caf 100644 --- a/docs/aws-docs/providers/aws/frauddetector/lists/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/lists/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of lists in a region or create a lists resource, use list to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of lists in a region or create a list Namelists TypeResource DescriptionA resource schema for a List in Amazon Fraud Detector. -Idaws.frauddetector.lists +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe list ARN.
regionstringAWS region.
stringThe list ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of lists in a region or create a list Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcome/index.md b/docs/aws-docs/providers/aws/frauddetector/outcome/index.md index 1f4065734d..5cb659179c 100644 --- a/docs/aws-docs/providers/aws/frauddetector/outcome/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/outcome/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual outcome resource, use outcomes to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual outcome resource, use outco Nameoutcome TypeResource DescriptionAn outcome for rule evaluation. -Idaws.frauddetector.outcome +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name of the outcome.
tagsarrayTags associated with this outcome.
descriptionstringThe outcome description.
arnstringThe outcome ARN.
created_timestringThe timestamp when the outcome was created.
last_updated_timestringThe timestamp when the outcome was last updated.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual outcome resource, use outco Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md index 9a59a1057b..9f4fcc75d0 100644 --- a/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of outcomes in a region or create a outcomes resource, use outcome to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of outcomes in a region or create a o Nameoutcomes TypeResource DescriptionAn outcome for rule evaluation. -Idaws.frauddetector.outcomes +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe outcome ARN.
regionstringAWS region.
stringThe outcome ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of outcomes in a region or create a o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/frauddetector/variable/index.md b/docs/aws-docs/providers/aws/frauddetector/variable/index.md index 0de4266d22..c94655456a 100644 --- a/docs/aws-docs/providers/aws/frauddetector/variable/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/variable/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual variable resource, use variables to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual variable resource, use vari Namevariable TypeResource DescriptionA resource schema for a Variable in Amazon Fraud Detector. -Idaws.frauddetector.variable +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the variable.
data_sourcestringThe source of the data.
data_typestringThe data type.
default_valuestringThe default value for the variable when no value is received.
descriptionstringThe description.
tagsarrayTags associated with this variable.
variable_typestringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
arnstringThe ARN of the variable.
created_timestringThe time when the variable was created.
last_updated_timestringThe time when the variable was last updated.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual variable resource, use vari Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/frauddetector/variables/index.md b/docs/aws-docs/providers/aws/frauddetector/variables/index.md index e089b59592..51ec9ea123 100644 --- a/docs/aws-docs/providers/aws/frauddetector/variables/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/variables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of variables in a region or create a variables resource, use variable to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of variables in a region or create a Namevariables TypeResource DescriptionA resource schema for a Variable in Amazon Fraud Detector. -Idaws.frauddetector.variables +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the variable.
regionstringAWS region.
stringThe ARN of the variable.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of variables in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md index 7bf95f9530..be2c29f3b1 100644 --- a/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md +++ b/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_repository_association resource, use data_repository_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual data_repository_association resou Namedata_repository_association TypeResource DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. <br/> Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). -Idaws.fsx.data_repository_association +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
association_idstring
resource_arnstring
file_system_idstringThe ID of the file system on which the data repository association is configured.
file_system_pathstringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.<br/> This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.<br/> If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
data_repository_pathstringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to.
batch_import_meta_data_on_createbooleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``.
imported_file_chunk_sizeintegerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.<br/> The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
s3objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
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``.<br/> This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.<br/> If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
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.<br/> The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
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.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual data_repository_association resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md index a4c1128bdb..a8a7bb4d38 100644 --- a/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md +++ b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_repository_associations in a region or create a data_repository_associations resource, use data_repository_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_repository_associations in a region Namedata_repository_associations TypeResource DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. <br/> Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). -Idaws.fsx.data_repository_associations +Id ## Fields - - + +
NameDatatypeDescription
association_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_repository_associations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/alias/index.md b/docs/aws-docs/providers/aws/gamelift/alias/index.md index 9d67fc1df9..bc5eaed94d 100644 --- a/docs/aws-docs/providers/aws/gamelift/alias/index.md +++ b/docs/aws-docs/providers/aws/gamelift/alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alias resource, use aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual alias resource, use aliases Namealias TypeResource DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination. -Idaws.gamelift.alias +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringA human-readable description of the alias.
namestringA descriptive label that is associated with an alias. Alias names do not need to be unique.
routing_strategyobjectA routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.
alias_idstringUnique alias ID
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual alias resource, use aliases Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/aliases/index.md b/docs/aws-docs/providers/aws/gamelift/aliases/index.md index 9591065a69..6fa4bfee77 100644 --- a/docs/aws-docs/providers/aws/gamelift/aliases/index.md +++ b/docs/aws-docs/providers/aws/gamelift/aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of aliases in a region or create a aliases resource, use alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of aliases in a region or create a al Namealiases TypeResource DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination. -Idaws.gamelift.aliases +Id ## Fields - - + +
NameDatatypeDescription
alias_idstringUnique alias ID
regionstringAWS region.
stringUnique alias ID
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of aliases in a region or create a al Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/build/index.md b/docs/aws-docs/providers/aws/gamelift/build/index.md index 03514926a1..986ec016a1 100644 --- a/docs/aws-docs/providers/aws/gamelift/build/index.md +++ b/docs/aws-docs/providers/aws/gamelift/build/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual build resource, use builds to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual build resource, use builds< Namebuild TypeResource DescriptionResource Type definition for AWS::GameLift::Build -Idaws.gamelift.build +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
build_idstringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
namestringA descriptive label that is associated with a build. Build names do not need to be unique.
operating_systemstringThe operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
storage_locationobjectInformation indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
versionstringVersion information that is associated with this build. Version strings do not need to be unique.
server_sdk_versionstringA server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual build resource, use builds< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/builds/index.md b/docs/aws-docs/providers/aws/gamelift/builds/index.md index afb75b6801..dbc913f15c 100644 --- a/docs/aws-docs/providers/aws/gamelift/builds/index.md +++ b/docs/aws-docs/providers/aws/gamelift/builds/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of builds in a region or create a builds resource, use build to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of builds in a region or create a bui Namebuilds TypeResource DescriptionResource Type definition for AWS::GameLift::Build -Idaws.gamelift.builds +Id ## Fields - - + +
NameDatatypeDescription
build_idstringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of builds in a region or create a bui Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/fleet/index.md b/docs/aws-docs/providers/aws/gamelift/fleet/index.md index 388d4d5d8e..b18de22189 100644 --- a/docs/aws-docs/providers/aws/gamelift/fleet/index.md +++ b/docs/aws-docs/providers/aws/gamelift/fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet resource, use fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,41 +24,41 @@ Gets or operates on an individual fleet resource, use fleets< Namefleet TypeResource DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions. -Idaws.gamelift.fleet +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
scaling_policiesarrayA list of rules that control how a fleet is scaled.
descriptionstringA human-readable description of a fleet.
peer_vpc_idstringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
apply_capacitystringDetermines whether to apply fleet or location capacities on fleet creation.
e_c2_inbound_permissionsarrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
compute_typestringComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
namestringA descriptive label that is associated with a fleet. Fleet names do not need to be unique.
anywhere_configurationundefinedConfiguration for Anywhere fleet.
instance_role_arnstringA unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
fleet_idstringUnique fleet ID
certificate_configurationobjectIndicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
instance_role_credentials_providerstringCredentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
desired_ec2_instancesinteger[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
server_launch_parametersstringThis parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
fleet_typestringIndicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
locationsarray
new_game_session_protection_policystringA game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
script_idstringA unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.<br/><br/>Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
max_sizeinteger[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
runtime_configurationobjectInstructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.<br/><br/>This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
log_pathsarrayThis parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
server_launch_pathstringThis parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
min_sizeinteger[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
peer_vpc_aws_account_idstringA unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
metric_groupsarrayThe name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
build_idstringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
resource_creation_limit_policyobjectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
e_c2_instance_typestringThe name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
regionstringAWS region.
arrayA list of rules that control how a fleet is scaled.
stringA human-readable description of a fleet.
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.
stringDetermines whether to apply fleet or location capacities on fleet creation.
arrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
stringComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
stringA descriptive label that is associated with a fleet. Fleet names do not need to be unique.
undefinedConfiguration for Anywhere 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.
stringUnique fleet ID
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.
stringCredentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
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.
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.
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
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 a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.<br/><br/>Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
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.
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.<br/><br/>This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
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()
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.
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 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.
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 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.
objectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
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.
stringAWS region.
@@ -68,19 +71,19 @@ Gets or operates on an individual fleet resource, use fleets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/fleets/index.md b/docs/aws-docs/providers/aws/gamelift/fleets/index.md index e543785a3c..fbf14600b8 100644 --- a/docs/aws-docs/providers/aws/gamelift/fleets/index.md +++ b/docs/aws-docs/providers/aws/gamelift/fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleets in a region or create a fleets resource, use fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleets in a region or create a fle Namefleets TypeResource DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions. -Idaws.gamelift.fleets +Id ## Fields - - + +
NameDatatypeDescription
fleet_idstringUnique fleet ID
regionstringAWS region.
stringUnique fleet ID
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleets in a region or create a fle Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md index 3db1aa80b8..5d892b980e 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual game_server_group resource, use game_server_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual game_server_group resource, use < Namegame_server_group TypeResource DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup. -Idaws.gamelift.game_server_group +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_arnstringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
auto_scaling_policyobjectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
balancing_strategystringThe fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
delete_optionstringThe type of delete to perform.
game_server_group_arnstringA generated unique ID for the game server group.
game_server_group_namestringAn identifier for the new game server group.
game_server_protection_policystringA flag that indicates whether instances in the game server group are protected from early termination.
instance_definitionsarrayA set of EC2 instance types to use when creating instances in the group.
launch_templateobjectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
max_sizenumberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
min_sizenumberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
role_arnstringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tagsarrayA list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.
vpc_subnetsarrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
regionstringAWS region.
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.
@@ -54,19 +57,19 @@ Gets or operates on an individual game_server_group resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md index 3767a6d326..e201e5a723 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of game_server_groups in a region or create a game_server_groups resource, use game_server_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of game_server_groups in a region or create Namegame_server_groups TypeResource DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup. -Idaws.gamelift.game_server_groups +Id ## Fields - - + +
NameDatatypeDescription
game_server_group_arnundefinedA generated unique ID for the game server group.
regionstringAWS region.
undefinedA generated unique ID for the game server group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of game_server_groups in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md index e402b11af8..62ff71a924 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual game_session_queue resource, use game_session_queues to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual game_session_queue resource, use Namegame_session_queue TypeResource DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue. -Idaws.gamelift.game_session_queue +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
namestringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
timeout_in_secondsintegerThe maximum time, in seconds, that a new game session placement request remains in the queue.
destinationsarrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
player_latency_policiesarrayA set of policies that act as a sliding cap on player latency.
custom_event_datastringInformation that is added to all events that are related to this game session queue.
notification_targetstringAn SNS topic ARN that is set up to receive game session placement notifications.
filter_configurationobjectA list of locations where a queue is allowed to place new game sessions.
priority_configurationobjectCustom settings to use when prioritizing destinations and locations for game session placements.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual game_session_queue resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md index 25d3af64c0..27988daa11 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of game_session_queues in a region or create a game_session_queues resource, use game_session_queue to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of game_session_queues in a region or creat Namegame_session_queues TypeResource DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue. -Idaws.gamelift.game_session_queues +Id ## Fields - - + +
NameDatatypeDescription
namestringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
regionstringAWS region.
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of game_session_queues in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/location/index.md b/docs/aws-docs/providers/aws/gamelift/location/index.md index aabdf8c95c..c8b6bb15bd 100644 --- a/docs/aws-docs/providers/aws/gamelift/location/index.md +++ b/docs/aws-docs/providers/aws/gamelift/location/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual location resource, use locations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual location resource, use loca Namelocation TypeResource DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location. -Idaws.gamelift.location +Id ## Fields - - - - + + + +
NameDatatypeDescription
location_namestring
location_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual location resource, use loca Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/locations/index.md b/docs/aws-docs/providers/aws/gamelift/locations/index.md index 8925b8b0a1..43d6aa6660 100644 --- a/docs/aws-docs/providers/aws/gamelift/locations/index.md +++ b/docs/aws-docs/providers/aws/gamelift/locations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of locations in a region or create a locations resource, use location to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of locations in a region or create a Namelocations TypeResource DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location. -Idaws.gamelift.locations +Id ## Fields - - + +
NameDatatypeDescription
location_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of locations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md index b9140cd5b2..394e218405 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual matchmaking_configuration resource, use matchmaking_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual matchmaking_configuration resourc Namematchmaking_configuration TypeResource DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration. -Idaws.gamelift.matchmaking_configuration +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
acceptance_requiredbooleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
acceptance_timeout_secondsintegerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additional_player_countintegerThe number of player slots in a match to keep open for future players.
backfill_modestringThe method used to backfill game sessions created with this matchmaking configuration.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
creation_timestringA time stamp indicating when this data object was created.
custom_event_datastringInformation to attach to all events related to the matchmaking configuration.
descriptionstringA descriptive label that is associated with matchmaking configuration.
flex_match_modestringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
game_propertiesarrayA set of custom properties for a game session, formatted as key:value pairs.
game_session_datastringA set of custom game session properties, formatted as a single string value.
game_session_queue_arnsarrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
namestringA unique identifier for the matchmaking configuration.
notification_targetstringAn SNS topic ARN that is set up to receive matchmaking notifications.
request_timeout_secondsintegerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
rule_set_arnstringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
rule_set_namestringA unique identifier for the matchmaking rule set to use with this configuration.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -58,19 +61,19 @@ Gets or operates on an individual matchmaking_configuration resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md index 90729ed517..246e25ae8d 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of matchmaking_configurations in a region or create a matchmaking_configurations resource, use matchmaking_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of matchmaking_configurations in a region o Namematchmaking_configurations TypeResource DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration. -Idaws.gamelift.matchmaking_configurations +Id ## Fields - - + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking configuration.
regionstringAWS region.
stringA unique identifier for the matchmaking configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of matchmaking_configurations in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md index db4d55967f..e36222966b 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual matchmaking_rule_set resource, use matchmaking_rule_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual matchmaking_rule_set resource, us Namematchmaking_rule_set TypeResource DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set. -Idaws.gamelift.matchmaking_rule_set +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking rule set.
rule_set_bodystringA collection of matchmaking rules, formatted as a JSON string.
creation_timestringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual matchmaking_rule_set resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md index b4d81c14b5..d39f19a363 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of matchmaking_rule_sets in a region or create a matchmaking_rule_sets resource, use matchmaking_rule_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of matchmaking_rule_sets in a region or cre Namematchmaking_rule_sets TypeResource DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set. -Idaws.gamelift.matchmaking_rule_sets +Id ## Fields - - + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking rule set.
regionstringAWS region.
stringA unique identifier for the matchmaking rule set.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of matchmaking_rule_sets in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/gamelift/script/index.md b/docs/aws-docs/providers/aws/gamelift/script/index.md index 16d72a1f67..c1d54f808e 100644 --- a/docs/aws-docs/providers/aws/gamelift/script/index.md +++ b/docs/aws-docs/providers/aws/gamelift/script/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual script resource, use scripts to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual script resource, use script Namescript TypeResource DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. -Idaws.gamelift.script +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringA descriptive label that is associated with a script. Script names do not need to be unique.
storage_locationobjectThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
versionstringThe version that is associated with a script. Version strings do not need to be unique.
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
idstringA unique identifier for the Realtime script
size_on_diskintegerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual script resource, use script Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/gamelift/scripts/index.md b/docs/aws-docs/providers/aws/gamelift/scripts/index.md index 13040f4187..eac60c1dc8 100644 --- a/docs/aws-docs/providers/aws/gamelift/scripts/index.md +++ b/docs/aws-docs/providers/aws/gamelift/scripts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scripts in a region or create a scripts resource, use script to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scripts in a region or create a sc Namescripts TypeResource DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. -Idaws.gamelift.scripts +Id ## Fields - - + +
NameDatatypeDescription
idstringA unique identifier for the Realtime script
regionstringAWS region.
stringA unique identifier for the Realtime script
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scripts in a region or create a sc Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md index 46088e1713..c520be1a32 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual accelerator resource, use accelerators to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual accelerator resource, use a Nameaccelerator TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator -Idaws.globalaccelerator.accelerator +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
namestringName of accelerator.
ip_address_typestringIP Address type.
ip_addressesarrayThe IP addresses from BYOIP Prefix pool.
enabledbooleanIndicates whether an accelerator is enabled. The value is true or false.
dns_namestringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
ipv4_addressesarrayThe IPv4 addresses assigned to the accelerator.
ipv6_addressesarrayThe IPv6 addresses assigned if the accelerator is dualstack
dual_stack_dns_namestringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
tagsarray
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual accelerator resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md index 41792cc8eb..609158d728 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of accelerators in a region or create a accelerators resource, use accelerator to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of accelerators in a region or create a Nameaccelerators TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator -Idaws.globalaccelerator.accelerators +Id ## Fields - - + +
NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the accelerator.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of accelerators in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md index 6d0d041860..c42c8a990a 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cross_account_attachment resource, use cross_account_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual cross_account_attachment resource Namecross_account_attachment TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment -Idaws.globalaccelerator.cross_account_attachment +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringThe Friendly identifier of the attachment.
attachment_arnstringThe Amazon Resource Name (ARN) of the attachment.
principalsarrayPrincipals to share the resources with.
resourcesarrayResources shared using the attachment.
tagsarray
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual cross_account_attachment resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md index 2e10828895..b427d27d32 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cross_account_attachments in a region or create a cross_account_attachments resource, use cross_account_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cross_account_attachments in a region or Namecross_account_attachments TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment -Idaws.globalaccelerator.cross_account_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_arnstringThe Amazon Resource Name (ARN) of the attachment.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cross_account_attachments in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md index 9d04a5e703..bd01a74d47 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual endpoint_group resource, use endpoint_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual endpoint_group resource, use Nameendpoint_group TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup -Idaws.globalaccelerator.endpoint_group +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener
endpoint_group_regionstringThe name of the AWS Region where the endpoint group is located
endpoint_configurationsarrayThe list of endpoint objects.
traffic_dial_percentagenumberThe percentage of traffic to sent to an AWS Region
health_check_portintegerThe port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_protocolstringThe protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_pathstring
health_check_interval_secondsintegerThe time in seconds between each health check for an endpoint. Must be a value of 10 or 30
threshold_countintegerThe number of consecutive health checks required to set the state of the endpoint to unhealthy.
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group
port_overridesarray
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual endpoint_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md index 2643a55ae8..3b4a22c773 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of endpoint_groups in a region or create a endpoint_groups resource, use endpoint_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of endpoint_groups in a region or create a Nameendpoint_groups TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup -Idaws.globalaccelerator.endpoint_groups +Id ## Fields - - + +
NameDatatypeDescription
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the endpoint group
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of endpoint_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md index 7edf5064f9..04a7749369 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual listener resource, use listeners to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual listener resource, use list Namelistener TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::Listener -Idaws.globalaccelerator.listener +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
port_rangesarray
protocolstringThe protocol for the listener.
client_affinitystringClient affinity lets you direct all requests from a user to the same endpoint.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual listener resource, use list Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md index d6b8ff5555..1356ac0e2f 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of listeners in a region or create a listeners resource, use listener to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of listeners in a region or create a Namelisteners TypeResource DescriptionResource Type definition for AWS::GlobalAccelerator::Listener -Idaws.globalaccelerator.listeners +Id ## Fields - - + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the listener.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of listeners in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/glue/schema_version/index.md b/docs/aws-docs/providers/aws/glue/schema_version/index.md index 03160b2cfd..45fc874047 100644 --- a/docs/aws-docs/providers/aws/glue/schema_version/index.md +++ b/docs/aws-docs/providers/aws/glue/schema_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schema_version resource, use schema_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual schema_version resource, use Nameschema_version TypeResource DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry. -Idaws.glue.schema_version +Id ## Fields - - - - + + + +
NameDatatypeDescription
schemaobject
schema_definitionstringComplete definition of the schema in plain-text.
version_idstringRepresents the version ID associated with the schema version.
regionstringAWS region.
object
stringComplete definition of the schema in plain-text.
stringRepresents the version ID associated with the schema version.
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual schema_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md index 97070f5775..4e0810e4e8 100644 --- a/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md +++ b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schema_version_metadata resource, use schema_version_metadata to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual schema_version_metadata resource, Nameschema_version_metadata TypeResource DescriptionThis resource adds Key-Value metadata to a Schema version of Glue Schema Registry. -Idaws.glue.schema_version_metadata +Id ## Fields - - - - + + + +
NameDatatypeDescription
schema_version_idstringRepresents the version ID associated with the schema version.
keystringMetadata key
valuestringMetadata value
regionstringAWS region.
stringRepresents the version ID associated with the schema version.
stringMetadata key
stringMetadata value
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual schema_version_metadata resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/glue/schema_versions/index.md b/docs/aws-docs/providers/aws/glue/schema_versions/index.md index daf39f21ff..6b4c9f49ec 100644 --- a/docs/aws-docs/providers/aws/glue/schema_versions/index.md +++ b/docs/aws-docs/providers/aws/glue/schema_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schema_versions in a region or create a schema_versions resource, use schema_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schema_versions in a region or create a Nameschema_versions TypeResource DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry. -Idaws.glue.schema_versions +Id ## Fields - - + +
NameDatatypeDescription
version_idstringRepresents the version ID associated with the schema version.
regionstringAWS region.
stringRepresents the version ID associated with the schema version.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schema_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/grafana/workspace/index.md b/docs/aws-docs/providers/aws/grafana/workspace/index.md index a4e997c2fb..614da92197 100644 --- a/docs/aws-docs/providers/aws/grafana/workspace/index.md +++ b/docs/aws-docs/providers/aws/grafana/workspace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workspace resource, use workspaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,37 +24,37 @@ Gets or operates on an individual workspace resource, use wor Nameworkspace TypeResource DescriptionDefinition of AWS::Grafana::Workspace Resource Type -Idaws.grafana.workspace +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
authentication_providersarrayList of authentication providers to enable.
sso_client_idstringThe client ID of the AWS SSO Managed Application.
saml_configurationobject
network_access_controlobject
vpc_configurationobject
saml_configuration_statusstring
client_tokenstringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
statusstring
creation_timestampstringTimestamp when the workspace was created.
modification_timestampstringTimestamp when the workspace was last modified
grafana_versionstringThe version of Grafana to support in your workspace.
endpointstringEndpoint for the Grafana workspace.
account_access_typestring
organization_role_namestringThe name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
permission_typestring
stack_set_namestringThe name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
data_sourcesarrayList of data sources on the service managed IAM role.
descriptionstringDescription of a workspace.
idstringThe id that uniquely identifies a Grafana workspace.
namestringThe user friendly name of a workspace.
notification_destinationsarrayList of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizational_unitsarrayList of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
role_arnstringIAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
plugin_admin_enabledbooleanAllow workspace admins to install plugins
regionstringAWS region.
arrayList of authentication providers to enable.
stringThe client ID of the AWS SSO Managed Application.
object
object
object
string
stringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
string
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.
string
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.
string
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.
@@ -64,19 +67,19 @@ Gets or operates on an individual workspace resource, use wor Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/grafana/workspaces/index.md b/docs/aws-docs/providers/aws/grafana/workspaces/index.md index a373a566a5..c3a28ab46d 100644 --- a/docs/aws-docs/providers/aws/grafana/workspaces/index.md +++ b/docs/aws-docs/providers/aws/grafana/workspaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workspaces in a region or create a workspaces resource, use workspace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workspaces in a region or create a Nameworkspaces TypeResource DescriptionDefinition of AWS::Grafana::Workspace Resource Type -Idaws.grafana.workspaces +Id ## Fields - - + +
NameDatatypeDescription
idstringThe id that uniquely identifies a Grafana workspace.
regionstringAWS region.
stringThe id that uniquely identifies a Grafana workspace.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workspaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md index bdfa91fc1b..d95dd30026 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual component_version resource, use component_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual component_version resource, use < Namecomponent_version TypeResource DescriptionResource for Greengrass component version. -Idaws.greengrassv2.component_version +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
component_namestring
component_versionstring
inline_recipestring
lambda_functionobject
tagsobject
regionstringAWS region.
string
string
string
string
object
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual component_version resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md index e9b766c39f..2719fcbb68 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of component_versions in a region or create a component_versions resource, use component_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of component_versions in a region or create Namecomponent_versions TypeResource DescriptionResource for Greengrass component version. -Idaws.greengrassv2.component_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of component_versions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md index 20abaaac64..67e5bc68f6 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual deployment resource, use deployments to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual deployment resource, use de Namedeployment TypeResource DescriptionResource for Greengrass V2 deployment. -Idaws.greengrassv2.deployment +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
target_arnstring
parent_target_arnstring
deployment_idstring
deployment_namestring
componentsobject
iot_job_configurationobject
deployment_policiesobject
tagsobject
regionstringAWS region.
string
string
string
string
object
object
object
object
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual deployment resource, use de Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md index f7aca96391..9dcd8689d3 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of deployments in a region or create a deployments resource, use deployment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of deployments in a region or create a Namedeployments TypeResource DescriptionResource for Greengrass V2 deployment. -Idaws.greengrassv2.deployments +Id ## Fields - - + +
NameDatatypeDescription
deployment_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of deployments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/groundstation/config/index.md b/docs/aws-docs/providers/aws/groundstation/config/index.md index 6017171301..5afc42106c 100644 --- a/docs/aws-docs/providers/aws/groundstation/config/index.md +++ b/docs/aws-docs/providers/aws/groundstation/config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual config resource, use configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual config resource, use config Nameconfig TypeResource DescriptionAWS Ground Station config resource type for CloudFormation. -Idaws.groundstation.config +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestring
tagsarray
typestring
config_dataobject
arnstring
idstring
regionstringAWS region.
string
array
string
object
string
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual config resource, use config Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/groundstation/configs/index.md b/docs/aws-docs/providers/aws/groundstation/configs/index.md index b1d986aa8d..7b1ebc59f2 100644 --- a/docs/aws-docs/providers/aws/groundstation/configs/index.md +++ b/docs/aws-docs/providers/aws/groundstation/configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configs in a region or create a configs resource, use config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configs in a region or create a co Nameconfigs TypeResource DescriptionAWS Ground Station config resource type for CloudFormation. -Idaws.groundstation.configs +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configs in a region or create a co Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md index 0d3af66dd9..25cb634531 100644 --- a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataflow_endpoint_group resource, use dataflow_endpoint_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual dataflow_endpoint_group resource, Namedataflow_endpoint_group TypeResource DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation -Idaws.groundstation.dataflow_endpoint_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
arnstring
endpoint_detailsarray
contact_pre_pass_duration_secondsintegerAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
contact_post_pass_duration_secondsintegerAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
tagsarray
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual dataflow_endpoint_group resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md index d5cdf356c7..860a15fa50 100644 --- a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dataflow_endpoint_groups in a region or create a dataflow_endpoint_groups resource, use dataflow_endpoint_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dataflow_endpoint_groups in a region or Namedataflow_endpoint_groups TypeResource DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation -Idaws.groundstation.dataflow_endpoint_groups +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dataflow_endpoint_groups in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md index 9d04124a8e..0eca33c37a 100644 --- a/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md +++ b/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual mission_profile resource, use mission_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual mission_profile resource, use Namemission_profile TypeResource DescriptionAWS Ground Station Mission Profile resource type for CloudFormation. -Idaws.groundstation.mission_profile +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
namestringA name used to identify a mission profile.
contact_pre_pass_duration_secondsintegerPre-pass time needed before the contact.
contact_post_pass_duration_secondsintegerPost-pass time needed after the contact.
minimum_viable_contact_duration_secondsintegerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
streams_kms_keyobjectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
streams_kms_rolestringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
dataflow_edgesarray
tracking_config_arnstring
tagsarray
idstring
arnstring
regionstring
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual mission_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md index 382ccd1b3f..bd6551a439 100644 --- a/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md +++ b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of mission_profiles in a region or create a mission_profiles resource, use mission_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of mission_profiles in a region or create a Namemission_profiles TypeResource DescriptionAWS Ground Station Mission Profile resource type for CloudFormation. -Idaws.groundstation.mission_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of mission_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/detector/index.md b/docs/aws-docs/providers/aws/guardduty/detector/index.md index 82162acad8..4cfaacad12 100644 --- a/docs/aws-docs/providers/aws/guardduty/detector/index.md +++ b/docs/aws-docs/providers/aws/guardduty/detector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual detector resource, use detectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual detector resource, use dete Namedetector TypeResource DescriptionResource Type definition for AWS::GuardDuty::Detector -Idaws.guardduty.detector +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
finding_publishing_frequencystring
enableboolean
data_sourcesobject
featuresarray
idstring
tagsarray
regionstringAWS region.
string
boolean
object
array
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual detector resource, use dete Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/detectors/index.md b/docs/aws-docs/providers/aws/guardduty/detectors/index.md index dc9df277ac..ed71193fb3 100644 --- a/docs/aws-docs/providers/aws/guardduty/detectors/index.md +++ b/docs/aws-docs/providers/aws/guardduty/detectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of detectors in a region or create a detectors resource, use detector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of detectors in a region or create a Namedetectors TypeResource DescriptionResource Type definition for AWS::GuardDuty::Detector -Idaws.guardduty.detectors +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of detectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/filter/index.md b/docs/aws-docs/providers/aws/guardduty/filter/index.md index 8386fa788f..890de28699 100644 --- a/docs/aws-docs/providers/aws/guardduty/filter/index.md +++ b/docs/aws-docs/providers/aws/guardduty/filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual filter resource, use filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual filter resource, use filter Namefilter TypeResource DescriptionResource Type definition for AWS::GuardDuty::Filter -Idaws.guardduty.filter +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
actionstring
descriptionstring
detector_idstring
finding_criteriaobject
rankinteger
namestring
tagsarray
regionstringAWS region.
string
string
string
object
integer
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual filter resource, use filter Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/filters/index.md b/docs/aws-docs/providers/aws/guardduty/filters/index.md index 2c1a06b350..8a1543bbda 100644 --- a/docs/aws-docs/providers/aws/guardduty/filters/index.md +++ b/docs/aws-docs/providers/aws/guardduty/filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of filters in a region or create a filters resource, use filter to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of filters in a region or create a fi Namefilters TypeResource DescriptionResource Type definition for AWS::GuardDuty::Filter -Idaws.guardduty.filters +Id ## Fields - - - + + +
NameDatatypeDescription
detector_idstring
namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of filters in a region or create a fi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/ip_set/index.md b/docs/aws-docs/providers/aws/guardduty/ip_set/index.md index 162c42a082..09e82f7f2d 100644 --- a/docs/aws-docs/providers/aws/guardduty/ip_set/index.md +++ b/docs/aws-docs/providers/aws/guardduty/ip_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ip_set resource, use ip_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual ip_set resource, use ip_set Nameip_set TypeResource DescriptionResource Type definition for AWS::GuardDuty::IPSet -Idaws.guardduty.ip_set +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
string
string
boolean
string
string
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual ip_set resource, use ip_set Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md index cf0c8a943c..eac6dc2f18 100644 --- a/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md +++ b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ip_sets in a region or create a ip_sets resource, use ip_set to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of ip_sets in a region or create a ip Nameip_sets TypeResource DescriptionResource Type definition for AWS::GuardDuty::IPSet -Idaws.guardduty.ip_sets +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of ip_sets in a region or create a ip Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/master/index.md b/docs/aws-docs/providers/aws/guardduty/master/index.md index 6810f38dd0..20c1954171 100644 --- a/docs/aws-docs/providers/aws/guardduty/master/index.md +++ b/docs/aws-docs/providers/aws/guardduty/master/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual master resource, use masters to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual master resource, use master Namemaster TypeResource DescriptionGuardDuty Master resource schema -Idaws.guardduty.master +Id ## Fields - - - - + + + +
NameDatatypeDescription
master_idstringID of the account used as the master account.
invitation_idstringValue used to validate the master account to the member account.
detector_idstringUnique ID of the detector of the GuardDuty member account.
regionstringAWS region.
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.
@@ -43,14 +46,14 @@ Gets or operates on an individual master resource, use master Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/masters/index.md b/docs/aws-docs/providers/aws/guardduty/masters/index.md index bac23db1ee..15a9e56e5e 100644 --- a/docs/aws-docs/providers/aws/guardduty/masters/index.md +++ b/docs/aws-docs/providers/aws/guardduty/masters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of masters in a region or create a masters resource, use master to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of masters in a region or create a ma Namemasters TypeResource DescriptionGuardDuty Master resource schema -Idaws.guardduty.masters +Id ## Fields - - - + + +
NameDatatypeDescription
detector_idstringUnique ID of the detector of the GuardDuty member account.
master_idstringID of the account used as the master account.
regionstringAWS region.
stringUnique ID of the detector of the GuardDuty member account.
stringID of the account used as the master account.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of masters in a region or create a ma Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/member/index.md b/docs/aws-docs/providers/aws/guardduty/member/index.md index d350eb65d3..3734dba37b 100644 --- a/docs/aws-docs/providers/aws/guardduty/member/index.md +++ b/docs/aws-docs/providers/aws/guardduty/member/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual member resource, use members to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual member resource, use member Namemember TypeResource DescriptionResource Type definition for AWS::GuardDuty::Member -Idaws.guardduty.member +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
statusstring
member_idstring
emailstring
messagestring
disable_email_notificationboolean
detector_idstring
regionstringAWS region.
string
string
string
string
boolean
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual member resource, use member Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/members/index.md b/docs/aws-docs/providers/aws/guardduty/members/index.md index 05a9280700..df1d97c17d 100644 --- a/docs/aws-docs/providers/aws/guardduty/members/index.md +++ b/docs/aws-docs/providers/aws/guardduty/members/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of members in a region or create a members resource, use member to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of members in a region or create a me Namemembers TypeResource DescriptionResource Type definition for AWS::GuardDuty::Member -Idaws.guardduty.members +Id ## Fields - - - + + +
NameDatatypeDescription
detector_idstring
member_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of members in a region or create a me Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md index 6033d84be5..9a50675989 100644 --- a/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual threat_intel_set resource, use threat_intel_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual threat_intel_set resource, use Namethreat_intel_set TypeResource DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet -Idaws.guardduty.threat_intel_set +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
string
string
boolean
string
string
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual threat_intel_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md index 71d10ceb32..3b3160dd04 100644 --- a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of threat_intel_sets in a region or create a threat_intel_sets resource, use threat_intel_set to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of threat_intel_sets in a region or create Namethreat_intel_sets TypeResource DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet -Idaws.guardduty.threat_intel_sets +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of threat_intel_sets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastore/index.md b/docs/aws-docs/providers/aws/healthimaging/datastore/index.md index 62b7c463f2..7d8a928041 100644 --- a/docs/aws-docs/providers/aws/healthimaging/datastore/index.md +++ b/docs/aws-docs/providers/aws/healthimaging/datastore/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual datastore resource, use datastores to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual datastore resource, use dat Namedatastore TypeResource DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type -Idaws.healthimaging.datastore +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
datastore_arnstring
datastore_namestring
datastore_idstring
datastore_statusstring
kms_key_arnstring
created_atstring
updated_atstring
tagsobject
regionstringAWS region.
string
string
string
string
string
string
string
object
stringAWS region.
@@ -48,14 +51,14 @@ Gets or operates on an individual datastore resource, use dat Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastores/index.md b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md index 8b7964819b..a5e564da30 100644 --- a/docs/aws-docs/providers/aws/healthimaging/datastores/index.md +++ b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of datastores in a region or create a datastores resource, use datastore to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of datastores in a region or create a Namedatastores TypeResource DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type -Idaws.healthimaging.datastores +Id ## Fields - - + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of datastores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md index 7ed8b778cc..32dd75ae69 100644 --- a/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fhir_datastore resource, use fhir_datastores to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual fhir_datastore resource, use Namefhir_datastore TypeResource DescriptionHealthLake FHIR Datastore -Idaws.healthlake.fhir_datastore +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
created_atobject
datastore_arnstring
datastore_endpointstring
datastore_idstring
datastore_namestring
datastore_statusstring
datastore_type_versionstring
preload_data_configobject
sse_configurationobject
identity_provider_configurationobject
tagsarray
regionstringAWS region.
object
string
string
string
string
string
string
object
object
object
array
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual fhir_datastore resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md index 87902c1396..96091c2ec8 100644 --- a/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fhir_datastores in a region or create a fhir_datastores resource, use fhir_datastore to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fhir_datastores in a region or create a Namefhir_datastores TypeResource DescriptionHealthLake FHIR Datastore -Idaws.healthlake.fhir_datastores +Id ## Fields - - + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fhir_datastores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/group/index.md b/docs/aws-docs/providers/aws/iam/group/index.md index 063b46dc27..97319ff474 100644 --- a/docs/aws-docs/providers/aws/iam/group/index.md +++ b/docs/aws-docs/providers/aws/iam/group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group resource, use groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual group resource, use groups< Namegroup TypeResource DescriptionCreates a new group.<br/> For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. -Idaws.iam.group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
group_namestringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
managed_policy_arnsarrayThe Amazon Resource Name (ARN) of the IAM policy you want to attach.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
pathstringThe path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).<br/> The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. <br/> For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
regionstringAWS region.
string
stringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
arrayThe Amazon Resource Name (ARN) of the IAM policy you want to attach.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
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).<br/> The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. <br/> For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual group resource, use groups< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/group_policies/index.md b/docs/aws-docs/providers/aws/iam/group_policies/index.md index ea82b15d32..2343728b8e 100644 --- a/docs/aws-docs/providers/aws/iam/group_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/group_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + List of group policies by GroupName (requires `aws` provider to be installed) ## Overview @@ -21,17 +24,17 @@ List of group policies by GroupName (requires `aws` provider to be installed) Namegroup_policies TypeResource DescriptionList of group policies by GroupName (requires `aws` provider to be installed) -Idaws.iam.group_policies +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
group_namestringThe IAM group name
policy_namestringThe group policy name
policy_documentstringThe group policy document
regionstring
regionstringAWS region.
stringThe IAM group name
stringThe group policy name
stringThe group policy document
string
stringAWS region.
@@ -44,9 +47,9 @@ List of group policies by GroupName (requires `aws` provider to be installed) Required Params - view + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/group_policy/index.md b/docs/aws-docs/providers/aws/iam/group_policy/index.md index b84e151d4a..e8a04d84b6 100644 --- a/docs/aws-docs/providers/aws/iam/group_policy/index.md +++ b/docs/aws-docs/providers/aws/iam/group_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group_policy resource, use group_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual group_policy resource, use Namegroup_policy TypeResource DescriptionAdds or updates an inline policy document that is embedded in the specified IAM group.<br/> A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.group_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
policy_namestringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
group_namestringThe name of the group to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
regionstringAWS region.
objectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
stringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the group to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual group_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/groups/index.md b/docs/aws-docs/providers/aws/iam/groups/index.md index 08da86bad0..86e9e7392c 100644 --- a/docs/aws-docs/providers/aws/iam/groups/index.md +++ b/docs/aws-docs/providers/aws/iam/groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of groups in a region or create a gro Namegroups TypeResource DescriptionCreates a new group.<br/> For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. -Idaws.iam.groups +Id ## Fields - - + +
NameDatatypeDescription
group_namestringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
regionstringAWS region.
stringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of groups in a region or create a gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/instance_profile/index.md b/docs/aws-docs/providers/aws/iam/instance_profile/index.md index 46bf7b1f43..0c6f47e97b 100644 --- a/docs/aws-docs/providers/aws/iam/instance_profile/index.md +++ b/docs/aws-docs/providers/aws/iam/instance_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance_profile resource, use instance_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual instance_profile resource, use Nameinstance_profile TypeResource DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).<br/> For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. -Idaws.iam.instance_profile +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
pathstringThe path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
rolesarrayThe name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.
instance_profile_namestringThe name of the instance profile to create.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
arnstring
regionstringAWS region.
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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
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.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual instance_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md index 948bc025a9..01373eeeb0 100644 --- a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md +++ b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instance_profiles in a region or create a instance_profiles resource, use instance_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instance_profiles in a region or create Nameinstance_profiles TypeResource DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).<br/> For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. -Idaws.iam.instance_profiles +Id ## Fields - - + +
NameDatatypeDescription
instance_profile_namestringThe name of the instance profile to create.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
regionstringAWS region.
stringThe name of the instance profile to create.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instance_profiles in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/managed_policies/index.md b/docs/aws-docs/providers/aws/iam/managed_policies/index.md index c1b1b0b428..f24866ef9d 100644 --- a/docs/aws-docs/providers/aws/iam/managed_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/managed_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of managed_policies in a region or create a managed_policies resource, use managed_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of managed_policies in a region or create a Namemanaged_policies TypeResource DescriptionCreates a new managed policy for your AWS-account.<br/> This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.<br/> As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.<br/> For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. -Idaws.iam.managed_policies +Id ## Fields - - + +
NameDatatypeDescription
policy_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of managed_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/managed_policy/index.md b/docs/aws-docs/providers/aws/iam/managed_policy/index.md index c4bab4ed0f..1a1b3b5662 100644 --- a/docs/aws-docs/providers/aws/iam/managed_policy/index.md +++ b/docs/aws-docs/providers/aws/iam/managed_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual managed_policy resource, use managed_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual managed_policy resource, use Namemanaged_policy TypeResource DescriptionCreates a new managed policy for your AWS-account.<br/> This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.<br/> As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.<br/> For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. -Idaws.iam.managed_policy +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA friendly description of the policy.<br/> Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."<br/> The policy description is immutable. After a value is assigned, it cannot be changed.
groupsarrayThe name (friendly name, not ARN) of the group to attach the policy to.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
managed_policy_namestringThe friendly name of the policy.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
pathstringThe path for the policy.<br/> For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use an asterisk (*) in the path name.
policy_documentobjectThe JSON policy document that you want to use as the content for the new policy.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).<br/> To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. <br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
rolesarrayThe name (friendly name, not ARN) of the role to attach the policy to.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-<br/> If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
usersarrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
policy_arnstring
attachment_countinteger
create_datestring
update_datestring
default_version_idstring
is_attachableboolean
permissions_boundary_usage_countinteger
policy_idstring
regionstringAWS region.
stringA friendly description of the policy.<br/> Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."<br/> The policy description is immutable. After a value is assigned, it cannot be changed.
arrayThe name (friendly name, not ARN) of the group to attach the policy to.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe friendly name of the policy.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
stringThe path for the policy.<br/> For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use an asterisk (*) in the path name.
objectThe JSON policy document that you want to use as the content for the new policy.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).<br/> To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. <br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
arrayThe name (friendly name, not ARN) of the role to attach the policy to.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-<br/> If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
arrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
integer
string
string
string
boolean
integer
string
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual managed_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/oidc_provider/index.md b/docs/aws-docs/providers/aws/iam/oidc_provider/index.md index e437ff9a39..61a097ed0f 100644 --- a/docs/aws-docs/providers/aws/iam/oidc_provider/index.md +++ b/docs/aws-docs/providers/aws/iam/oidc_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual oidc_provider resource, use oidc_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual oidc_provider resource, use Nameoidc_provider TypeResource DescriptionResource Type definition for AWS::IAM::OIDCProvider -Idaws.iam.oidc_provider +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
client_id_listarray
urlstring
thumbprint_listarray
arnstringAmazon Resource Name (ARN) of the OIDC provider
tagsarray
regionstringAWS region.
array
string
array
stringAmazon Resource Name (ARN) of the OIDC provider
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual oidc_provider resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/oidc_providers/index.md b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md index 8ce25ccd16..a2374ef1d4 100644 --- a/docs/aws-docs/providers/aws/iam/oidc_providers/index.md +++ b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of oidc_providers in a region or create a oidc_providers resource, use oidc_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of oidc_providers in a region or create a < Nameoidc_providers TypeResource DescriptionResource Type definition for AWS::IAM::OIDCProvider -Idaws.iam.oidc_providers +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the OIDC provider
regionstringAWS region.
stringAmazon Resource Name (ARN) of the OIDC provider
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of oidc_providers in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/policies/index.md b/docs/aws-docs/providers/aws/iam/policies/index.md index 5e23fc3956..ab9d6f8aff 100644 --- a/docs/aws-docs/providers/aws/iam/policies/index.md +++ b/docs/aws-docs/providers/aws/iam/policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + List of policies (requires `aws` provider to be installed) ## Overview @@ -21,26 +24,26 @@ List of policies (requires `aws` provider to be installed) Namepolicies TypeResource DescriptionList of policies (requires `aws` provider to be installed) -Idaws.iam.policies +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
policy_namestringThe name for the policy
arnstringThe ARN
attachment_countnumberThe attachment count for the policy
create_datestringThe creation date for the policy
default_version_idstringThe default version id for the policy
descriptionstringThe description for the policy
is_attachablebooleanIs the policy attachable?
pathstringThe path for the policy
permissions_boundary_usage_countnumberThe permissions boundary usage count for the policy
policy_idstringThe id for the policy
tagsarrayTags for the policy
update_datestringThe update date for the policy
regionstring
regionstringAWS region.
stringThe name for the policy
stringThe ARN
numberThe attachment count for the policy
stringThe creation date for the policy
stringThe default version id for the policy
stringThe description for the policy
booleanIs the policy attachable?
stringThe path for the policy
numberThe permissions boundary usage count for the policy
stringThe id for the policy
arrayTags for the policy
stringThe update date for the policy
string
stringAWS region.
@@ -53,9 +56,9 @@ List of policies (requires `aws` provider to be installed) Required Params - view + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/role/index.md b/docs/aws-docs/providers/aws/iam/role/index.md index 9cac206ef4..53e5744610 100644 --- a/docs/aws-docs/providers/aws/iam/role/index.md +++ b/docs/aws-docs/providers/aws/iam/role/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual role resource, use roles to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual role resource, use rolesNamerole TypeResource DescriptionCreates a new role for your AWS-account.<br/> For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.role +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstring
assume_role_policy_documentobjectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
descriptionstringA description of the role that you provide.
managed_policy_arnsarrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
max_session_durationintegerThe maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.<br/> Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
pathstringThe path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
permissions_boundarystringThe ARN of the policy used to set the permissions boundary for the role.<br/> For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM role.<br/> When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).<br/> A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.<br/> For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.<br/> If an external policy (such as ``AWS::IAM::Policy`` or
role_idstring
role_namestringA name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
tagsarrayA list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
regionstringAWS region.
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.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
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.<br/> Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
stringThe ARN of the policy used to set the permissions boundary for the role.<br/> For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM role.<br/> When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).<br/> A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.<br/> For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.<br/> If an external policy (such as ``AWS::IAM::Policy`` or
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*.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual role resource, use rolesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/role_policies/index.md b/docs/aws-docs/providers/aws/iam/role_policies/index.md index 8948802938..35637dae96 100644 --- a/docs/aws-docs/providers/aws/iam/role_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/role_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + List of policies by RoleName (requires `aws` provider to be installed) ## Overview @@ -21,17 +24,17 @@ List of policies by RoleName (requires `aws` provider to be installed) Namerole_policies TypeResource DescriptionList of policies by RoleName (requires `aws` provider to be installed) -Idaws.iam.role_policies +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
role_namestringThe IAM role name
policy_namestringThe role policy name
policy_documentstringThe role policy document
regionstring
regionstringAWS region.
stringThe IAM role name
stringThe role policy name
stringThe role policy document
string
stringAWS region.
@@ -44,9 +47,9 @@ List of policies by RoleName (requires `aws` provider to be installed) Required Params - view + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/role_policy/index.md b/docs/aws-docs/providers/aws/iam/role_policy/index.md index e8c0ed6fd8..331631daa6 100644 --- a/docs/aws-docs/providers/aws/iam/role_policy/index.md +++ b/docs/aws-docs/providers/aws/iam/role_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual role_policy resource, use role_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual role_policy resource, use r Namerole_policy TypeResource DescriptionAdds or updates an inline policy document that is embedded in the specified IAM role.<br/> When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.<br/> A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.role_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
policy_namestringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
role_namestringThe name of the role to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
regionstringAWS region.
objectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
stringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the role to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual role_policy resource, use r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/roles/index.md b/docs/aws-docs/providers/aws/iam/roles/index.md index 1fb8bc7b42..bf7682d957 100644 --- a/docs/aws-docs/providers/aws/iam/roles/index.md +++ b/docs/aws-docs/providers/aws/iam/roles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of roles in a region or create a roles resource, use role to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of roles in a region or create a role Nameroles TypeResource DescriptionCreates a new role for your AWS-account.<br/> For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.roles +Id ## Fields - - + +
NameDatatypeDescription
role_namestringA name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
regionstringAWS region.
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*.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of roles in a region or create a role Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/saml_provider/index.md b/docs/aws-docs/providers/aws/iam/saml_provider/index.md index e5fdd93aa3..d9d970e9a1 100644 --- a/docs/aws-docs/providers/aws/iam/saml_provider/index.md +++ b/docs/aws-docs/providers/aws/iam/saml_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual saml_provider resource, use saml_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual saml_provider resource, use Namesaml_provider TypeResource DescriptionResource Type definition for AWS::IAM::SAMLProvider -Idaws.iam.saml_provider +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestring
saml_metadata_documentstring
arnstringAmazon Resource Name (ARN) of the SAML provider
tagsarray
regionstringAWS region.
string
string
stringAmazon Resource Name (ARN) of the SAML provider
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual saml_provider resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/saml_providers/index.md b/docs/aws-docs/providers/aws/iam/saml_providers/index.md index 0ea6da05f5..ffe0fd93eb 100644 --- a/docs/aws-docs/providers/aws/iam/saml_providers/index.md +++ b/docs/aws-docs/providers/aws/iam/saml_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of saml_providers in a region or create a saml_providers resource, use saml_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of saml_providers in a region or create a < Namesaml_providers TypeResource DescriptionResource Type definition for AWS::IAM::SAMLProvider -Idaws.iam.saml_providers +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the SAML provider
regionstringAWS region.
stringAmazon Resource Name (ARN) of the SAML provider
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of saml_providers in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/server_certificate/index.md b/docs/aws-docs/providers/aws/iam/server_certificate/index.md index 1e17072930..d9ee22fda0 100644 --- a/docs/aws-docs/providers/aws/iam/server_certificate/index.md +++ b/docs/aws-docs/providers/aws/iam/server_certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual server_certificate resource, use server_certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual server_certificate resource, use Nameserver_certificate TypeResource DescriptionResource Type definition for AWS::IAM::ServerCertificate -Idaws.iam.server_certificate +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
certificate_bodystring
certificate_chainstring
server_certificate_namestring
pathstring
private_keystring
arnstringAmazon Resource Name (ARN) of the server certificate
tagsarray
regionstringAWS region.
string
string
string
string
string
stringAmazon Resource Name (ARN) of the server certificate
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual server_certificate resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/server_certificates/index.md b/docs/aws-docs/providers/aws/iam/server_certificates/index.md index 4987be383c..39b9891b68 100644 --- a/docs/aws-docs/providers/aws/iam/server_certificates/index.md +++ b/docs/aws-docs/providers/aws/iam/server_certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of server_certificates in a region or create a server_certificates resource, use server_certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of server_certificates in a region or creat Nameserver_certificates TypeResource DescriptionResource Type definition for AWS::IAM::ServerCertificate -Idaws.iam.server_certificates +Id ## Fields - - + +
NameDatatypeDescription
server_certificate_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of server_certificates in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/service_linked_role/index.md b/docs/aws-docs/providers/aws/iam/service_linked_role/index.md index 251fbf7917..32b5769253 100644 --- a/docs/aws-docs/providers/aws/iam/service_linked_role/index.md +++ b/docs/aws-docs/providers/aws/iam/service_linked_role/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_linked_role resource, use service_linked_roles to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual service_linked_role resource, use Nameservice_linked_role TypeResource DescriptionResource Type definition for AWS::IAM::ServiceLinkedRole -Idaws.iam.service_linked_role +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
role_namestringThe name of the role.
custom_suffixstringA string that you provide, which is combined with the service-provided prefix to form the complete role name.
descriptionstringThe description of the role.
aws_service_namestringThe service principal for the AWS service to which this role is attached.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual service_linked_role resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md index 0111d69b98..86303006ea 100644 --- a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md +++ b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_linked_roles in a region or create a service_linked_roles resource, use service_linked_role to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_linked_roles in a region or crea Nameservice_linked_roles TypeResource DescriptionResource Type definition for AWS::IAM::ServiceLinkedRole -Idaws.iam.service_linked_roles +Id ## Fields - - + +
NameDatatypeDescription
role_namestringThe name of the role.
regionstringAWS region.
stringThe name of the role.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_linked_roles in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/user/index.md b/docs/aws-docs/providers/aws/iam/user/index.md index c701ee5e74..885917738a 100644 --- a/docs/aws-docs/providers/aws/iam/user/index.md +++ b/docs/aws-docs/providers/aws/iam/user/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user resource, use users to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual user resource, use usersNameuser TypeResource DescriptionCreates a new IAM user for your AWS-account.<br/> For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.user +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
pathstringThe path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
managed_policy_arnsarrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).<br/> The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. <br/> For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
user_namestringThe name of the user to create. Do not include the path in this value.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
groupsarrayA list of group names to which you want to add the user.
arnstring
login_profileobjectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.<br/> You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.<br/> For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
tagsarrayA list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.<br/> If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
permissions_boundarystringThe ARN of the managed policy that is used to set the permissions boundary for the user.<br/> A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.<br/> For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
regionstringAWS region.
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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
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).<br/> The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. <br/> For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringThe name of the user to create. Do not include the path in this value.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
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.<br/> You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.<br/> For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
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*.<br/> If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
stringThe ARN of the managed policy that is used to set the permissions boundary for the user.<br/> A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.<br/> For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual user resource, use usersRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/user_policies/index.md b/docs/aws-docs/providers/aws/iam/user_policies/index.md index d6c5a106d9..a93281a4b0 100644 --- a/docs/aws-docs/providers/aws/iam/user_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/user_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + List of user policies by UserName (requires `aws` provider to be installed) ## Overview @@ -21,16 +24,16 @@ List of user policies by UserName (requires `aws` provider to be installed) Nameuser_policies TypeResource DescriptionList of user policies by UserName (requires `aws` provider to be installed) -Idaws.iam.user_policies +Id ## Fields - - - - + + + +
NameDatatypeDescription
user_namestringThe IAM user name
memberstringThe user policy name
regionstring
regionstringAWS region.
stringThe IAM user name
stringThe user policy name
string
stringAWS region.
@@ -43,9 +46,9 @@ List of user policies by UserName (requires `aws` provider to be installed) Required Params - view + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/user_policy/index.md b/docs/aws-docs/providers/aws/iam/user_policy/index.md index bf6ffc62a0..eaeab21ccb 100644 --- a/docs/aws-docs/providers/aws/iam/user_policy/index.md +++ b/docs/aws-docs/providers/aws/iam/user_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_policy resource, use user_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual user_policy resource, use u Nameuser_policy TypeResource DescriptionAdds or updates an inline policy document that is embedded in the specified IAM user.<br/> An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.user_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
policy_namestringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
user_namestringThe name of the user to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
regionstringAWS region.
objectThe policy document.<br/> You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.<br/> The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
stringThe name of the policy document.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the user to associate the policy with.<br/> This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual user_policy resource, use u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/users/index.md b/docs/aws-docs/providers/aws/iam/users/index.md index 49e89ec0d2..3bbf5417cf 100644 --- a/docs/aws-docs/providers/aws/iam/users/index.md +++ b/docs/aws-docs/providers/aws/iam/users/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of users in a region or create a users resource, use user to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of users in a region or create a user Nameusers TypeResource DescriptionCreates a new IAM user for your AWS-account.<br/> For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. -Idaws.iam.users +Id ## Fields - - + +
NameDatatypeDescription
user_namestringThe name of the user to create. Do not include the path in this value.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
regionstringAWS region.
stringThe name of the user to create. Do not include the path in this value.<br/> This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of users in a region or create a user Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md index 4c72e4f4a6..83f35235b1 100644 --- a/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual virtualmfa_device resource, use virtualmfa_devices to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual virtualmfa_device resource, use < Namevirtualmfa_device TypeResource DescriptionResource Type definition for AWS::IAM::VirtualMFADevice -Idaws.iam.virtualmfa_device +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
virtual_mfa_device_namestring
pathstring
serial_numberstring
usersarray
tagsarray
regionstringAWS region.
string
string
string
array
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual virtualmfa_device resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md index dd27ddb29e..9704d9bfae 100644 --- a/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of virtualmfa_devices in a region or create a virtualmfa_devices resource, use virtualmfa_device to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of virtualmfa_devices in a region or create Namevirtualmfa_devices TypeResource DescriptionResource Type definition for AWS::IAM::VirtualMFADevice -Idaws.iam.virtualmfa_devices +Id ## Fields - - + +
NameDatatypeDescription
serial_numberstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of virtualmfa_devices in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/identitystore/group/index.md b/docs/aws-docs/providers/aws/identitystore/group/index.md index 30ef6859c9..97af89205f 100644 --- a/docs/aws-docs/providers/aws/identitystore/group/index.md +++ b/docs/aws-docs/providers/aws/identitystore/group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group resource, use groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual group resource, use groups< Namegroup TypeResource DescriptionResource Type definition for AWS::IdentityStore::Group -Idaws.identitystore.group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringA string containing the description of the group.
display_namestringA string containing the name of the group. This value is commonly displayed when the group is referenced.
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual group resource, use groups< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/identitystore/group_membership/index.md b/docs/aws-docs/providers/aws/identitystore/group_membership/index.md index 88c3043401..9137fac55c 100644 --- a/docs/aws-docs/providers/aws/identitystore/group_membership/index.md +++ b/docs/aws-docs/providers/aws/identitystore/group_membership/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group_membership resource, use group_memberships to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual group_membership resource, use Namegroup_membership TypeResource DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership -Idaws.identitystore.group_membership +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
member_idobjectAn object containing the identifier of a group member.
membership_idstringThe identifier for a GroupMembership in the identity store.
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual group_membership resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md index c4cee0d331..c52f49a215 100644 --- a/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md +++ b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of group_memberships in a region or create a group_memberships resource, use group_membership to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of group_memberships in a region or create Namegroup_memberships TypeResource DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership -Idaws.identitystore.group_memberships +Id ## Fields - - - + + +
NameDatatypeDescription
membership_idstringThe identifier for a GroupMembership in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
stringThe identifier for a GroupMembership in the identity store.
stringThe globally unique identifier for the identity store.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of group_memberships in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/identitystore/groups/index.md b/docs/aws-docs/providers/aws/identitystore/groups/index.md index a45f4b3fa4..e174e1b060 100644 --- a/docs/aws-docs/providers/aws/identitystore/groups/index.md +++ b/docs/aws-docs/providers/aws/identitystore/groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of groups in a region or create a gro Namegroups TypeResource DescriptionResource Type definition for AWS::IdentityStore::Group -Idaws.identitystore.groups +Id ## Fields - - - + + +
NameDatatypeDescription
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of groups in a region or create a gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/component/index.md b/docs/aws-docs/providers/aws/imagebuilder/component/index.md index 74206175e9..8d06a430b6 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/component/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/component/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual component resource, use components to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual component resource, use com Namecomponent TypeResource DescriptionResource schema for AWS::ImageBuilder::Component -Idaws.imagebuilder.component +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the component.
namestringThe name of the component.
versionstringThe version of the component.
descriptionstringThe description of the component.
change_descriptionstringThe change description of the component.
typestringThe type of the component denotes whether the component is used to build the image or only to test it.
platformstringThe platform of the component.
datastringThe data of the component.
kms_key_idstringThe KMS key identifier used to encrypt the component.
encryptedbooleanThe encryption status of the component.
tagsobjectThe tags associated with the component.
uristringThe uri of the component.
supported_os_versionsarrayThe operating system (OS) version supported by the component.
regionstringAWS region.
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.
@@ -53,14 +56,14 @@ Gets or operates on an individual component resource, use com Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/components/index.md b/docs/aws-docs/providers/aws/imagebuilder/components/index.md index e020eac112..1070fafa5a 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/components/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/components/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of components in a region or create a components resource, use component to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of components in a region or create a Namecomponents TypeResource DescriptionResource schema for AWS::ImageBuilder::Component -Idaws.imagebuilder.components +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the component.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the component.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of components in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md index 42ee459680..dec4c2191a 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual container_recipe resource, use container_recipes to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual container_recipe resource, use Namecontainer_recipe TypeResource DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe -Idaws.imagebuilder.container_recipe +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the container recipe.
namestringThe name of the container recipe.
descriptionstringThe description of the container recipe.
versionstringThe semantic version of the container recipe (<major>.<minor>.<patch>).
componentsarrayComponents for build and test that are included in the container recipe.
instance_configurationobjectA group of options that can be used to configure an instance for building and testing container images.
dockerfile_template_datastringDockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
dockerfile_template_uristringThe S3 URI for the Dockerfile that will be used to build your container image.
platform_overridestringSpecifies the operating system platform when you use a custom source image.
container_typestringSpecifies the type of container, such as Docker.
image_os_version_overridestringSpecifies the operating system version for the source image.
target_repositoryobjectThe destination repository for the container image.
kms_key_idstringIdentifies which KMS key is used to encrypt the container image.
parent_imagestringThe source image for the container recipe.
working_directorystringThe working directory to be used during build and test workflows.
tagsobjectTags that are attached to the container recipe.
regionstringAWS region.
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.
@@ -56,14 +59,14 @@ Gets or operates on an individual container_recipe resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md index 9e3786a919..28c10af260 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of container_recipes in a region or create a container_recipes resource, use container_recipe to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of container_recipes in a region or create Namecontainer_recipes TypeResource DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe -Idaws.imagebuilder.container_recipes +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the container recipe.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the container recipe.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of container_recipes in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md index 60c73e50d8..5262604492 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual distribution_configuration resource, use distribution_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual distribution_configuration resour Namedistribution_configuration TypeResource DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration -Idaws.imagebuilder.distribution_configuration +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
namestringThe name of the distribution configuration.
descriptionstringThe description of the distribution configuration.
distributionsarrayThe distributions of the distribution configuration.
tagsobjectThe tags associated with the component.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual distribution_configuration resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md index 4e1e57aa4e..6a0dd492f4 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of distribution_configurations in a region or create a distribution_configurations resource, use distribution_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of distribution_configurations in a region Namedistribution_configurations TypeResource DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration -Idaws.imagebuilder.distribution_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of distribution_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image/index.md b/docs/aws-docs/providers/aws/imagebuilder/image/index.md index 4258d8d80d..f8aeac933e 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image resource, use images to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual image resource, use images< Nameimage TypeResource DescriptionResource schema for AWS::ImageBuilder::Image -Idaws.imagebuilder.image +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
namestringThe name of the image.
image_tests_configurationobjectThe image tests configuration used when creating this image.
image_recipe_arnstringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arnstringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
infrastructure_configuration_arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
workflowsarrayWorkflows to define the image build process
image_idstringThe AMI ID of the EC2 AMI in current region.
image_uristringURI for containers created in current Region with default ECR image tag
enhanced_image_metadata_enabledbooleanCollects additional information about the image being created, including the operating system (OS) version and package list.
image_scanning_configurationobjectContains settings for vulnerability scans.
execution_rolestringThe execution role name/ARN for the image build, if provided
tagsobjectThe tags associated with the image.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the image.
stringThe name of the image.
objectThe image tests configuration used when creating this image.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
arrayWorkflows to define the image build process
stringThe AMI ID of the EC2 AMI in current region.
stringURI for containers created in current Region with default ECR image tag
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
objectThe tags associated with the image.
stringAWS region.
@@ -54,14 +57,14 @@ Gets or operates on an individual image resource, use images< Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md index 8b40cec825..ee6564b61e 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image_pipeline resource, use image_pipelines to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual image_pipeline resource, use Nameimage_pipeline TypeResource DescriptionResource schema for AWS::ImageBuilder::ImagePipeline -Idaws.imagebuilder.image_pipeline +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image pipeline.
namestringThe name of the image pipeline.
descriptionstringThe description of the image pipeline.
image_tests_configurationobjectThe image tests configuration of the image pipeline.
statusstringThe status of the image pipeline.
scheduleobjectThe schedule of the image pipeline.
image_recipe_arnstringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arnstringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arnstringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
infrastructure_configuration_arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
workflowsarrayWorkflows to define the image build process
enhanced_image_metadata_enabledbooleanCollects additional information about the image being created, including the operating system (OS) version and package list.
image_scanning_configurationobjectContains settings for vulnerability scans.
execution_rolestringThe execution role name/ARN for the image build, if provided
tagsobjectThe tags of this image pipeline.
regionstringAWS region.
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual image_pipeline resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md index b36a79dc1e..be0fe0efab 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of image_pipelines in a region or create a image_pipelines resource, use image_pipeline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of image_pipelines in a region or create a Nameimage_pipelines TypeResource DescriptionResource schema for AWS::ImageBuilder::ImagePipeline -Idaws.imagebuilder.image_pipelines +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image pipeline.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of image_pipelines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md index d8d091df52..b2be09a8c2 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image_recipe resource, use image_recipes to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual image_recipe resource, use Nameimage_recipe TypeResource DescriptionResource schema for AWS::ImageBuilder::ImageRecipe -Idaws.imagebuilder.image_recipe +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image recipe.
namestringThe name of the image recipe.
descriptionstringThe description of the image recipe.
versionstringThe version of the image recipe.
componentsarrayThe components of the image recipe.
block_device_mappingsarrayThe block device mappings to apply when creating images from this recipe.
parent_imagestringThe parent image of the image recipe.
working_directorystringThe working directory to be used during build and test workflows.
additional_instance_configurationobjectSpecify additional settings and launch scripts for your build instances.
tagsobjectThe tags of the image recipe.
regionstringAWS region.
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.
@@ -50,14 +53,14 @@ Gets or operates on an individual image_recipe resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md index eb8fc06d25..65f194ab5c 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of image_recipes in a region or create a image_recipes resource, use image_recipe to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of image_recipes in a region or create a Nameimage_recipes TypeResource DescriptionResource schema for AWS::ImageBuilder::ImageRecipe -Idaws.imagebuilder.image_recipes +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image recipe.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the image recipe.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of image_recipes in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/images/index.md b/docs/aws-docs/providers/aws/imagebuilder/images/index.md index 49b89146ec..6c27a23f55 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/images/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/images/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of images in a region or create a images resource, use image to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of images in a region or create a ima Nameimages TypeResource DescriptionResource schema for AWS::ImageBuilder::Image -Idaws.imagebuilder.images +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the image.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of images in a region or create a ima Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md index 32f474ab48..cf0891a87f 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual infrastructure_configuration resource, use infrastructure_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual infrastructure_configuration reso Nameinfrastructure_configuration TypeResource DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration -Idaws.imagebuilder.infrastructure_configuration +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
namestringThe name of the infrastructure configuration.
descriptionstringThe description of the infrastructure configuration.
instance_typesarrayThe instance types of the infrastructure configuration.
security_group_idsarrayThe security group IDs of the infrastructure configuration.
loggingobjectThe logging configuration of the infrastructure configuration.
subnet_idstringThe subnet ID of the infrastructure configuration.
key_pairstringThe EC2 key pair of the infrastructure configuration..
terminate_instance_on_failurebooleanThe terminate instance on failure configuration of the infrastructure configuration.
instance_profile_namestringThe instance profile of the infrastructure configuration.
instance_metadata_optionsobjectThe instance metadata option settings for the infrastructure configuration.
sns_topic_arnstringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
resource_tagsobjectThe tags attached to the resource created by Image Builder.
tagsobjectThe tags associated with the component.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe name of the infrastructure configuration.
stringThe description of the infrastructure configuration.
arrayThe instance types of the infrastructure configuration.
arrayThe security group IDs of the infrastructure configuration.
objectThe logging configuration of the infrastructure configuration.
stringThe subnet ID of the infrastructure configuration.
stringThe EC2 key pair of the infrastructure configuration..
booleanThe terminate instance on failure configuration of the infrastructure configuration.
stringThe instance profile of the infrastructure configuration.
objectThe instance metadata option settings for the infrastructure configuration.
stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
objectThe tags attached to the resource created by Image Builder.
objectThe tags associated with the component.
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual infrastructure_configuration reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md index 218780f245..240bc58e9d 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of infrastructure_configurations in a region or create a infrastructure_configurations resource, use infrastructure_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of infrastructure_configurations in a regio Nameinfrastructure_configurations TypeResource DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration -Idaws.imagebuilder.infrastructure_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of infrastructure_configurations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md index 6835dcf733..3ec4cc6772 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of lifecycle_policies in a region or create a lifecycle_policies resource, use lifecycle_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of lifecycle_policies in a region or create Namelifecycle_policies TypeResource DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy -Idaws.imagebuilder.lifecycle_policies +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the lifecycle policy.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of lifecycle_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md index 7234755869..e099e4bdad 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual lifecycle_policy resource, use lifecycle_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual lifecycle_policy resource, use Namelifecycle_policy TypeResource DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy -Idaws.imagebuilder.lifecycle_policy +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the lifecycle policy.
namestringThe name of the lifecycle policy.
descriptionstringThe description of the lifecycle policy.
statusstringThe status of the lifecycle policy.
execution_rolestringThe execution role of the lifecycle policy.
resource_typestringThe resource type of the lifecycle policy.
policy_detailsarrayThe policy details of the lifecycle policy.
resource_selectionobjectThe resource selection of the lifecycle policy.
tagsobjectThe tags associated with the lifecycle policy.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual lifecycle_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md index 79c330b4d4..001de5f988 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workflow resource, use workflows to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual workflow resource, use work Nameworkflow TypeResource DescriptionResource schema for AWS::ImageBuilder::Workflow -Idaws.imagebuilder.workflow +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the workflow.
namestringThe name of the workflow.
versionstringThe version of the workflow.
descriptionstringThe description of the workflow.
change_descriptionstringThe change description of the workflow.
typestringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
datastringThe data of the workflow.
uristringThe uri of the workflow.
kms_key_idstringThe KMS key identifier used to encrypt the workflow.
tagsobjectThe tags associated with the workflow.
regionstringAWS region.
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.
@@ -50,14 +53,14 @@ Gets or operates on an individual workflow resource, use work Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md index 502a169f1b..a852eb04e5 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workflows in a region or create a workflows resource, use workflow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workflows in a region or create a Nameworkflows TypeResource DescriptionResource schema for AWS::ImageBuilder::Workflow -Idaws.imagebuilder.workflows +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the workflow.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the workflow.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workflows in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_target/index.md b/docs/aws-docs/providers/aws/inspector/assessment_target/index.md index 57a781fe69..c8990ceb6e 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_target/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_target/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assessment_target resource, use assessment_targets to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual assessment_target resource, use < Nameassessment_target TypeResource DescriptionResource Type definition for AWS::Inspector::AssessmentTarget -Idaws.inspector.assessment_target +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstring
assessment_target_namestring
resource_group_arnstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual assessment_target resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md index 11f1c47ccd..8090a084dd 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assessment_targets in a region or create a assessment_targets resource, use assessment_target to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assessment_targets in a region or create Nameassessment_targets TypeResource DescriptionResource Type definition for AWS::Inspector::AssessmentTarget -Idaws.inspector.assessment_targets +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assessment_targets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_template/index.md b/docs/aws-docs/providers/aws/inspector/assessment_template/index.md index ef8adfc84d..f2d6b56bb2 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_template/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assessment_template resource, use assessment_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual assessment_template resource, use Nameassessment_template TypeResource DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate -Idaws.inspector.assessment_template +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
assessment_target_arnstring
duration_in_secondsinteger
assessment_template_namestring
rules_package_arnsarray
user_attributes_for_findingsarray
regionstringAWS region.
string
string
integer
string
array
array
stringAWS region.
@@ -46,14 +49,14 @@ Gets or operates on an individual assessment_template resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md index b30e347980..1b7fa886cd 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assessment_templates in a region or create a assessment_templates resource, use assessment_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assessment_templates in a region or crea Nameassessment_templates TypeResource DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate -Idaws.inspector.assessment_templates +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assessment_templates in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/inspector/resource_group/index.md b/docs/aws-docs/providers/aws/inspector/resource_group/index.md index a045e33fec..81d7d4dc72 100644 --- a/docs/aws-docs/providers/aws/inspector/resource_group/index.md +++ b/docs/aws-docs/providers/aws/inspector/resource_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_group resource, use resource_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual resource_group resource, use Nameresource_group TypeResource DescriptionResource Type definition for AWS::Inspector::ResourceGroup -Idaws.inspector.resource_group +Id ## Fields - - - + + +
NameDatatypeDescription
arnstring
resource_group_tagsarray
regionstringAWS region.
string
array
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual resource_group resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/inspector/resource_groups/index.md b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md index e31c8125a8..40b5ff9762 100644 --- a/docs/aws-docs/providers/aws/inspector/resource_groups/index.md +++ b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_groups in a region or create a resource_groups resource, use resource_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_groups in a region or create a Nameresource_groups TypeResource DescriptionResource Type definition for AWS::Inspector::ResourceGroup -Idaws.inspector.resource_groups +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md index 5d7d2e89b3..3c3f8a3d6d 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cis_scan_configuration resource, use cis_scan_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual cis_scan_configuration resource, Namecis_scan_configuration TypeResource DescriptionCIS Scan Configuration resource schema -Idaws.inspectorv2.cis_scan_configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
scan_namestringName of the scan
security_levelstring
scheduleundefined
targetsundefined
arnstringCIS Scan configuration unique identifier
tagsobject
regionstringAWS region.
stringName of the scan
string
undefined
undefined
stringCIS Scan configuration unique identifier
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual cis_scan_configuration resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md index 04bebfa629..cfeb509888 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cis_scan_configurations in a region or create a cis_scan_configurations resource, use cis_scan_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cis_scan_configurations in a region or c Namecis_scan_configurations TypeResource DescriptionCIS Scan Configuration resource schema -Idaws.inspectorv2.cis_scan_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringCIS Scan configuration unique identifier
regionstringAWS region.
stringCIS Scan configuration unique identifier
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cis_scan_configurations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/inspectorv2/filter/index.md b/docs/aws-docs/providers/aws/inspectorv2/filter/index.md index a7b32e0cce..bf4031cc3f 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/filter/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual filter resource, use filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual filter resource, use filter Namefilter TypeResource DescriptionInspector Filter resource schema -Idaws.inspectorv2.filter +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringFindings filter name.
descriptionstringFindings filter description.
filter_criteriaobjectFindings filter criteria.
filter_actionstringFindings filter action.
arnstringFindings filter ARN.
regionstringAWS region.
stringFindings filter name.
stringFindings filter description.
objectFindings filter criteria.
stringFindings filter action.
stringFindings filter ARN.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual filter resource, use filter Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/inspectorv2/filters/index.md b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md index f053fc4008..0b2eef95c0 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/filters/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of filters in a region or create a filters resource, use filter to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of filters in a region or create a fi Namefilters TypeResource DescriptionInspector Filter resource schema -Idaws.inspectorv2.filters +Id ## Fields - - + +
NameDatatypeDescription
arnstringFindings filter ARN.
regionstringAWS region.
stringFindings filter ARN.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of filters in a region or create a fi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md index 47aafe5015..6fd86445d5 100644 --- a/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md +++ b/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual monitor resource, use monitors to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual monitor resource, use monit Namemonitor TypeResource DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application -Idaws.internetmonitor.monitor +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
created_atstring
modified_atstring
monitor_arnstring
monitor_namestring
linked_account_idstring
include_linked_accountsboolean
processing_statusstring
processing_status_infostring
resourcesarray
resources_to_addarray
resources_to_removearray
statusstring
tagsarray
max_city_networks_to_monitorinteger
traffic_percentage_to_monitorinteger
internet_measurements_log_deliveryobject
health_events_configobject
regionstringAWS region.
string
string
string
string
string
boolean
string
string
array
array
array
string
array
integer
integer
object
object
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual monitor resource, use monit Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md index 6f367159d5..aa83fd74e3 100644 --- a/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md +++ b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of monitors in a region or create a monitors resource, use monitor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of monitors in a region or create a m Namemonitors TypeResource DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application -Idaws.internetmonitor.monitors +Id ## Fields - - + +
NameDatatypeDescription
monitor_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of monitors in a region or create a m Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md index 2692ca7510..4df505f0c7 100644 --- a/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md +++ b/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account_audit_configuration resource, use account_audit_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual account_audit_configuration resou Nameaccount_audit_configuration TypeResource DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. -Idaws.iot.account_audit_configuration +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
audit_check_configurationsobject
audit_notification_target_configurationsobject
role_arnstringThe ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
regionstringAWS region.
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
object
object
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual account_audit_configuration resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md index 2947b6794d..cc2eec2827 100644 --- a/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md +++ b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of account_audit_configurations in a region or create a account_audit_configurations resource, use account_audit_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of account_audit_configurations in a region Nameaccount_audit_configurations TypeResource DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. -Idaws.iot.account_audit_configurations +Id ## Fields - - + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of account_audit_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/authorizer/index.md b/docs/aws-docs/providers/aws/iot/authorizer/index.md index 2215952c07..9650ffda42 100644 --- a/docs/aws-docs/providers/aws/iot/authorizer/index.md +++ b/docs/aws-docs/providers/aws/iot/authorizer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual authorizer resource, use authorizers to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual authorizer resource, use au Nameauthorizer TypeResource DescriptionCreates an authorizer. -Idaws.iot.authorizer +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
authorizer_function_arnstring
arnstring
authorizer_namestring
signing_disabledboolean
statusstring
token_key_namestring
token_signing_public_keysobject
enable_caching_for_httpboolean
tagsarray
regionstringAWS region.
string
string
string
boolean
string
string
object
boolean
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual authorizer resource, use au Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/authorizers/index.md b/docs/aws-docs/providers/aws/iot/authorizers/index.md index 82f1393bb0..2a85833267 100644 --- a/docs/aws-docs/providers/aws/iot/authorizers/index.md +++ b/docs/aws-docs/providers/aws/iot/authorizers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of authorizers in a region or create a authorizers resource, use authorizer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of authorizers in a region or create a Nameauthorizers TypeResource DescriptionCreates an authorizer. -Idaws.iot.authorizers +Id ## Fields - - + +
NameDatatypeDescription
authorizer_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of authorizers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/billing_group/index.md b/docs/aws-docs/providers/aws/iot/billing_group/index.md index 2048878342..31f7882ac1 100644 --- a/docs/aws-docs/providers/aws/iot/billing_group/index.md +++ b/docs/aws-docs/providers/aws/iot/billing_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual billing_group resource, use billing_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual billing_group resource, use Namebilling_group TypeResource DescriptionResource Type definition for AWS::IoT::BillingGroup -Idaws.iot.billing_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstring
arnstring
billing_group_namestring
tagsarrayAn array of key-value pairs to apply to this resource.
billing_group_propertiesobject
regionstringAWS region.
string
string
string
arrayAn array of key-value pairs to apply to this resource.
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual billing_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/billing_groups/index.md b/docs/aws-docs/providers/aws/iot/billing_groups/index.md index 1bb2c5aac2..8e336a1b70 100644 --- a/docs/aws-docs/providers/aws/iot/billing_groups/index.md +++ b/docs/aws-docs/providers/aws/iot/billing_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of billing_groups in a region or create a billing_groups resource, use billing_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of billing_groups in a region or create a < Namebilling_groups TypeResource DescriptionResource Type definition for AWS::IoT::BillingGroup -Idaws.iot.billing_groups +Id ## Fields - - + +
NameDatatypeDescription
billing_group_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of billing_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificate/index.md b/docs/aws-docs/providers/aws/iot/ca_certificate/index.md index 379a832a66..e77f19d03c 100644 --- a/docs/aws-docs/providers/aws/iot/ca_certificate/index.md +++ b/docs/aws-docs/providers/aws/iot/ca_certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ca_certificate resource, use ca_certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual ca_certificate resource, use Nameca_certificate TypeResource DescriptionRegisters a CA Certificate in IoT. -Idaws.iot.ca_certificate +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
ca_certificate_pemstring
verification_certificate_pemstringThe private key verification certificate.
statusstring
certificate_modestring
auto_registration_statusstring
remove_auto_registrationboolean
registration_configobject
idstring
arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual ca_certificate resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificates/index.md b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md index 0ce492b7ad..455d10b6a4 100644 --- a/docs/aws-docs/providers/aws/iot/ca_certificates/index.md +++ b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ca_certificates in a region or create a ca_certificates resource, use ca_certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of ca_certificates in a region or create a Nameca_certificates TypeResource DescriptionRegisters a CA Certificate in IoT. -Idaws.iot.ca_certificates +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of ca_certificates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/certificate/index.md b/docs/aws-docs/providers/aws/iot/certificate/index.md index a953b6f522..d2babb0423 100644 --- a/docs/aws-docs/providers/aws/iot/certificate/index.md +++ b/docs/aws-docs/providers/aws/iot/certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate resource, use certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual certificate resource, use c Namecertificate TypeResource DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. -Idaws.iot.certificate +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
ca_certificate_pemstring
certificate_pemstring
certificate_signing_requeststring
certificate_modestring
statusstring
idstring
arnstring
regionstringAWS region.
string
string
string
string
string
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual certificate resource, use c Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/certificate_provider/index.md b/docs/aws-docs/providers/aws/iot/certificate_provider/index.md index 7e24dc5d53..326450bfa6 100644 --- a/docs/aws-docs/providers/aws/iot/certificate_provider/index.md +++ b/docs/aws-docs/providers/aws/iot/certificate_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate_provider resource, use certificate_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual certificate_provider resource, us Namecertificate_provider TypeResource DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider. -Idaws.iot.certificate_provider +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
certificate_provider_namestring
lambda_function_arnstring
account_default_for_operationsarray
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
regionstringAWS region.
string
string
array
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual certificate_provider resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/certificate_providers/index.md b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md index 4a531344a1..33f27366a5 100644 --- a/docs/aws-docs/providers/aws/iot/certificate_providers/index.md +++ b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificate_providers in a region or create a certificate_providers resource, use certificate_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificate_providers in a region or cre Namecertificate_providers TypeResource DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider. -Idaws.iot.certificate_providers +Id ## Fields - - + +
NameDatatypeDescription
certificate_provider_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificate_providers in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/certificates/index.md b/docs/aws-docs/providers/aws/iot/certificates/index.md index 8d421c54f3..b2ad5644eb 100644 --- a/docs/aws-docs/providers/aws/iot/certificates/index.md +++ b/docs/aws-docs/providers/aws/iot/certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificates in a region or create a certificates resource, use certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificates in a region or create a Namecertificates TypeResource DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. -Idaws.iot.certificates +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/custom_metric/index.md b/docs/aws-docs/providers/aws/iot/custom_metric/index.md index e9cafa8883..44f5a9177e 100644 --- a/docs/aws-docs/providers/aws/iot/custom_metric/index.md +++ b/docs/aws-docs/providers/aws/iot/custom_metric/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual custom_metric resource, use custom_metrics to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual custom_metric resource, use Namecustom_metric TypeResource DescriptionA custom metric published by your devices to Device Defender. -Idaws.iot.custom_metric +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
metric_namestringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
display_namestringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metric_typestringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
metric_arnstringThe Amazon Resource Number (ARN) of the custom metric.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual custom_metric resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/custom_metrics/index.md b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md index ed9d785293..8147e202dd 100644 --- a/docs/aws-docs/providers/aws/iot/custom_metrics/index.md +++ b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of custom_metrics in a region or create a custom_metrics resource, use custom_metric to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of custom_metrics in a region or create a < Namecustom_metrics TypeResource DescriptionA custom metric published by your devices to Device Defender. -Idaws.iot.custom_metrics +Id ## Fields - - + +
NameDatatypeDescription
metric_namestringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of custom_metrics in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/dimension/index.md b/docs/aws-docs/providers/aws/iot/dimension/index.md index a224c141f9..1f2ea1e41f 100644 --- a/docs/aws-docs/providers/aws/iot/dimension/index.md +++ b/docs/aws-docs/providers/aws/iot/dimension/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dimension resource, use dimensions to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual dimension resource, use dim Namedimension TypeResource DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender. -Idaws.iot.dimension +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringA unique identifier for the dimension.
typestringSpecifies the type of the dimension.
string_valuesarraySpecifies the value or list of values for the dimension.
tagsarrayMetadata that can be used to manage the dimension.
arnstringThe ARN (Amazon resource name) of the created dimension.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual dimension resource, use dim Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/dimensions/index.md b/docs/aws-docs/providers/aws/iot/dimensions/index.md index 0f5b4b49cd..daab55405f 100644 --- a/docs/aws-docs/providers/aws/iot/dimensions/index.md +++ b/docs/aws-docs/providers/aws/iot/dimensions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dimensions in a region or create a dimensions resource, use dimension to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dimensions in a region or create a Namedimensions TypeResource DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender. -Idaws.iot.dimensions +Id ## Fields - - + +
NameDatatypeDescription
namestringA unique identifier for the dimension.
regionstringAWS region.
stringA unique identifier for the dimension.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dimensions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/domain_configuration/index.md b/docs/aws-docs/providers/aws/iot/domain_configuration/index.md index 8236643338..9cdf31fe52 100644 --- a/docs/aws-docs/providers/aws/iot/domain_configuration/index.md +++ b/docs/aws-docs/providers/aws/iot/domain_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain_configuration resource, use domain_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual domain_configuration resource, us Namedomain_configuration TypeResource DescriptionCreate and manage a Domain Configuration -Idaws.iot.domain_configuration +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
domain_configuration_namestring
authorizer_configobject
domain_namestring
server_certificate_arnsarray
service_typestring
validation_certificate_arnstring
arnstring
domain_configuration_statusstring
domain_typestring
server_certificate_configobject
server_certificatesarray
tls_configobject
tagsarray
regionstringAWS region.
string
object
string
array
string
string
string
string
string
object
array
object
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual domain_configuration resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/domain_configurations/index.md b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md index 4ba90ed9e6..2153e31b1a 100644 --- a/docs/aws-docs/providers/aws/iot/domain_configurations/index.md +++ b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domain_configurations in a region or create a domain_configurations resource, use domain_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domain_configurations in a region or cre Namedomain_configurations TypeResource DescriptionCreate and manage a Domain Configuration -Idaws.iot.domain_configurations +Id ## Fields - - + +
NameDatatypeDescription
domain_configuration_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domain_configurations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metric/index.md b/docs/aws-docs/providers/aws/iot/fleet_metric/index.md index 3b8cc44e51..a804f53cab 100644 --- a/docs/aws-docs/providers/aws/iot/fleet_metric/index.md +++ b/docs/aws-docs/providers/aws/iot/fleet_metric/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet_metric resource, use fleet_metrics to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual fleet_metric resource, use Namefleet_metric TypeResource DescriptionAn aggregated metric of certain devices in your fleet -Idaws.iot.fleet_metric +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
metric_namestringThe name of the fleet metric
descriptionstringThe description of a fleet metric
query_stringstringThe Fleet Indexing query used by a fleet metric
periodintegerThe period of metric emission in seconds
aggregation_fieldstringThe aggregation field to perform aggregation and metric emission
query_versionstringThe version of a Fleet Indexing query used by a fleet metric
index_namestringThe index name of a fleet metric
unitstringThe unit of data points emitted by a fleet metric
aggregation_typeobject
metric_arnstringThe Amazon Resource Number (ARN) of a fleet metric metric
creation_datestringThe creation date of a fleet metric
last_modified_datestringThe last modified date of a fleet metric
versionnumberThe version of a fleet metric
tagsarrayAn array of key-value pairs to apply to this resource
regionstringAWS region.
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
object
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.
@@ -54,19 +57,19 @@ Gets or operates on an individual fleet_metric resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md index 79bd8e8b5b..712d2193ab 100644 --- a/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md +++ b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleet_metrics in a region or create a fleet_metrics resource, use fleet_metric to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleet_metrics in a region or create a Namefleet_metrics TypeResource DescriptionAn aggregated metric of certain devices in your fleet -Idaws.iot.fleet_metrics +Id ## Fields - - + +
NameDatatypeDescription
metric_namestringThe name of the fleet metric
regionstringAWS region.
stringThe name of the fleet metric
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleet_metrics in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/job_template/index.md b/docs/aws-docs/providers/aws/iot/job_template/index.md index a862da9281..6137109a8a 100644 --- a/docs/aws-docs/providers/aws/iot/job_template/index.md +++ b/docs/aws-docs/providers/aws/iot/job_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual job_template resource, use job_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual job_template resource, use Namejob_template TypeResource DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices. -Idaws.iot.job_template +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
job_arnstringOptional for copying a JobTemplate from a pre-existing Job configuration.
job_template_idstring
descriptionstringA description of the Job Template.
documentstringThe job document. Required if you don't specify a value for documentSource.
document_sourcestringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
timeout_configobjectSpecifies the amount of time each device has to finish its execution of the job.
job_executions_rollout_configobjectAllows you to create a staged rollout of a job.
abort_configobjectThe criteria that determine when and how a job abort takes place.
presigned_url_configobjectConfiguration for pre-signed S3 URLs.
job_executions_retry_configobject
maintenance_windowsarray
destination_package_versionsarray
tagsarrayMetadata that can be used to manage the JobTemplate.
regionstringAWS region.
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.
@@ -54,14 +57,14 @@ Gets or operates on an individual job_template resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/job_templates/index.md b/docs/aws-docs/providers/aws/iot/job_templates/index.md index 3e80f21a03..68ef9e5fed 100644 --- a/docs/aws-docs/providers/aws/iot/job_templates/index.md +++ b/docs/aws-docs/providers/aws/iot/job_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of job_templates in a region or create a job_templates resource, use job_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of job_templates in a region or create a Namejob_templates TypeResource DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices. -Idaws.iot.job_templates +Id ## Fields - - + +
NameDatatypeDescription
job_template_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of job_templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/logging/index.md b/docs/aws-docs/providers/aws/iot/logging/index.md index aaceb0ef80..a80809a859 100644 --- a/docs/aws-docs/providers/aws/iot/logging/index.md +++ b/docs/aws-docs/providers/aws/iot/logging/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual logging resource, use loggings to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual logging resource, use loggi Namelogging TypeResource DescriptionLogging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service. -Idaws.iot.logging +Id ## Fields - - - - + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
role_arnstringThe ARN of the role that allows IoT to write to Cloudwatch logs.
default_log_levelstringThe log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual logging resource, use loggi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/loggings/index.md b/docs/aws-docs/providers/aws/iot/loggings/index.md index 6b2fae6c50..e2556b2f11 100644 --- a/docs/aws-docs/providers/aws/iot/loggings/index.md +++ b/docs/aws-docs/providers/aws/iot/loggings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of loggings in a region or create a loggings resource, use logging to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of loggings in a region or create a l Nameloggings TypeResource DescriptionLogging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service. -Idaws.iot.loggings +Id ## Fields - - + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of loggings in a region or create a l Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_action/index.md b/docs/aws-docs/providers/aws/iot/mitigation_action/index.md index 95a487c622..2f0b1e6424 100644 --- a/docs/aws-docs/providers/aws/iot/mitigation_action/index.md +++ b/docs/aws-docs/providers/aws/iot/mitigation_action/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual mitigation_action resource, use mitigation_actions to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual mitigation_action resource, use < Namemitigation_action TypeResource DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation. -Idaws.iot.mitigation_action +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
action_namestringA unique identifier for the mitigation action.
role_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
action_paramsobject
mitigation_action_arnstring
mitigation_action_idstring
regionstringAWS region.
stringA unique identifier for the mitigation action.
string
arrayAn array of key-value pairs to apply to this resource.
object
string
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual mitigation_action resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md index 14177a5513..a499842bd2 100644 --- a/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md +++ b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of mitigation_actions in a region or create a mitigation_actions resource, use mitigation_action to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of mitigation_actions in a region or create Namemitigation_actions TypeResource DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation. -Idaws.iot.mitigation_actions +Id ## Fields - - + +
NameDatatypeDescription
action_namestringA unique identifier for the mitigation action.
regionstringAWS region.
stringA unique identifier for the mitigation action.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of mitigation_actions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/policies/index.md b/docs/aws-docs/providers/aws/iot/policies/index.md index ab5d23d072..9f407d87ac 100644 --- a/docs/aws-docs/providers/aws/iot/policies/index.md +++ b/docs/aws-docs/providers/aws/iot/policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policies in a region or create a policies resource, use policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of policies in a region or create a p Namepolicies TypeResource DescriptionResource Type definition for AWS::IoT::Policy -Idaws.iot.policies +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of policies in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/policy/index.md b/docs/aws-docs/providers/aws/iot/policy/index.md index 1ca4cc8caf..623712ec34 100644 --- a/docs/aws-docs/providers/aws/iot/policy/index.md +++ b/docs/aws-docs/providers/aws/iot/policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy resource, use policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual policy resource, use polici Namepolicy TypeResource DescriptionResource Type definition for AWS::IoT::Policy -Idaws.iot.policy +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstring
arnstring
policy_documentobject
policy_namestring
tagsarray
regionstringAWS region.
string
string
object
string
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual policy resource, use polici Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_template/index.md b/docs/aws-docs/providers/aws/iot/provisioning_template/index.md index 91c799c8f8..8cf114ee18 100644 --- a/docs/aws-docs/providers/aws/iot/provisioning_template/index.md +++ b/docs/aws-docs/providers/aws/iot/provisioning_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual provisioning_template resource, use provisioning_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual provisioning_template resource, u Nameprovisioning_template TypeResource DescriptionCreates a fleet provisioning template. -Idaws.iot.provisioning_template +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
template_arnstring
template_namestring
descriptionstring
enabledboolean
provisioning_role_arnstring
template_bodystring
template_typestring
pre_provisioning_hookobject
tagsarray
regionstringAWS region.
string
string
string
boolean
string
string
string
object
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual provisioning_template resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md index fcaadb7a3e..af87e94cc9 100644 --- a/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md +++ b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of provisioning_templates in a region or create a provisioning_templates resource, use provisioning_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of provisioning_templates in a region or cr Nameprovisioning_templates TypeResource DescriptionCreates a fleet provisioning template. -Idaws.iot.provisioning_templates +Id ## Fields - - + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of provisioning_templates in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md index 25599a68b2..303d5f9eab 100644 --- a/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md +++ b/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_specific_logging resource, use resource_specific_loggings to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource_specific_logging resourc Nameresource_specific_logging TypeResource DescriptionResource-specific logging allows you to specify a logging level for a specific thing group. -Idaws.iot.resource_specific_logging +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
target_typestringThe target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.
target_namestringThe target name.
log_levelstringThe log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
target_idstringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource_specific_logging resourc Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md index ed8ba4a7f1..8794395be1 100644 --- a/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md +++ b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_specific_loggings in a region or create a resource_specific_loggings resource, use resource_specific_logging to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_specific_loggings in a region o Nameresource_specific_loggings TypeResource DescriptionResource-specific logging allows you to specify a logging level for a specific thing group. -Idaws.iot.resource_specific_loggings +Id ## Fields - - + +
NameDatatypeDescription
target_idstringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
regionstringAWS region.
stringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_specific_loggings in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/role_alias/index.md b/docs/aws-docs/providers/aws/iot/role_alias/index.md index 34b9f7bb65..6177185415 100644 --- a/docs/aws-docs/providers/aws/iot/role_alias/index.md +++ b/docs/aws-docs/providers/aws/iot/role_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual role_alias resource, use role_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual role_alias resource, use ro Namerole_alias TypeResource DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias. -Idaws.iot.role_alias +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
role_aliasstring
role_alias_arnstring
role_arnstring
credential_duration_secondsinteger
tagsarray
regionstringAWS region.
string
string
string
integer
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual role_alias resource, use ro Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/role_aliases/index.md b/docs/aws-docs/providers/aws/iot/role_aliases/index.md index db8c04d02d..e70012ee31 100644 --- a/docs/aws-docs/providers/aws/iot/role_aliases/index.md +++ b/docs/aws-docs/providers/aws/iot/role_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of role_aliases in a region or create a role_aliases resource, use role_alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of role_aliases in a region or create a Namerole_aliases TypeResource DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias. -Idaws.iot.role_aliases +Id ## Fields - - + +
NameDatatypeDescription
role_aliasstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of role_aliases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md index 451f368708..6844d3fec0 100644 --- a/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md +++ b/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scheduled_audit resource, use scheduled_audits to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual scheduled_audit resource, use Namescheduled_audit TypeResource DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run. -Idaws.iot.scheduled_audit +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
scheduled_audit_namestringThe name you want to give to the scheduled audit.
frequencystringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
day_of_monthstringThe day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
day_of_weekstringThe day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
target_check_namesarrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
scheduled_audit_arnstringThe ARN (Amazon resource name) of the scheduled audit.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual scheduled_audit resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md index e38eb3ccd3..b6c4564767 100644 --- a/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md +++ b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scheduled_audits in a region or create a scheduled_audits resource, use scheduled_audit to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scheduled_audits in a region or create a Namescheduled_audits TypeResource DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run. -Idaws.iot.scheduled_audits +Id ## Fields - - + +
NameDatatypeDescription
scheduled_audit_namestringThe name you want to give to the scheduled audit.
regionstringAWS region.
stringThe name you want to give to the scheduled audit.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scheduled_audits in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/security_profile/index.md b/docs/aws-docs/providers/aws/iot/security_profile/index.md index 48aa85b358..86203863bf 100644 --- a/docs/aws-docs/providers/aws/iot/security_profile/index.md +++ b/docs/aws-docs/providers/aws/iot/security_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_profile resource, use security_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual security_profile resource, use Namesecurity_profile TypeResource DescriptionA security profile defines a set of expected behaviors for devices in your account. -Idaws.iot.security_profile +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
security_profile_namestringA unique identifier for the security profile.
security_profile_descriptionstringA description of the security profile.
behaviorsarraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
alert_targetsobjectSpecifies the destinations to which alerts are sent.
additional_metrics_to_retain_v2arrayA list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
metrics_export_configobjectA structure containing the mqtt topic for metrics export.
tagsarrayMetadata that can be used to manage the security profile.
target_arnsarrayA set of target ARNs that the security profile is attached to.
security_profile_arnstringThe ARN (Amazon resource name) of the created security profile.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual security_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/security_profiles/index.md b/docs/aws-docs/providers/aws/iot/security_profiles/index.md index 90cde365f9..24f441e48c 100644 --- a/docs/aws-docs/providers/aws/iot/security_profiles/index.md +++ b/docs/aws-docs/providers/aws/iot/security_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_profiles in a region or create a security_profiles resource, use security_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_profiles in a region or create Namesecurity_profiles TypeResource DescriptionA security profile defines a set of expected behaviors for devices in your account. -Idaws.iot.security_profiles +Id ## Fields - - + +
NameDatatypeDescription
security_profile_namestringA unique identifier for the security profile.
regionstringAWS region.
stringA unique identifier for the security profile.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_profiles in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/software_package/index.md b/docs/aws-docs/providers/aws/iot/software_package/index.md index 87a05887cf..681ba1187e 100644 --- a/docs/aws-docs/providers/aws/iot/software_package/index.md +++ b/docs/aws-docs/providers/aws/iot/software_package/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual software_package resource, use software_packages to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual software_package resource, use Namesoftware_package TypeResource Descriptionresource definition -Idaws.iot.software_package +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstring
package_arnstring
package_namestring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual software_package resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/software_package_version/index.md b/docs/aws-docs/providers/aws/iot/software_package_version/index.md index c6cf440a89..a3e951c88f 100644 --- a/docs/aws-docs/providers/aws/iot/software_package_version/index.md +++ b/docs/aws-docs/providers/aws/iot/software_package_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual software_package_version resource, use software_package_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual software_package_version resource Namesoftware_package_version TypeResource Descriptionresource definition -Idaws.iot.software_package_version +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
attributesobject
descriptionstring
error_reasonstring
package_namestring
package_version_arnstring
statusstring
tagsarrayAn array of key-value pairs to apply to this resource.
version_namestring
regionstringAWS region.
object
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual software_package_version resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/software_package_versions/index.md b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md index 54059947f4..576e1fe033 100644 --- a/docs/aws-docs/providers/aws/iot/software_package_versions/index.md +++ b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of software_package_versions in a region or create a software_package_versions resource, use software_package_version to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of software_package_versions in a region or Namesoftware_package_versions TypeResource Descriptionresource definition -Idaws.iot.software_package_versions +Id ## Fields - - - + + +
NameDatatypeDescription
package_namestring
version_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of software_package_versions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/software_packages/index.md b/docs/aws-docs/providers/aws/iot/software_packages/index.md index e1aeb03e44..e21d7fe91a 100644 --- a/docs/aws-docs/providers/aws/iot/software_packages/index.md +++ b/docs/aws-docs/providers/aws/iot/software_packages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of software_packages in a region or create a software_packages resource, use software_package to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of software_packages in a region or create Namesoftware_packages TypeResource Descriptionresource definition -Idaws.iot.software_packages +Id ## Fields - - + +
NameDatatypeDescription
package_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of software_packages in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/thing/index.md b/docs/aws-docs/providers/aws/iot/thing/index.md index 91a9032443..809eb76bcb 100644 --- a/docs/aws-docs/providers/aws/iot/thing/index.md +++ b/docs/aws-docs/providers/aws/iot/thing/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual thing resource, use things to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual thing resource, use things< Namething TypeResource DescriptionResource Type definition for AWS::IoT::Thing -Idaws.iot.thing +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstring
arnstring
attribute_payloadobject
thing_namestring
regionstringAWS region.
string
string
object
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual thing resource, use things< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/thing_group/index.md b/docs/aws-docs/providers/aws/iot/thing_group/index.md index d18426259c..0c2b8fb927 100644 --- a/docs/aws-docs/providers/aws/iot/thing_group/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual thing_group resource, use thing_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual thing_group resource, use t Namething_group TypeResource DescriptionResource Type definition for AWS::IoT::ThingGroup -Idaws.iot.thing_group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
arnstring
thing_group_namestring
parent_group_namestring
query_stringstring
thing_group_propertiesobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual thing_group resource, use t Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/thing_groups/index.md b/docs/aws-docs/providers/aws/iot/thing_groups/index.md index c11b50bf81..76f4c84072 100644 --- a/docs/aws-docs/providers/aws/iot/thing_groups/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of thing_groups in a region or create a thing_groups resource, use thing_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of thing_groups in a region or create a Namething_groups TypeResource DescriptionResource Type definition for AWS::IoT::ThingGroup -Idaws.iot.thing_groups +Id ## Fields - - + +
NameDatatypeDescription
thing_group_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of thing_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/thing_type/index.md b/docs/aws-docs/providers/aws/iot/thing_type/index.md index f5857b0477..f827409ef9 100644 --- a/docs/aws-docs/providers/aws/iot/thing_type/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_type/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual thing_type resource, use thing_types to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual thing_type resource, use th Namething_type TypeResource DescriptionResource Type definition for AWS::IoT::ThingType -Idaws.iot.thing_type +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
arnstring
thing_type_namestring
deprecate_thing_typeboolean
thing_type_propertiesobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual thing_type resource, use th Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/thing_types/index.md b/docs/aws-docs/providers/aws/iot/thing_types/index.md index f7044a778d..3fbb080890 100644 --- a/docs/aws-docs/providers/aws/iot/thing_types/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_types/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of thing_types in a region or create a thing_types resource, use thing_type to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of thing_types in a region or create a Namething_types TypeResource DescriptionResource Type definition for AWS::IoT::ThingType -Idaws.iot.thing_types +Id ## Fields - - + +
NameDatatypeDescription
thing_type_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of thing_types in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/things/index.md b/docs/aws-docs/providers/aws/iot/things/index.md index ac61b05f28..fea924416d 100644 --- a/docs/aws-docs/providers/aws/iot/things/index.md +++ b/docs/aws-docs/providers/aws/iot/things/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of things in a region or create a things resource, use thing to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of things in a region or create a thi Namethings TypeResource DescriptionResource Type definition for AWS::IoT::Thing -Idaws.iot.things +Id ## Fields - - + +
NameDatatypeDescription
thing_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of things in a region or create a thi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule/index.md b/docs/aws-docs/providers/aws/iot/topic_rule/index.md index 379f073b1b..6b80eac308 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rule/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual topic_rule resource, use topic_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual topic_rule resource, use to Nametopic_rule TypeResource DescriptionResource Type definition for AWS::IoT::TopicRule -Idaws.iot.topic_rule +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstring
rule_namestring
topic_rule_payloadobject
tagsarray
regionstringAWS region.
string
string
object
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual topic_rule resource, use to Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md index 8011d10076..13b022954e 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual topic_rule_destination resource, use topic_rule_destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual topic_rule_destination resource, Nametopic_rule_destination TypeResource DescriptionResource Type definition for AWS::IoT::TopicRuleDestination -Idaws.iot.topic_rule_destination +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN).
statusstringThe status of the TopicRuleDestination.
http_url_propertiesobjectHTTP URL destination properties.
status_reasonstringThe reasoning for the current status of the TopicRuleDestination.
vpc_propertiesobjectVPC destination properties.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual topic_rule_destination resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md index dceb9b4549..ec0b8b509c 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of topic_rule_destinations in a region or create a topic_rule_destinations resource, use topic_rule_destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of topic_rule_destinations in a region or c Nametopic_rule_destinations TypeResource DescriptionResource Type definition for AWS::IoT::TopicRuleDestination -Idaws.iot.topic_rule_destinations +Id ## Fields - - + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN).
regionstringAWS region.
stringAmazon Resource Name (ARN).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of topic_rule_destinations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iot/topic_rules/index.md b/docs/aws-docs/providers/aws/iot/topic_rules/index.md index 3e00df85f3..ecddf02816 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rules/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of topic_rules in a region or create a topic_rules resource, use topic_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of topic_rules in a region or create a Nametopic_rules TypeResource DescriptionResource Type definition for AWS::IoT::TopicRule -Idaws.iot.topic_rules +Id ## Fields - - + +
NameDatatypeDescription
rule_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of topic_rules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md b/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md index 9e97df0171..620a663caa 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset resource, use datasets to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual dataset resource, use datas Namedataset TypeResource DescriptionResource Type definition for AWS::IoTAnalytics::Dataset -Idaws.iotanalytics.dataset +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
actionsarray
late_data_rulesarray
dataset_namestring
content_delivery_rulesarray
triggersarray
versioning_configurationobject
idstring
retention_periodobject
tagsarray
regionstringAWS region.
array
array
string
array
array
object
string
object
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual dataset resource, use datas Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md index 8b3dd5443d..4191760fde 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of datasets in a region or create a datasets resource, use dataset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of datasets in a region or create a d Namedatasets TypeResource DescriptionResource Type definition for AWS::IoTAnalytics::Dataset -Idaws.iotanalytics.datasets +Id ## Fields - - + +
NameDatatypeDescription
dataset_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of datasets in a region or create a d Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md index 381528d73e..c911bddf28 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pipeline resource, use pipelines to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual pipeline resource, use pipe Namepipeline TypeResource DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline -Idaws.iotanalytics.pipeline +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstring
pipeline_namestring
tagsarray
pipeline_activitiesarray
regionstringAWS region.
string
string
array
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual pipeline resource, use pipe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md index d608c26c42..b2d7582713 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pipelines in a region or create a pipelines resource, use pipeline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pipelines in a region or create a Namepipelines TypeResource DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline -Idaws.iotanalytics.pipelines +Id ## Fields - - + +
NameDatatypeDescription
pipeline_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pipelines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md index 970e57e48d..c13746b940 100644 --- a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual suite_definition resource, use suite_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual suite_definition resource, use Namesuite_definition TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.iotcoredeviceadvisor.suite_definition +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
suite_definition_configurationobject
suite_definition_idstringThe unique identifier for the suite definition.
suite_definition_arnstringThe Amazon Resource name for the suite definition.
suite_definition_versionstringThe suite definition version of a test suite.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual suite_definition resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md index 67cc405a0b..08cbf63b50 100644 --- a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of suite_definitions in a region or create a suite_definitions resource, use suite_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of suite_definitions in a region or create Namesuite_definitions TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.iotcoredeviceadvisor.suite_definitions +Id ## Fields - - + +
NameDatatypeDescription
suite_definition_idstringThe unique identifier for the suite definition.
regionstringAWS region.
stringThe unique identifier for the suite definition.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of suite_definitions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md index 4c3a78ee8d..2d5208a0ad 100644 --- a/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md +++ b/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alarm_model resource, use alarm_models to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual alarm_model resource, use a Namealarm_model TypeResource DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.<br/><br/>Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode. -Idaws.iotevents.alarm_model +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
alarm_model_namestringThe name of the alarm model.
alarm_model_descriptionstringA brief description of the alarm model.
role_arnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
keystringThe value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.<br/><br/>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.
severityintegerA non-negative integer that reflects the severity level of the alarm.<br/><br/>
alarm_ruleobject
alarm_event_actionsobject
alarm_capabilitiesobject
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
stringThe name of the alarm model.
stringA brief description of the alarm model.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
stringThe value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.<br/><br/>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.
integerA non-negative integer that reflects the severity level of the alarm.<br/><br/>
object
object
object
arrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual alarm_model resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md index 798070debf..3448045198 100644 --- a/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md +++ b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of alarm_models in a region or create a alarm_models resource, use alarm_model to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of alarm_models in a region or create a Namealarm_models TypeResource DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.<br/><br/>Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode. -Idaws.iotevents.alarm_models +Id ## Fields - - + +
NameDatatypeDescription
alarm_model_namestringThe name of the alarm model.
regionstringAWS region.
stringThe name of the alarm model.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of alarm_models in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_model/index.md b/docs/aws-docs/providers/aws/iotevents/detector_model/index.md index 730cedc037..16fcc232a4 100644 --- a/docs/aws-docs/providers/aws/iotevents/detector_model/index.md +++ b/docs/aws-docs/providers/aws/iotevents/detector_model/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual detector_model resource, use detector_models to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual detector_model resource, use Namedetector_model TypeResource DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*. -Idaws.iotevents.detector_model +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
detector_model_definitionobject
detector_model_descriptionstringA brief description of the detector model.
detector_model_namestringThe name of the detector model.
evaluation_methodstringInformation about the order in which events are evaluated and how actions are executed.
keystringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.<br/><br/>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
role_arnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
object
stringA brief description of the detector model.
stringThe name of the detector model.
stringInformation about the order in which events are evaluated and how actions are executed.
stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.<br/><br/>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
arrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual detector_model resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_models/index.md b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md index 7852b8e235..51e74ca6ff 100644 --- a/docs/aws-docs/providers/aws/iotevents/detector_models/index.md +++ b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of detector_models in a region or create a detector_models resource, use detector_model to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of detector_models in a region or create a Namedetector_models TypeResource DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*. -Idaws.iotevents.detector_models +Id ## Fields - - + +
NameDatatypeDescription
detector_model_namestringThe name of the detector model.
regionstringAWS region.
stringThe name of the detector model.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of detector_models in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotevents/input/index.md b/docs/aws-docs/providers/aws/iotevents/input/index.md index 61663322df..3b4d7c50c2 100644 --- a/docs/aws-docs/providers/aws/iotevents/input/index.md +++ b/docs/aws-docs/providers/aws/iotevents/input/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual input resource, use inputs to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual input resource, use inputs< Nameinput TypeResource DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*. -Idaws.iotevents.input +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
input_definitionobject
input_descriptionstringA brief description of the input.
input_namestringThe name of the input.
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
object
stringA brief description of the input.
stringThe name of the input.
arrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual input resource, use inputs< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotevents/inputs/index.md b/docs/aws-docs/providers/aws/iotevents/inputs/index.md index 9c8eff0234..14eb8bac11 100644 --- a/docs/aws-docs/providers/aws/iotevents/inputs/index.md +++ b/docs/aws-docs/providers/aws/iotevents/inputs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of inputs in a region or create a inputs resource, use input to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of inputs in a region or create a inp Nameinputs TypeResource DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*. -Idaws.iotevents.inputs +Id ## Fields - - + +
NameDatatypeDescription
input_namestringThe name of the input.
regionstringAWS region.
stringThe name of the input.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of inputs in a region or create a inp Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleethub/application/index.md b/docs/aws-docs/providers/aws/iotfleethub/application/index.md index 131b51e67d..688abce024 100644 --- a/docs/aws-docs/providers/aws/iotfleethub/application/index.md +++ b/docs/aws-docs/providers/aws/iotfleethub/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource schema for AWS::IoTFleetHub::Application -Idaws.iotfleethub.application +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
application_idstringThe ID of the application.
application_arnstringThe ARN of the application.
application_namestringApplication Name, should be between 1 and 256 characters.
application_descriptionstringApplication Description, should be between 1 and 2048 characters.
application_urlstringThe URL of the application.
application_statestringThe current state of the application.
application_creation_dateintegerWhen the Application was created
application_last_update_dateintegerWhen the Application was last updated
role_arnstringThe ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
sso_client_idstringThe AWS SSO application generated client ID (used with AWS SSO APIs).
error_messagestringA message indicating why Create or Delete Application failed.
tagsarrayA list of key-value pairs that contain metadata for the application.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleethub/applications/index.md b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md index 445582d4b9..e4510f828b 100644 --- a/docs/aws-docs/providers/aws/iotfleethub/applications/index.md +++ b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource schema for AWS::IoTFleetHub::Application -Idaws.iotfleethub.applications +Id ## Fields - - + +
NameDatatypeDescription
application_idstringThe ID of the application.
regionstringAWS region.
stringThe ID of the application.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md index 58d1853482..62e7b68081 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual campaign resource, use campaigns to retrieve a list of resources or to create a resource. ## Overview @@ -21,34 +24,34 @@ Gets or operates on an individual campaign resource, use camp Namecampaign TypeResource DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type -Idaws.iotfleetwise.campaign +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
statusstring
actionstring
creation_timestring
compressionstring
descriptionstring
priorityinteger
signals_to_collectarray
data_destination_configsarray
start_timestring
namestring
expiry_timestring
last_modification_timestring
spooling_modestring
signal_catalog_arnstring
post_trigger_collection_durationnumber
data_extra_dimensionsarray
diagnostics_modestring
target_arnstring
arnstring
collection_schemeundefined
tagsarray
regionstringAWS region.
string
string
string
string
string
integer
array
array
string
string
string
string
string
string
number
array
string
string
string
undefined
array
stringAWS region.
@@ -61,19 +64,19 @@ Gets or operates on an individual campaign resource, use camp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md index 42db852514..1452c8b604 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of campaigns in a region or create a campaigns resource, use campaign to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of campaigns in a region or create a Namecampaigns TypeResource DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type -Idaws.iotfleetwise.campaigns +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of campaigns in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md index 1e4bd35648..78d779460a 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual decoder_manifest resource, use decoder_manifests to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual decoder_manifest resource, use Namedecoder_manifest TypeResource DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type -Idaws.iotfleetwise.decoder_manifest +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
model_manifest_arnstring
namestring
network_interfacesarray
signal_decodersarray
statusstring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
array
array
string
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual decoder_manifest resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md index c9822d8783..c564d573a7 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of decoder_manifests in a region or create a decoder_manifests resource, use decoder_manifest to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of decoder_manifests in a region or create Namedecoder_manifests TypeResource DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type -Idaws.iotfleetwise.decoder_manifests +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of decoder_manifests in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md index 0307cf802b..c8fb98c350 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet resource, use fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual fleet resource, use fleets< Namefleet TypeResource DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type -Idaws.iotfleetwise.fleet +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
idstring
last_modification_timestring
signal_catalog_arnstring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual fleet resource, use fleets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md index 458ded4e40..554c28ac1f 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleets in a region or create a fleets resource, use fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleets in a region or create a fle Namefleets TypeResource DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type -Idaws.iotfleetwise.fleets +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleets in a region or create a fle Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md index 8bf5299f36..46d9a1d5f3 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_manifest resource, use model_manifests to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual model_manifest resource, use Namemodel_manifest TypeResource DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type -Idaws.iotfleetwise.model_manifest +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
nodesarray
signal_catalog_arnstring
statusstring
tagsarray
regionstringAWS region.
string
string
string
string
string
array
string
string
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual model_manifest resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md index 2f51ff45b2..ef667dbf0b 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_manifests in a region or create a model_manifests resource, use model_manifest to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_manifests in a region or create a Namemodel_manifests TypeResource DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type -Idaws.iotfleetwise.model_manifests +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_manifests in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md index d576493f42..dcce22a490 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual signal_catalog resource, use signal_catalogs to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual signal_catalog resource, use Namesignal_catalog TypeResource DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type -Idaws.iotfleetwise.signal_catalog +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
node_countsobject
nodesarray
tagsarray
regionstringAWS region.
string
string
string
string
string
object
array
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual signal_catalog resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md index 4d8781851e..02e0477a73 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of signal_catalogs in a region or create a signal_catalogs resource, use signal_catalog to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of signal_catalogs in a region or create a Namesignal_catalogs TypeResource DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type -Idaws.iotfleetwise.signal_catalogs +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of signal_catalogs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md index 161a6de56e..4ce60b4bf9 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vehicle resource, use vehicles to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual vehicle resource, use vehic Namevehicle TypeResource DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type -Idaws.iotfleetwise.vehicle +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
association_behaviorstring
attributesobject
creation_timestring
decoder_manifest_arnstring
namestring
last_modification_timestring
model_manifest_arnstring
tagsarray
regionstringAWS region.
string
string
object
string
string
string
string
string
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual vehicle resource, use vehic Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md index de5a5572fc..32997aa96b 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vehicles in a region or create a vehicles resource, use vehicle to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vehicles in a region or create a v Namevehicles TypeResource DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type -Idaws.iotfleetwise.vehicles +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vehicles in a region or create a v Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md index e19bbf6c1f..ea65995acc 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_policies in a region or create a access_policies resource, use access_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_policies in a region or create a Nameaccess_policies TypeResource DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy -Idaws.iotsitewise.access_policies +Id ## Fields - - + +
NameDatatypeDescription
access_policy_idstringThe ID of the access policy.
regionstringAWS region.
stringThe ID of the access policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md index 527dddb8f1..c7c656a68a 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_policy resource, use access_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual access_policy resource, use Nameaccess_policy TypeResource DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy -Idaws.iotsitewise.access_policy +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
access_policy_idstringThe ID of the access policy.
access_policy_arnstringThe ARN of the access policy.
access_policy_identityobjectThe identity for this access policy. Choose either a user or a group but not both.
access_policy_permissionstringThe permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
access_policy_resourceobjectThe AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual access_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset/index.md index 75cbc94953..edb824e0d0 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/asset/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/asset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual asset resource, use assets to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual asset resource, use assets< Nameasset TypeResource DescriptionResource schema for AWS::IoTSiteWise::Asset -Idaws.iotsitewise.asset +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
asset_idstringThe ID of the asset
asset_external_idstringThe External ID of the asset
asset_model_idstringThe ID of the asset model from which to create the asset.
asset_arnstringThe ARN of the asset
asset_namestringA unique, friendly name for the asset.
asset_descriptionstringA description for the asset
asset_propertiesarray
asset_hierarchiesarray
tagsarrayA list of key-value pairs that contain metadata for the asset.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual asset resource, use assets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md index 7931865caa..2ca866839e 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual asset_model resource, use asset_models to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual asset_model resource, use a Nameasset_model TypeResource DescriptionResource schema for AWS::IoTSiteWise::AssetModel -Idaws.iotsitewise.asset_model +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
asset_model_typestringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
asset_model_external_idstringThe external ID of the asset model.
asset_model_arnstringThe ARN of the asset model, which has the following format.
asset_model_namestringA unique, friendly name for the asset model.
asset_model_descriptionstringA description for the asset model.
asset_model_propertiesarrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
asset_model_composite_modelsarrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
asset_model_hierarchiesarrayThe hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual asset_model resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md index b5bb65f6c1..4882026c18 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of asset_models in a region or create a asset_models resource, use asset_model to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of asset_models in a region or create a Nameasset_models TypeResource DescriptionResource schema for AWS::IoTSiteWise::AssetModel -Idaws.iotsitewise.asset_models +Id ## Fields - - + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
regionstringAWS region.
stringThe ID of the asset model.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of asset_models in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/assets/index.md b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md index dad2635ed1..56b12a3f20 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/assets/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assets in a region or create a assets resource, use asset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assets in a region or create a ass Nameassets TypeResource DescriptionResource schema for AWS::IoTSiteWise::Asset -Idaws.iotsitewise.assets +Id ## Fields - - + +
NameDatatypeDescription
asset_idstringThe ID of the asset
regionstringAWS region.
stringThe ID of the asset
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assets in a region or create a ass Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md index 70ad9d95eb..eeea454b51 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dashboard resource, use dashboards to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual dashboard resource, use das Namedashboard TypeResource DescriptionResource schema for AWS::IoTSiteWise::Dashboard -Idaws.iotsitewise.dashboard +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
project_idstringThe ID of the project in which to create the dashboard.
dashboard_idstringThe ID of the dashboard.
dashboard_namestringA friendly name for the dashboard.
dashboard_descriptionstringA description for the dashboard.
dashboard_definitionstringThe dashboard definition specified in a JSON literal.
dashboard_arnstringThe ARN of the dashboard.
tagsarrayA list of key-value pairs that contain metadata for the dashboard.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual dashboard resource, use das Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md index 50e3b9a4e6..d95b15b82c 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dashboards in a region or create a dashboards resource, use dashboard to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dashboards in a region or create a Namedashboards TypeResource DescriptionResource schema for AWS::IoTSiteWise::Dashboard -Idaws.iotsitewise.dashboards +Id ## Fields - - + +
NameDatatypeDescription
dashboard_idstringThe ID of the dashboard.
regionstringAWS region.
stringThe ID of the dashboard.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dashboards in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md index 4ae887d7d1..37342944fd 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual gateway resource, use gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual gateway resource, use gatew Namegateway TypeResource DescriptionResource schema for AWS::IoTSiteWise::Gateway -Idaws.iotsitewise.gateway +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
gateway_namestringA unique, friendly name for the gateway.
gateway_platformobjectThe gateway's platform. You can only specify one platform in a gateway.
tagsarrayA list of key-value pairs that contain metadata for the gateway.
gateway_idstringThe ID of the gateway device.
gateway_capability_summariesarrayA list of gateway capability summaries that each contain a namespace and status.
regionstringAWS region.
stringA unique, friendly name for the gateway.
objectThe gateway's platform. You can only specify one platform in a gateway.
arrayA list of key-value pairs that contain metadata for the gateway.
stringThe ID of the gateway device.
arrayA list of gateway capability summaries that each contain a namespace and status.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual gateway resource, use gatew Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md index 51e15fcc1f..f38fae03a4 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of gateways in a region or create a gateways resource, use gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of gateways in a region or create a g Namegateways TypeResource DescriptionResource schema for AWS::IoTSiteWise::Gateway -Idaws.iotsitewise.gateways +Id ## Fields - - + +
NameDatatypeDescription
gateway_idstringThe ID of the gateway device.
regionstringAWS region.
stringThe ID of the gateway device.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of gateways in a region or create a g Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/portal/index.md b/docs/aws-docs/providers/aws/iotsitewise/portal/index.md index 67847d51ff..01b0b5bb8a 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/portal/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/portal/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual portal resource, use portals to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual portal resource, use portal Nameportal TypeResource DescriptionResource schema for AWS::IoTSiteWise::Portal -Idaws.iotsitewise.portal +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
portal_auth_modestringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
portal_arnstringThe ARN of the portal, which has the following format.
portal_client_idstringThe AWS SSO application generated client ID (used with AWS SSO APIs).
portal_contact_emailstringThe AWS administrator's contact email address.
portal_descriptionstringA description for the portal.
portal_idstringThe ID of the portal.
portal_namestringA friendly name for the portal.
portal_start_urlstringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
role_arnstringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
notification_sender_emailstringThe email address that sends alarm notifications.
alarmsobjectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
tagsarrayA list of key-value pairs that contain metadata for the portal.
regionstringAWS region.
stringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
stringThe ARN of the portal, which has the following format.
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringThe AWS administrator's contact email address.
stringA description for the portal.
stringThe ID of the portal.
stringA friendly name for the portal.
stringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
stringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
stringThe email address that sends alarm notifications.
objectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
arrayA list of key-value pairs that contain metadata for the portal.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual portal resource, use portal Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/portals/index.md b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md index 8ab1a702a4..2c2f581f63 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/portals/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of portals in a region or create a portals resource, use portal to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of portals in a region or create a po Nameportals TypeResource DescriptionResource schema for AWS::IoTSiteWise::Portal -Idaws.iotsitewise.portals +Id ## Fields - - + +
NameDatatypeDescription
portal_idstringThe ID of the portal.
regionstringAWS region.
stringThe ID of the portal.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of portals in a region or create a po Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/project/index.md b/docs/aws-docs/providers/aws/iotsitewise/project/index.md index 04a5bd5dc9..7d1396cd0c 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/project/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionResource schema for AWS::IoTSiteWise::Project -Idaws.iotsitewise.project +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
portal_idstringThe ID of the portal in which to create the project.
project_idstringThe ID of the project.
project_namestringA friendly name for the project.
project_descriptionstringA description for the project.
project_arnstringThe ARN of the project.
asset_idsarrayThe IDs of the assets to be associated to the project.
tagsarrayA list of key-value pairs that contain metadata for the project.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotsitewise/projects/index.md b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md index fe390f2392..9239c9fc76 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/projects/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionResource schema for AWS::IoTSiteWise::Project -Idaws.iotsitewise.projects +Id ## Fields - - + +
NameDatatypeDescription
project_idstringThe ID of the project.
regionstringAWS region.
stringThe ID of the project.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md index bb9de63ff5..1b46635834 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual component_type resource, use component_types to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual component_type resource, use Namecomponent_type TypeResource DescriptionResource schema for AWS::IoTTwinMaker::ComponentType -Idaws.iottwinmaker.component_type +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace that contains the component type.
component_type_idstringThe ID of the component type.
descriptionstringThe description of the component type.
extends_fromarraySpecifies the parent component type to extend.
functionsobjecta Map of functions in the component type. Each function's key must be unique to this map.
is_singletonbooleanA Boolean value that specifies whether an entity can have more than one component of this type.
property_definitionsobjectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
property_groupsobjectAn map of the property groups in the component type. Each property group's key must be unique to this map.
composite_component_typesobjectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
arnstringThe ARN of the component type.
creation_date_timestringThe date and time when the component type was created.
update_date_timestringThe last date and time when the component type was updated.
statusobjectThe current status of the component type.
is_abstractbooleanA Boolean value that specifies whether the component type is abstract.
is_schema_initializedbooleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
tagsobjectA map of key-value pairs to associate with a resource.
regionstringAWS region.
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual component_type resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md index d5e94a3e48..a832c8c031 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of component_types in a region or create a component_types resource, use component_type to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of component_types in a region or create a Namecomponent_types TypeResource DescriptionResource schema for AWS::IoTTwinMaker::ComponentType -Idaws.iottwinmaker.component_types +Id ## Fields - - - + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace that contains the component type.
component_type_idstringThe ID of the component type.
regionstringAWS region.
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of component_types in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md index 8825fc030a..62378d4c80 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of entities in a region or create a entities resource, use entity to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of entities in a region or create a e Nameentities TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Entity -Idaws.iottwinmaker.entities +Id ## Fields - - - + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
entity_idstringThe ID of the entity.
regionstringAWS region.
stringThe ID of the workspace.
stringThe ID of the entity.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of entities in a region or create a e Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md index 710317deac..d38a9197d9 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual entity resource, use entities to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual entity resource, use entiti Nameentity TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Entity -Idaws.iottwinmaker.entity +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
entity_idstringThe ID of the entity.
entity_namestringThe name of the entity.
statusobjectThe current status of the entity.
has_child_entitiesbooleanA Boolean value that specifies whether the entity has child entities or not.
parent_entity_idstringThe ID of the parent entity.
arnstringThe ARN of the entity.
descriptionstringThe description of the entity.
creation_date_timestringThe date and time when the entity was created.
update_date_timestringThe last date and time when the entity was updated.
tagsobjectA key-value pair to associate with a resource.
workspace_idstringThe ID of the workspace.
componentsobjectA map that sets information about a component type.
composite_componentsobjectA map that sets information about a composite component.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual entity resource, use entiti Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md index 2c7e01e92c..65fe52736c 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scene resource, use scenes to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual scene resource, use scenes< Namescene TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Scene -Idaws.iottwinmaker.scene +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
scene_idstringThe ID of the scene.
arnstringThe ARN of the scene.
descriptionstringThe description of the scene.
content_locationstringThe relative path that specifies the location of the content definition file.
creation_date_timestringThe date and time when the scene was created.
update_date_timestringThe date and time of the current update.
tagsobjectA key-value pair to associate with a resource.
workspace_idstringThe ID of the scene.
capabilitiesarrayA list of capabilities that the scene uses to render.
scene_metadataobjectA key-value pair of scene metadata for the scene.
generated_scene_metadataobjectA key-value pair of generated scene metadata for the scene.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual scene resource, use scenes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md index e00a327547..d8851ee502 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scenes in a region or create a scenes resource, use scene to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of scenes in a region or create a sce Namescenes TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Scene -Idaws.iottwinmaker.scenes +Id ## Fields - - - + + +
NameDatatypeDescription
workspace_idstringThe ID of the scene.
scene_idstringThe ID of the scene.
regionstringAWS region.
stringThe ID of the scene.
stringThe ID of the scene.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of scenes in a region or create a sce Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md index 7225ea5354..67be02fd57 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual sync_job resource, use sync_jobs to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual sync_job resource, use sync Namesync_job TypeResource DescriptionResource schema for AWS::IoTTwinMaker::SyncJob -Idaws.iottwinmaker.sync_job +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
sync_sourcestringThe source of the SyncJob.
sync_rolestringThe IAM Role that execute SyncJob.
creation_date_timestringThe date and time when the sync job was created.
update_date_timestringThe date and time when the sync job was updated.
arnstringThe ARN of the SyncJob.
statestringThe state of SyncJob.
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual sync_job resource, use sync Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md index 3bc163e023..3e86898852 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sync_jobs in a region or create a sync_jobs resource, use sync_job to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of sync_jobs in a region or create a Namesync_jobs TypeResource DescriptionResource schema for AWS::IoTTwinMaker::SyncJob -Idaws.iottwinmaker.sync_jobs +Id ## Fields - - - + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
sync_sourcestringThe source of the SyncJob.
regionstringAWS region.
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of sync_jobs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md index b41ea78230..37b942a374 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workspace resource, use workspaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual workspace resource, use wor Nameworkspace TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Workspace -Idaws.iottwinmaker.workspace +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
arnstringThe ARN of the workspace.
descriptionstringThe description of the workspace.
rolestringThe ARN of the execution role associated with the workspace.
s3_locationstringThe ARN of the S3 bucket where resources associated with the workspace are stored.
creation_date_timestringThe date and time when the workspace was created.
update_date_timestringThe date and time of the current update.
tagsobjectA map of key-value pairs to associate with a resource.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual workspace resource, use wor Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md index f022e4f2ed..bb06ec0c37 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workspaces in a region or create a workspaces resource, use workspace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workspaces in a region or create a Nameworkspaces TypeResource DescriptionResource schema for AWS::IoTTwinMaker::Workspace -Idaws.iottwinmaker.workspaces +Id ## Fields - - + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
regionstringAWS region.
stringThe ID of the workspace.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workspaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/destination/index.md b/docs/aws-docs/providers/aws/iotwireless/destination/index.md index 75ae8bb572..5294c1bd74 100644 --- a/docs/aws-docs/providers/aws/iotwireless/destination/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual destination resource, use destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual destination resource, use d Namedestination TypeResource DescriptionDestination's resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.destination +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringUnique name of destination
expressionstringDestination expression
expression_typestringMust be RuleName
descriptionstringDestination description
tagsarrayA list of key-value pairs that contain metadata for the destination.
role_arnstringAWS role ARN that grants access
arnstringDestination arn. Returned after successful create.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual destination resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/destinations/index.md b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md index d214539dd1..e566ca011f 100644 --- a/docs/aws-docs/providers/aws/iotwireless/destinations/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of destinations in a region or create a destinations resource, use destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of destinations in a region or create a Namedestinations TypeResource DescriptionDestination's resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.destinations +Id ## Fields - - + +
NameDatatypeDescription
namestringUnique name of destination
regionstringAWS region.
stringUnique name of destination
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of destinations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md index b4914d500b..5da1a83b6c 100644 --- a/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual device_profile resource, use device_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual device_profile resource, use Namedevice_profile TypeResource DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.device_profile +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wanobjectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
tagsarrayA list of key-value pairs that contain metadata for the device profile.
arnstringService profile Arn. Returned after successful create.
idstringService profile Id. Returned after successful create.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual device_profile resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md index ead7730214..73b2d384ce 100644 --- a/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of device_profiles in a region or create a device_profiles resource, use device_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of device_profiles in a region or create a Namedevice_profiles TypeResource DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.device_profiles +Id ## Fields - - + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
stringService profile Id. Returned after successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of device_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md index db9d4dc04f..44f668be76 100644 --- a/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fuota_task resource, use fuota_tasks to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual fuota_task resource, use fu Namefuota_task TypeResource DescriptionCreate and manage FUOTA tasks. -Idaws.iotwireless.fuota_task +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of FUOTA task
descriptionstringFUOTA task description
lo_ra_wanobjectFUOTA task LoRaWAN
firmware_update_imagestringFUOTA task firmware update image binary S3 link
firmware_update_rolestringFUOTA task firmware IAM role for reading S3
arnstringFUOTA task arn. Returned after successful create.
idstringFUOTA task id. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the FUOTA task.
fuota_task_statusstringFUOTA task status. Returned after successful read.
associate_wireless_devicestringWireless device to associate. Only for update request.
disassociate_wireless_devicestringWireless device to disassociate. Only for update request.
associate_multicast_groupstringMulticast group to associate. Only for update request.
disassociate_multicast_groupstringMulticast group to disassociate. Only for update request.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual fuota_task resource, use fu Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md index 026a268ef2..d2cfbe0dcf 100644 --- a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fuota_tasks in a region or create a fuota_tasks resource, use fuota_task to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fuota_tasks in a region or create a Namefuota_tasks TypeResource DescriptionCreate and manage FUOTA tasks. -Idaws.iotwireless.fuota_tasks +Id ## Fields - - + +
NameDatatypeDescription
idstringFUOTA task id. Returned after successful create.
regionstringAWS region.
stringFUOTA task id. Returned after successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fuota_tasks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md index 412c2e985e..d7ef121000 100644 --- a/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual multicast_group resource, use multicast_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual multicast_group resource, use Namemulticast_group TypeResource DescriptionCreate and manage Multicast groups. -Idaws.iotwireless.multicast_group +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringName of Multicast group
descriptionstringMulticast group description
lo_ra_wanobjectMulticast group LoRaWAN
arnstringMulticast group arn. Returned after successful create.
idstringMulticast group id. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the Multicast group.
statusstringMulticast group status. Returned after successful read.
associate_wireless_devicestringWireless device to associate. Only for update request.
disassociate_wireless_devicestringWireless device to disassociate. Only for update request.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual multicast_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md index 822509179d..4d7954c4b7 100644 --- a/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of multicast_groups in a region or create a multicast_groups resource, use multicast_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of multicast_groups in a region or create a Namemulticast_groups TypeResource DescriptionCreate and manage Multicast groups. -Idaws.iotwireless.multicast_groups +Id ## Fields - - + +
NameDatatypeDescription
idstringMulticast group id. Returned after successful create.
regionstringAWS region.
stringMulticast group id. Returned after successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of multicast_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md index b65d1ac659..a3d833778d 100644 --- a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_analyzer_configuration resource, use network_analyzer_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual network_analyzer_configuration re Namenetwork_analyzer_configuration TypeResource DescriptionCreate and manage NetworkAnalyzerConfiguration resource. -Idaws.iotwireless.network_analyzer_configuration +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringName of the network analyzer configuration
descriptionstringThe description of the new resource
trace_contentobjectTrace content for your wireless gateway and wireless device resources
wireless_devicesarrayList of wireless gateway resources that have been added to the network analyzer configuration
wireless_gatewaysarrayList of wireless gateway resources that have been added to the network analyzer configuration
arnstringArn for network analyzer configuration, Returned upon successful create.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual network_analyzer_configuration re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md index 8c33b0213b..ac84587df6 100644 --- a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of network_analyzer_configurations in a region or create a network_analyzer_configurations resource, use network_analyzer_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of network_analyzer_configurations in a reg Namenetwork_analyzer_configurations TypeResource DescriptionCreate and manage NetworkAnalyzerConfiguration resource. -Idaws.iotwireless.network_analyzer_configurations +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the network analyzer configuration
regionstringAWS region.
stringName of the network analyzer configuration
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of network_analyzer_configurations in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md index 4851a84701..a5e1733e54 100644 --- a/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual partner_account resource, use partner_accounts to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual partner_account resource, use Namepartner_account TypeResource DescriptionCreate and manage partner account -Idaws.iotwireless.partner_account +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
sidewalkobjectThe Sidewalk account credentials.
partner_account_idstringThe partner account ID to disassociate from the AWS account
partner_typestringThe partner type
sidewalk_responseobjectThe Sidewalk account credentials.
account_linkedbooleanWhether the partner account is linked to the AWS account.
sidewalk_updateobjectThe Sidewalk account credentials.
fingerprintstringThe fingerprint of the Sidewalk application server private key.
arnstringPartnerAccount arn. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the destination.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual partner_account resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md index 31d370e07a..7b90ea1b6d 100644 --- a/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of partner_accounts in a region or create a partner_accounts resource, use partner_account to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of partner_accounts in a region or create a Namepartner_accounts TypeResource DescriptionCreate and manage partner account -Idaws.iotwireless.partner_accounts +Id ## Fields - - + +
NameDatatypeDescription
partner_account_idstringThe partner account ID to disassociate from the AWS account
regionstringAWS region.
stringThe partner account ID to disassociate from the AWS account
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of partner_accounts in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md index 615c13a198..4b2afc3528 100644 --- a/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_profile resource, use service_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual service_profile resource, use Nameservice_profile TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.service_profile +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wanobjectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
tagsarrayA list of key-value pairs that contain metadata for the service profile.
arnstringService profile Arn. Returned after successful create.
idstringService profile Id. Returned after successful create.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual service_profile resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md index 924b08267d..e0147ec6cd 100644 --- a/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_profiles in a region or create a service_profiles resource, use service_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_profiles in a region or create a Nameservice_profiles TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.iotwireless.service_profiles +Id ## Fields - - + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
stringService profile Id. Returned after successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md index f902be1d01..ece15b9a78 100644 --- a/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual task_definition resource, use task_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual task_definition resource, use Nametask_definition TypeResource DescriptionCreates a gateway task definition. -Idaws.iotwireless.task_definition +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name of the new resource.
auto_create_tasksbooleanWhether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
updateobjectInformation about the gateways to update.
lo_ra_wan_update_gateway_task_entryobjectThe list of task definitions.
idstringThe ID of the new wireless gateway task definition
task_definition_typestringA filter to list only the wireless gateway task definitions that use this task definition type
arnstringTaskDefinition arn. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the destination.
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual task_definition resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md index 5a02b06cc2..34a1685d66 100644 --- a/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of task_definitions in a region or create a task_definitions resource, use task_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of task_definitions in a region or create a Nametask_definitions TypeResource DescriptionCreates a gateway task definition. -Idaws.iotwireless.task_definitions +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the new wireless gateway task definition
regionstringAWS region.
stringThe ID of the new wireless gateway task definition
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of task_definitions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md index 152e2224f2..bc065398ee 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual wireless_device resource, use wireless_devices to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual wireless_device resource, use Namewireless_device TypeResource DescriptionCreate and manage wireless gateways, including LoRa gateways. -Idaws.iotwireless.wireless_device +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
typestringWireless device type, currently only Sidewalk and LoRa
namestringWireless device name
descriptionstringWireless device description
destination_namestringWireless device destination name
lo_ra_wanobjectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
tagsarrayA list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.
arnstringWireless device arn. Returned after successful create.
idstringWireless device Id. Returned after successful create.
thing_arnstringThing arn. Passed into update to associate Thing with Wireless device.
thing_namestringThing Arn. If there is a Thing created, this can be returned with a Get call.
last_uplink_received_atstringThe date and time when the most recent uplink was received.
positioningstringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual wireless_device resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md index 05d911a776..beecd1ae24 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual wireless_device_import_task resource, use wireless_device_import_tasks to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual wireless_device_import_task resou Namewireless_device_import_task TypeResource DescriptionWireless Device Import Tasks -Idaws.iotwireless.wireless_device_import_task +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
idstringId for Wireless Device Import Task, Returned upon successful start.
arnstringArn for Wireless Device Import Task, Returned upon successful start.
destination_namestringDestination Name for import task
creation_datestringCreationDate for import task
sidewalkobjectsidewalk contain file for created device and role
statusstringStatus for import task
status_reasonstringStatusReason for import task
initialized_imported_devices_countintegerInitialized Imported Devices Count
pending_imported_devices_countintegerPending Imported Devices Count
onboarded_imported_devices_countintegerOnboarded Imported Devices Count
failed_imported_devices_countintegerFailed Imported Devices Count
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual wireless_device_import_task resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md index 09499d4efb..21d5de803a 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of wireless_device_import_tasks in a region or create a wireless_device_import_tasks resource, use wireless_device_import_task to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of wireless_device_import_tasks in a region Namewireless_device_import_tasks TypeResource DescriptionWireless Device Import Tasks -Idaws.iotwireless.wireless_device_import_tasks +Id ## Fields - - + +
NameDatatypeDescription
idstringId for Wireless Device Import Task, Returned upon successful start.
regionstringAWS region.
stringId for Wireless Device Import Task, Returned upon successful start.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of wireless_device_import_tasks in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md index 474b7afc1b..98bee22a12 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of wireless_devices in a region or create a wireless_devices resource, use wireless_device to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of wireless_devices in a region or create a Namewireless_devices TypeResource DescriptionCreate and manage wireless gateways, including LoRa gateways. -Idaws.iotwireless.wireless_devices +Id ## Fields - - + +
NameDatatypeDescription
idstringWireless device Id. Returned after successful create.
regionstringAWS region.
stringWireless device Id. Returned after successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of wireless_devices in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md index f3ed651247..99a10fd2cc 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual wireless_gateway resource, use wireless_gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual wireless_gateway resource, use Namewireless_gateway TypeResource DescriptionCreate and manage wireless gateways, including LoRa gateways. -Idaws.iotwireless.wireless_gateway +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringName of Wireless Gateway.
descriptionstringDescription of Wireless Gateway.
tagsarrayA list of key-value pairs that contain metadata for the gateway.
lo_ra_wanobjectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
arnstringArn for Wireless Gateway. Returned upon successful create.
idstringId for Wireless Gateway. Returned upon successful create.
thing_arnstringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
thing_namestringThing Name. If there is a Thing created, this can be returned with a Get call.
last_uplink_received_atstringThe date and time when the most recent uplink was received.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual wireless_gateway resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md index 6927fb5de3..5570ff7a28 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of wireless_gateways in a region or create a wireless_gateways resource, use wireless_gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of wireless_gateways in a region or create Namewireless_gateways TypeResource DescriptionCreate and manage wireless gateways, including LoRa gateways. -Idaws.iotwireless.wireless_gateways +Id ## Fields - - + +
NameDatatypeDescription
idstringId for Wireless Gateway. Returned upon successful create.
regionstringAWS region.
stringId for Wireless Gateway. Returned upon successful create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of wireless_gateways in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/channel/index.md b/docs/aws-docs/providers/aws/ivs/channel/index.md index 9e78406e55..6949053489 100644 --- a/docs/aws-docs/providers/aws/ivs/channel/index.md +++ b/docs/aws-docs/providers/aws/ivs/channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel resource, use channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual channel resource, use chann Namechannel TypeResource DescriptionResource Type definition for AWS::IVS::Channel -Idaws.ivs.channel +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
namestringChannel
authorizedbooleanWhether the channel is authorized.
insecure_ingestbooleanWhether the channel allows insecure ingest.
latency_modestringChannel latency mode.
typestringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
playback_urlstringChannel Playback URL.
ingest_endpointstringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
recording_configuration_arnstringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
presetstringOptional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual channel resource, use chann Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/channels/index.md b/docs/aws-docs/providers/aws/ivs/channels/index.md index 5b09c51b32..44cafb073d 100644 --- a/docs/aws-docs/providers/aws/ivs/channels/index.md +++ b/docs/aws-docs/providers/aws/ivs/channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channels in a region or create a channels resource, use channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channels in a region or create a c Namechannels TypeResource DescriptionResource Type definition for AWS::IVS::Channel -Idaws.ivs.channels +Id ## Fields - - + +
NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channels in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md index 41f0b991ad..0957146393 100644 --- a/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md +++ b/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual encoder_configuration resource, use encoder_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual encoder_configuration resource, u Nameencoder_configuration TypeResource DescriptionResource Type definition for AWS::IVS::EncoderConfiguration. -Idaws.ivs.encoder_configuration +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringEncoder configuration identifier.
videoobjectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
namestringEncoder configuration name.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual encoder_configuration resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md index b4fc6eb638..179b072162 100644 --- a/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of encoder_configurations in a region or create a encoder_configurations resource, use encoder_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of encoder_configurations in a region or cr Nameencoder_configurations TypeResource DescriptionResource Type definition for AWS::IVS::EncoderConfiguration. -Idaws.ivs.encoder_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringEncoder configuration identifier.
regionstringAWS region.
stringEncoder configuration identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of encoder_configurations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md index ae78115b8b..d8e3a6da97 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual playback_key_pair resource, use playback_key_pairs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual playback_key_pair resource, use < Nameplayback_key_pair TypeResource DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair -Idaws.ivs.playback_key_pair +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringAn arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
public_key_materialstringThe public portion of a customer-generated key pair.
fingerprintstringKey-pair identifier.
arnstringKey-pair identifier.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual playback_key_pair resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md index 8a6844c325..2f0ec03912 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of playback_key_pairs in a region or create a playback_key_pairs resource, use playback_key_pair to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of playback_key_pairs in a region or create Nameplayback_key_pairs TypeResource DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair -Idaws.ivs.playback_key_pairs +Id ## Fields - - + +
NameDatatypeDescription
arnstringKey-pair identifier.
regionstringAWS region.
stringKey-pair identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of playback_key_pairs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md index 3fab87f831..41b6d6f06f 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of playback_restriction_policies in a region or create a playback_restriction_policies resource, use playback_restriction_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of playback_restriction_policies in a regio Nameplayback_restriction_policies TypeResource DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy. -Idaws.ivs.playback_restriction_policies +Id ## Fields - - + +
NameDatatypeDescription
arnstringPlayback-restriction-policy identifier.
regionstringAWS region.
stringPlayback-restriction-policy identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of playback_restriction_policies in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md index 868978a2e9..8252aa49f4 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual playback_restriction_policy resource, use playback_restriction_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual playback_restriction_policy resou Nameplayback_restriction_policy TypeResource DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy. -Idaws.ivs.playback_restriction_policy +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstringPlayback-restriction-policy identifier.
allowed_countriesarrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
allowed_originsarrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
enable_strict_origin_enforcementbooleanWhether channel playback is constrained by origin site.
namestringPlayback-restriction-policy name.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual playback_restriction_policy resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md b/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md index da195e785d..bdba47b56f 100644 --- a/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md +++ b/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual recording_configuration resource, use recording_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual recording_configuration resource, Namerecording_configuration TypeResource DescriptionResource Type definition for AWS::IVS::RecordingConfiguration -Idaws.ivs.recording_configuration +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
namestringRecording Configuration Name.
statestringRecording Configuration State.
recording_reconnect_window_secondsintegerRecording Reconnect Window Seconds. (0 means disabled)
destination_configurationobject
tagsarrayA list of key-value pairs that contain metadata for the asset model.
thumbnail_configurationobject
rendition_configurationobject
regionstringAWS region.
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)
object
arrayA list of key-value pairs that contain metadata for the asset model.
object
object
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual recording_configuration resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md index 82d7360033..4546baacd3 100644 --- a/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of recording_configurations in a region or create a recording_configurations resource, use recording_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of recording_configurations in a region or Namerecording_configurations TypeResource DescriptionResource Type definition for AWS::IVS::RecordingConfiguration -Idaws.ivs.recording_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of recording_configurations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/stage/index.md b/docs/aws-docs/providers/aws/ivs/stage/index.md index 65437ad168..55824992bc 100644 --- a/docs/aws-docs/providers/aws/ivs/stage/index.md +++ b/docs/aws-docs/providers/aws/ivs/stage/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stage resource, use stages to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual stage resource, use stages< Namestage TypeResource DescriptionResource Definition for type AWS::IVS::Stage. -Idaws.ivs.stage +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringStage ARN is automatically generated on creation and assigned as the unique identifier.
namestringStage name
tagsarrayAn array of key-value pairs to apply to this resource.
active_session_idstringID of the active session within the stage.
regionstringAWS region.
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringStage name
arrayAn array of key-value pairs to apply to this resource.
stringID of the active session within the stage.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual stage resource, use stages< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/stages/index.md b/docs/aws-docs/providers/aws/ivs/stages/index.md index 0000e297cb..c36a440673 100644 --- a/docs/aws-docs/providers/aws/ivs/stages/index.md +++ b/docs/aws-docs/providers/aws/ivs/stages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stages in a region or create a stages resource, use stage to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stages in a region or create a sta Namestages TypeResource DescriptionResource Definition for type AWS::IVS::Stage. -Idaws.ivs.stages +Id ## Fields - - + +
NameDatatypeDescription
arnstringStage ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of stages in a region or create a sta Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md b/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md index 9d67e7db38..597c05581f 100644 --- a/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md +++ b/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual storage_configuration resource, use storage_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual storage_configuration resource, u Namestorage_configuration TypeResource DescriptionResource Type definition for AWS::IVS::StorageConfiguration -Idaws.ivs.storage_configuration +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
namestringStorage Configuration Name.
s3object
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringStorage Configuration Name.
object
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual storage_configuration resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md index 1d28f7d142..7b5466a039 100644 --- a/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of storage_configurations in a region or create a storage_configurations resource, use storage_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of storage_configurations in a region or cr Namestorage_configurations TypeResource DescriptionResource Type definition for AWS::IVS::StorageConfiguration -Idaws.ivs.storage_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of storage_configurations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivs/stream_key/index.md b/docs/aws-docs/providers/aws/ivs/stream_key/index.md index 78dc0fff89..d456316cc6 100644 --- a/docs/aws-docs/providers/aws/ivs/stream_key/index.md +++ b/docs/aws-docs/providers/aws/ivs/stream_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stream_key resource, use stream_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual stream_key resource, use st Namestream_key TypeResource DescriptionResource Type definition for AWS::IVS::StreamKey -Idaws.ivs.stream_key +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
channel_arnstringChannel ARN for the stream.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
valuestringStream-key value.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual stream_key resource, use st Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivs/stream_keys/index.md b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md index f526feea18..2c3cd73412 100644 --- a/docs/aws-docs/providers/aws/ivs/stream_keys/index.md +++ b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stream_keys in a region or create a stream_keys resource, use stream_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stream_keys in a region or create a Namestream_keys TypeResource DescriptionResource Type definition for AWS::IVS::StreamKey -Idaws.ivs.stream_keys +Id ## Fields - - + +
NameDatatypeDescription
arnstringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of stream_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md index 2b4d1b41ec..9e97632510 100644 --- a/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md +++ b/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual logging_configuration resource, use logging_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual logging_configuration resource, u Namelogging_configuration TypeResource DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration. -Idaws.ivschat.logging_configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
idstringThe system-generated ID of the logging configuration.
destination_configurationobject
namestringThe name of the logging configuration. The value does not need to be unique.
statestringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the logging configuration.
object
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual logging_configuration resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md index 7e4142e913..9c2faa61db 100644 --- a/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of logging_configurations in a region or create a logging_configurations resource, use logging_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of logging_configurations in a region or cr Namelogging_configurations TypeResource DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration. -Idaws.ivschat.logging_configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of logging_configurations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ivschat/room/index.md b/docs/aws-docs/providers/aws/ivschat/room/index.md index b5b16d4e04..7ad4e9e22a 100644 --- a/docs/aws-docs/providers/aws/ivschat/room/index.md +++ b/docs/aws-docs/providers/aws/ivschat/room/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual room resource, use rooms to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual room resource, use roomsNameroom TypeResource DescriptionResource type definition for AWS::IVSChat::Room. -Idaws.ivschat.room +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringRoom ARN is automatically generated on creation and assigned as the unique identifier.
idstringThe system-generated ID of the room.
namestringThe name of the room. The value does not need to be unique.
logging_configuration_identifiersarrayArray of logging configuration identifiers attached to the room.
maximum_message_lengthintegerThe maximum number of characters in a single message.
maximum_message_rate_per_secondintegerThe maximum number of messages per second that can be sent to the room.
message_review_handlerobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual room resource, use roomsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ivschat/rooms/index.md b/docs/aws-docs/providers/aws/ivschat/rooms/index.md index 8ef7a1b61c..7381b63f02 100644 --- a/docs/aws-docs/providers/aws/ivschat/rooms/index.md +++ b/docs/aws-docs/providers/aws/ivschat/rooms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rooms in a region or create a rooms resource, use room to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rooms in a region or create a room Namerooms TypeResource DescriptionResource type definition for AWS::IVSChat::Room. -Idaws.ivschat.rooms +Id ## Fields - - + +
NameDatatypeDescription
arnstringRoom ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rooms in a region or create a room Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md index 62cd801924..11eaf526e4 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connector resource, use connectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual connector resource, use con Nameconnector TypeResource DescriptionResource Type definition for AWS::KafkaConnect::Connector -Idaws.kafkaconnect.connector +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
capacityobject
connector_arnstringAmazon Resource Name for the created Connector.
connector_configurationobjectThe configuration for the connector.
connector_descriptionstringA summary description of the connector.
connector_namestringThe name of the connector.
kafka_clusterobject
kafka_cluster_client_authenticationobject
kafka_cluster_encryption_in_transitobject
kafka_connect_versionstringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
log_deliveryobject
pluginsarrayList of plugins to use with the connector.
service_execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
tagsarrayA collection of tags associated with a resource
worker_configurationobject
regionstringAWS region.
object
stringAmazon Resource Name for the created Connector.
objectThe configuration for the connector.
stringA summary description of the connector.
stringThe name of the connector.
object
object
object
stringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
object
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
object
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual connector resource, use con Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md index d983f22cc5..09bc96ae07 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connectors in a region or create a connectors resource, use connector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connectors in a region or create a Nameconnectors TypeResource DescriptionResource Type definition for AWS::KafkaConnect::Connector -Idaws.kafkaconnect.connectors +Id ## Fields - - + +
NameDatatypeDescription
connector_arnstringAmazon Resource Name for the created Connector.
regionstringAWS region.
stringAmazon Resource Name for the created Connector.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md index 5092c56164..1ea693994c 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual custom_plugin resource, use custom_plugins to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual custom_plugin resource, use Namecustom_plugin TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.kafkaconnect.custom_plugin +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name of the custom plugin.
descriptionstringA summary description of the custom plugin.
custom_plugin_arnstringThe Amazon Resource Name (ARN) of the custom plugin to use.
content_typestringThe type of the plugin file.
file_descriptionobject
locationobject
revisionintegerThe revision of the custom plugin.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
object
object
integerThe revision of the custom plugin.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual custom_plugin resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md index b929bf858e..76d9cb91da 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of custom_plugins in a region or create a custom_plugins resource, use custom_plugin to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of custom_plugins in a region or create a < Namecustom_plugins TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.kafkaconnect.custom_plugins +Id ## Fields - - + +
NameDatatypeDescription
custom_plugin_arnstringThe Amazon Resource Name (ARN) of the custom plugin to use.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of custom_plugins in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md index 6e9a3dfcf0..7e5f28f93b 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual worker_configuration resource, use worker_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual worker_configuration resource, us Nameworker_configuration TypeResource DescriptionThe configuration of the workers, which are the processes that run the connector logic. -Idaws.kafkaconnect.worker_configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name of the worker configuration.
descriptionstringA summary description of the worker configuration.
worker_configuration_arnstringThe Amazon Resource Name (ARN) of the custom configuration.
properties_file_contentstringBase64 encoded contents of connect-distributed.properties file.
revisionintegerThe description of a revision of the worker configuration.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual worker_configuration resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md index b2652c84bc..52473e3b5e 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of worker_configurations in a region or create a worker_configurations resource, use worker_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of worker_configurations in a region or cre Nameworker_configurations TypeResource DescriptionThe configuration of the workers, which are the processes that run the connector logic. -Idaws.kafkaconnect.worker_configurations +Id ## Fields - - + +
NameDatatypeDescription
worker_configuration_arnstringThe Amazon Resource Name (ARN) of the custom configuration.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of worker_configurations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kendra/data_source/index.md b/docs/aws-docs/providers/aws/kendra/data_source/index.md index 633db02689..2320c75a64 100644 --- a/docs/aws-docs/providers/aws/kendra/data_source/index.md +++ b/docs/aws-docs/providers/aws/kendra/data_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_source resource, use data_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual data_source resource, use d Namedata_source TypeResource DescriptionKendra DataSource -Idaws.kendra.data_source +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestring
index_idstring
typestring
data_source_configurationobject
descriptionstring
schedulestring
role_arnstring
tagsarrayTags for labeling the data source
custom_document_enrichment_configurationobject
language_codestring
regionstringAWS region.
string
string
string
string
string
object
string
string
string
arrayTags for labeling the data source
object
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual data_source resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kendra/data_sources/index.md b/docs/aws-docs/providers/aws/kendra/data_sources/index.md index cee00d143b..415f4c7aa4 100644 --- a/docs/aws-docs/providers/aws/kendra/data_sources/index.md +++ b/docs/aws-docs/providers/aws/kendra/data_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_sources in a region or create a data_sources resource, use data_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of data_sources in a region or create a Namedata_sources TypeResource DescriptionKendra DataSource -Idaws.kendra.data_sources +Id ## Fields - - - + + +
NameDatatypeDescription
idundefined
index_idundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of data_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kendra/faq/index.md b/docs/aws-docs/providers/aws/kendra/faq/index.md index bde72c3909..e8606fe71e 100644 --- a/docs/aws-docs/providers/aws/kendra/faq/index.md +++ b/docs/aws-docs/providers/aws/kendra/faq/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual faq resource, use faqs to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual faq resource, use faqsNamefaq TypeResource DescriptionA Kendra FAQ resource -Idaws.kendra.faq +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
idstring
index_idstringIndex ID
namestringFAQ name
descriptionstringFAQ description
file_formatstringFAQ file format
s3_pathobjectFAQ S3 path
role_arnstringFAQ role ARN
tagsarrayTags for labeling the FAQ
arnstring
language_codestring
regionstringAWS region.
string
stringIndex ID
stringFAQ name
stringFAQ description
stringFAQ file format
objectFAQ S3 path
stringFAQ role ARN
arrayTags for labeling the FAQ
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual faq resource, use faqsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kendra/faqs/index.md b/docs/aws-docs/providers/aws/kendra/faqs/index.md index 60e46a6a2d..19d7791713 100644 --- a/docs/aws-docs/providers/aws/kendra/faqs/index.md +++ b/docs/aws-docs/providers/aws/kendra/faqs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of faqs in a region or create a faqs resource, use faq to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of faqs in a region or create a faqs< Namefaqs TypeResource DescriptionA Kendra FAQ resource -Idaws.kendra.faqs +Id ## Fields - - - + + +
NameDatatypeDescription
idundefined
index_idundefinedIndex ID
regionstringAWS region.
undefined
undefinedIndex ID
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of faqs in a region or create a faqs< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kendra/index/index.md b/docs/aws-docs/providers/aws/kendra/index/index.md index eebc0bcfb6..f5cb1c8945 100644 --- a/docs/aws-docs/providers/aws/kendra/index/index.md +++ b/docs/aws-docs/providers/aws/kendra/index/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual index resource, use indices to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual index resource, use indices Nameindex TypeResource DescriptionA Kendra index -Idaws.kendra.index +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
descriptionstringA description for the index
server_side_encryption_configurationobjectServer side encryption configuration
tagsarrayTags for labeling the index
namestring
role_arnstring
editionstring
document_metadata_configurationsarrayDocument metadata configurations
capacity_unitsobjectCapacity units
user_context_policystring
user_token_configurationsarray
regionstringAWS region.
string
string
stringA description for the index
objectServer side encryption configuration
arrayTags for labeling the index
string
string
string
arrayDocument metadata configurations
objectCapacity units
string
array
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual index resource, use indices Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kendra/indices/index.md b/docs/aws-docs/providers/aws/kendra/indices/index.md index c86a0ed93b..d3e7e94155 100644 --- a/docs/aws-docs/providers/aws/kendra/indices/index.md +++ b/docs/aws-docs/providers/aws/kendra/indices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of indices in a region or create a indices resource, use index to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of indices in a region or create a in Nameindices TypeResource DescriptionA Kendra index -Idaws.kendra.indices +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of indices in a region or create a in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md index 8778808c9e..75ab23fdbd 100644 --- a/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual execution_plan resource, use execution_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual execution_plan resource, use Nameexecution_plan TypeResource DescriptionA KendraRanking Rescore execution plan -Idaws.kendraranking.execution_plan +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
arnstring
descriptionstringA description for the execution plan
tagsarrayTags for labeling the execution plan
namestring
capacity_unitsobjectCapacity units
regionstringAWS region.
string
string
stringA description for the execution plan
arrayTags for labeling the execution plan
string
objectCapacity units
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual execution_plan resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md index 7379b07758..6ab18d267b 100644 --- a/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of execution_plans in a region or create a execution_plans resource, use execution_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of execution_plans in a region or create a Nameexecution_plans TypeResource DescriptionA KendraRanking Rescore execution plan -Idaws.kendraranking.execution_plans +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of execution_plans in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md b/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md index bc58718633..90b6482cd9 100644 --- a/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md +++ b/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual kinesis_stream resource, use kinesis_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual kinesis_stream resource, use Namekinesis_stream TypeResource DescriptionResource Type definition for AWS::Kinesis::Stream -Idaws.kinesis.kinesis_stream +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
stream_mode_detailsobjectThe mode in which the stream is running.
stream_encryptionobjectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
arnstringThe Amazon resource name (ARN) of the Kinesis stream
retention_period_hoursintegerThe number of hours for the data records that are stored in shards to remain accessible.
tagsarrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
namestringThe name of the Kinesis stream.
shard_countintegerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual kinesis_stream resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kinesis/streams/index.md b/docs/aws-docs/providers/aws/kinesis/streams/index.md index 4060c94f6b..d08b19c7f6 100644 --- a/docs/aws-docs/providers/aws/kinesis/streams/index.md +++ b/docs/aws-docs/providers/aws/kinesis/streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of streams in a region or create a streams resource, use stream to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of streams in a region or create a st Namestreams TypeResource DescriptionResource Type definition for AWS::Kinesis::Stream -Idaws.kinesis.streams +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the Kinesis stream.
regionstringAWS region.
stringThe name of the Kinesis stream.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of streams in a region or create a st Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md index 2133ce8feb..96a653a8ec 100644 --- a/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html). -Idaws.kinesisanalyticsv2.application +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
application_configurationobjectUse this parameter to configure the application.
application_descriptionstringThe description of the application.
application_modestringTo create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.
application_namestringThe name of the application.
runtime_environmentstringThe runtime environment for the application.
service_execution_rolestringSpecifies the IAM role that the application uses to access external resources.
run_configurationobjectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
application_maintenance_configurationobjectUsed to configure start of maintenance window.
tagsarrayA list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md index e2ddd8f916..69eee84dc6 100644 --- a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html). -Idaws.kinesisanalyticsv2.applications +Id ## Fields - - + +
NameDatatypeDescription
application_namestringThe name of the application.
regionstringAWS region.
stringThe name of the application.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md index 10b7354940..3866408313 100644 --- a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual delivery_stream resource, use delivery_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual delivery_stream resource, use Namedelivery_stream TypeResource DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream -Idaws.kinesisfirehose.delivery_stream +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
delivery_stream_encryption_configuration_inputobject
delivery_stream_namestring
delivery_stream_typestring
elasticsearch_destination_configurationobject
amazonopensearchservice_destination_configurationobject
amazon_open_search_serverless_destination_configurationobject
extended_s3_destination_configurationobject
kinesis_stream_source_configurationobject
msk_source_configurationobject
redshift_destination_configurationobject
s3_destination_configurationobject
splunk_destination_configurationobject
http_endpoint_destination_configurationobject
snowflake_destination_configurationobject
tagsarray
regionstringAWS region.
string
object
string
string
object
object
object
object
object
object
object
object
object
object
object
array
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual delivery_stream resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md index edcf9c9662..01148e5a29 100644 --- a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of delivery_streams in a region or create a delivery_streams resource, use delivery_stream to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of delivery_streams in a region or create a Namedelivery_streams TypeResource DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream -Idaws.kinesisfirehose.delivery_streams +Id ## Fields - - + +
NameDatatypeDescription
delivery_stream_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of delivery_streams in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md b/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md index 7995d49f23..a9bb1d63b2 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual kinesisvideo_stream resource, use kinesisvideo_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual kinesisvideo_stream resource, use Namekinesisvideo_stream TypeResource DescriptionResource Type Definition for AWS::KinesisVideo::Stream -Idaws.kinesisvideo.kinesisvideo_stream +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the Kinesis Video stream.
namestringThe name of the Kinesis Video stream.
data_retention_in_hoursintegerThe number of hours till which Kinesis Video will retain the data in the stream
device_namestringThe name of the device that is writing to the stream.
kms_key_idstringAWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
media_typestringThe media type of the stream. Consumers of the stream can use this information when processing the stream.
tagsarrayAn array of key-value pairs associated with the Kinesis Video Stream.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual kinesisvideo_stream resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md index eff27a0999..1aaaef02f7 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual signaling_channel resource, use signaling_channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual signaling_channel resource, use < Namesignaling_channel TypeResource DescriptionResource Type Definition for AWS::KinesisVideo::SignalingChannel -Idaws.kinesisvideo.signaling_channel +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
namestringThe name of the Kinesis Video Signaling Channel.
typestringThe type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
message_ttl_secondsintegerThe period of time a signaling channel retains undelivered messages before they are discarded.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual signaling_channel resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md index 2d7e350ad7..fcd7ca6f67 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of signaling_channels in a region or create a signaling_channels resource, use signaling_channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of signaling_channels in a region or create Namesignaling_channels TypeResource DescriptionResource Type Definition for AWS::KinesisVideo::SignalingChannel -Idaws.kinesisvideo.signaling_channels +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the Kinesis Video Signaling Channel.
regionstringAWS region.
stringThe name of the Kinesis Video Signaling Channel.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of signaling_channels in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md index 258595cdde..4e8e40f7cd 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of streams in a region or create a streams resource, use stream to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of streams in a region or create a st Namestreams TypeResource DescriptionResource Type Definition for AWS::KinesisVideo::Stream -Idaws.kinesisvideo.streams +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the Kinesis Video stream.
regionstringAWS region.
stringThe name of the Kinesis Video stream.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of streams in a region or create a st Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kms/alias/index.md b/docs/aws-docs/providers/aws/kms/alias/index.md index 6c75788023..1b34aea206 100644 --- a/docs/aws-docs/providers/aws/kms/alias/index.md +++ b/docs/aws-docs/providers/aws/kms/alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alias resource, use aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual alias resource, use aliases Namealias TypeResource DescriptionThe ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).<br/> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i -Idaws.kms.alias +Id ## Fields - - - + + +
NameDatatypeDescription
target_key_idstringAssociates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.<br/> A valid key ID is required. If you supply a null or empty string value, this operation returns an error.<br/> For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.<br/> Specify the key ID or the key ARN of the KMS key.<br/> For example:<br/> + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> <br/> To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).
alias_namestringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).<br/> The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
regionstringAWS region.
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.<br/> A valid key ID is required. If you supply a null or empty string value, this operation returns an error.<br/> For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.<br/> Specify the key ID or the key ARN of the KMS key.<br/> For example:<br/> + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> <br/> To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).
stringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).<br/> The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual alias resource, use aliases Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kms/aliases/index.md b/docs/aws-docs/providers/aws/kms/aliases/index.md index 6e79940f61..248d85c108 100644 --- a/docs/aws-docs/providers/aws/kms/aliases/index.md +++ b/docs/aws-docs/providers/aws/kms/aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of aliases in a region or create a aliases resource, use alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of aliases in a region or create a al Namealiases TypeResource DescriptionThe ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).<br/> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i -Idaws.kms.aliases +Id ## Fields - - + +
NameDatatypeDescription
alias_namestringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).<br/> The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
regionstringAWS region.
stringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).<br/> The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of aliases in a region or create a al Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kms/key/index.md b/docs/aws-docs/providers/aws/kms/key/index.md index ff42e1aada..fe4f753aa8 100644 --- a/docs/aws-docs/providers/aws/kms/key/index.md +++ b/docs/aws-docs/providers/aws/kms/key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual key resource, use keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual key resource, use keysNamekey TypeResource DescriptionThe ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.<br/> If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.<br/> KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.<br/> You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.<br/> You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.<br/> You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.<br/> You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).<br/> *Regions*<br/> KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region. -Idaws.kms.key +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.
enabledbooleanSpecifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.<br/> When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.<br/> The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.<br/> For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.
enable_key_rotationbooleanEnables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.<br/> KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.<br/> To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.<br/> When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
key_policyobjectThe key policy to attach to the KMS key.<br/> If you provide a key policy, it must meet the following criteria:<br/> + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)<br/> + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.<br/> <br/> If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.<br/> A key policy document can include only the following characters:<br/> + Printable ASCII characters<br/> + Printable characters in the Basic Latin and Latin-1 Supplement character set<br/> + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters<br/> <br/> *Minimum*: ``1``<br/> *Maximum*: ``32768``
key_usagestringDetermines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.<br/> If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> Select only one valid value.<br/> + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.<br/> + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.
originstringThe source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.<br/> To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.<br/> You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. <br/> CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.
key_specstringSpecifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.<br/> The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.<br/> If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.<br/> KMS supports the following key specs for KMS keys:<br/> + Symmetric encryption key (default)<br/> + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)<br/> <br/> + HMAC keys (symmetric)<br/> + ``HMAC_224`` <br/> + ``HMAC_256`` <br/> + ``HMAC_384`` <br/> + ``HMAC_512`` <br/> <br/> + Asymmetric RSA key pairs<br/> + ``RSA_2048`` <br/> + ``RSA_3072`` <br/> + ``RSA_4096`` <br/> <br/> + Asymmetric NIST-recommended elliptic curve key pairs<br/> + ``ECC_NIST_P256`` (secp256r1)<br/> + ``ECC_NIST_P384`` (secp384r1)<br/> + ``ECC_NIST_P521`` (secp521r1)<br/> <br/> + Other asymmetric elliptic curve key pairs<br/> + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.<br/> <br/> + SM2 key pairs (China Regions only)<br/> + ``SM2``
multi_regionbooleanCreates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created.<br/> For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.<br/> If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.<br/> *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.<br/> To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
pending_window_in_daysintegerSpecifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.<br/> When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.<br/> KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.<br/> You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.<br/> For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
tagsarrayAssigns one or more tags to the replica key.<br/> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
arnstring
key_idstring
bypass_policy_lockout_safety_checkbooleanSkips ("bypasses") the key policy lockout safety check. The default value is false.<br/> Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.<br/> For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.<br/> Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.
rotation_period_in_daysinteger
regionstringAWS region.
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.<br/> When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.<br/> The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.<br/> For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.
booleanEnables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.<br/> KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.<br/> To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.<br/> When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
objectThe key policy to attach to the KMS key.<br/> If you provide a key policy, it must meet the following criteria:<br/> + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)<br/> + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.<br/> <br/> If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.<br/> A key policy document can include only the following characters:<br/> + Printable ASCII characters<br/> + Printable characters in the Basic Latin and Latin-1 Supplement character set<br/> + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters<br/> <br/> *Minimum*: ``1``<br/> *Maximum*: ``32768``
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.<br/> If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> Select only one valid value.<br/> + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.<br/> + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.
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.<br/> To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.<br/> You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. <br/> CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.
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*.<br/> The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.<br/> If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.<br/> KMS supports the following key specs for KMS keys:<br/> + Symmetric encryption key (default)<br/> + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)<br/> <br/> + HMAC keys (symmetric)<br/> + ``HMAC_224`` <br/> + ``HMAC_256`` <br/> + ``HMAC_384`` <br/> + ``HMAC_512`` <br/> <br/> + Asymmetric RSA key pairs<br/> + ``RSA_2048`` <br/> + ``RSA_3072`` <br/> + ``RSA_4096`` <br/> <br/> + Asymmetric NIST-recommended elliptic curve key pairs<br/> + ``ECC_NIST_P256`` (secp256r1)<br/> + ``ECC_NIST_P384`` (secp384r1)<br/> + ``ECC_NIST_P521`` (secp521r1)<br/> <br/> + Other asymmetric elliptic curve key pairs<br/> + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.<br/> <br/> + SM2 key pairs (China Regions only)<br/> + ``SM2``
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.<br/> For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.<br/> If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.<br/> For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.<br/> *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.<br/> To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
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.<br/> When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.<br/> KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.<br/> You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.<br/> For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
arrayAssigns one or more tags to the replica key.<br/> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
string
string
booleanSkips ("bypasses") the key policy lockout safety check. The default value is false.<br/> Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.<br/> For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.<br/> Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.
integer
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual key resource, use keysRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kms/keys/index.md b/docs/aws-docs/providers/aws/kms/keys/index.md index bf4f088735..0ec2677cb1 100644 --- a/docs/aws-docs/providers/aws/kms/keys/index.md +++ b/docs/aws-docs/providers/aws/kms/keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of keys in a region or create a keys resource, use key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of keys in a region or create a keys< Namekeys TypeResource DescriptionThe ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.<br/> If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.<br/> KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.<br/> You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.<br/> You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.<br/> You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.<br/> You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).<br/> *Regions*<br/> KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region. -Idaws.kms.keys +Id ## Fields - - + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of keys in a region or create a keys< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/kms/replica_key/index.md b/docs/aws-docs/providers/aws/kms/replica_key/index.md index 3f0a499652..2e570b0577 100644 --- a/docs/aws-docs/providers/aws/kms/replica_key/index.md +++ b/docs/aws-docs/providers/aws/kms/replica_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual replica_key resource, use replica_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual replica_key resource, use r Namereplica_key TypeResource DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS). -Idaws.kms.replica_key +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
pending_window_in_daysintegerSpecifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
key_policyobjectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
primary_key_arnstringIdentifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
enabledbooleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
key_idstring
arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual replica_key resource, use r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/kms/replica_keys/index.md b/docs/aws-docs/providers/aws/kms/replica_keys/index.md index f0bd87d7af..a284d53aca 100644 --- a/docs/aws-docs/providers/aws/kms/replica_keys/index.md +++ b/docs/aws-docs/providers/aws/kms/replica_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of replica_keys in a region or create a replica_keys resource, use replica_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of replica_keys in a region or create a Namereplica_keys TypeResource DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS). -Idaws.kms.replica_keys +Id ## Fields - - + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of replica_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md index 6a9a5d712f..384d7db443 100644 --- a/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_cells_filter resource, use data_cells_filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual data_cells_filter resource, use < Namedata_cells_filter TypeResource DescriptionA resource schema representing a Lake Formation Data Cells Filter. -Idaws.lakeformation.data_cells_filter +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
table_catalog_idstringThe Catalog Id of the Table on which to create a Data Cells Filter.
database_namestringThe name of the Database that the Table resides in.
table_namestringThe name of the Table to create a Data Cells Filter for.
namestringThe desired name of the Data Cells Filter.
row_filterobjectAn object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
column_namesarrayA list of columns to be included in this Data Cells Filter.
column_wildcardobjectAn object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual data_cells_filter resource, use < Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md index cfeaf9d345..ee1969b78d 100644 --- a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_cells_filters in a region or create a data_cells_filters resource, use data_cells_filter to operate on an individual resource. ## Overview @@ -21,17 +24,17 @@ Used to retrieve a list of data_cells_filters in a region or create Namedata_cells_filters TypeResource DescriptionA resource schema representing a Lake Formation Data Cells Filter. -Idaws.lakeformation.data_cells_filters +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
table_catalog_idundefinedThe Catalog Id of the Table on which to create a Data Cells Filter.
database_nameundefinedThe name of the Database that the Table resides in.
table_nameundefinedThe name of the Table to create a Data Cells Filter for.
nameundefinedThe desired name of the Data Cells Filter.
regionstringAWS region.
undefinedThe Catalog Id of the Table on which to create a Data Cells Filter.
undefinedThe name of the Database that the Table resides in.
undefinedThe name of the Table to create a Data Cells Filter for.
undefinedThe desired name of the Data Cells Filter.
stringAWS region.
@@ -44,14 +47,14 @@ Used to retrieve a list of data_cells_filters in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md index 91f783ed96..d09359a19b 100644 --- a/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual principal_permissions resource, use principal_permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual principal_permissions resource, u Nameprincipal_permissions TypeResource DescriptionThe ``AWS::LakeFormation::PrincipalPermissions`` resource represents the permissions that a principal has on a GLUDC resource (such as GLUlong databases or GLUlong tables). When you create a ``PrincipalPermissions`` resource, the permissions are granted via the LFlong ``GrantPermissions`` API operation. When you delete a ``PrincipalPermissions`` resource, the permissions on principal-resource pair are revoked via the LFlong ``RevokePermissions`` API operation. -Idaws.lakeformation.principal_permissions +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
catalogstringThe identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
principalobjectThe principal to be granted a permission.
resourceobjectThe resource to be granted or revoked permissions.
permissionsarrayThe permissions granted or revoked.
permissions_with_grant_optionarrayIndicates the ability to grant permissions (as a subset of permissions granted).
principal_identifierstring
resource_identifierstring
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual principal_permissions resource, u Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag/index.md b/docs/aws-docs/providers/aws/lakeformation/tag/index.md index 1be5a66b5f..395035ef16 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tag/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tag/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual tag resource, use tags to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual tag resource, use tagsNametag TypeResource DescriptionA resource schema representing a Lake Formation Tag. -Idaws.lakeformation.tag +Id ## Fields - - - - + + + +
NameDatatypeDescription
catalog_idstringThe identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
tag_keystringThe key-name for the LF-tag.
tag_valuesarrayA list of possible values an attribute can take.
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual tag resource, use tagsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md b/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md index da98169f81..7817813130 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual tag_association resource, use tag_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual tag_association resource, use Nametag_association TypeResource DescriptionA resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities. -Idaws.lakeformation.tag_association +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
resourceobjectResource to tag with the Lake Formation Tags
lf_tagsarrayList of Lake Formation Tags to associate with the Lake Formation Resource
resource_identifierstringUnique string identifying the resource. Used as primary identifier, which ideally should be a string
tags_identifierstringUnique string identifying the resource's tags. Used as primary identifier, which ideally should be a string
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual tag_association resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md index e6e6e84e22..3e0f191e4d 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tag_associations in a region or create a tag_associations resource, use tag_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of tag_associations in a region or create a Nametag_associations TypeResource DescriptionA resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities. -Idaws.lakeformation.tag_associations +Id ## Fields - - - + + +
NameDatatypeDescription
resource_identifierstringUnique string identifying the resource. Used as primary identifier, which ideally should be a string
tags_identifierstringUnique string identifying the resource's tags. Used as primary identifier, which ideally should be a string
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of tag_associations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lakeformation/tags/index.md b/docs/aws-docs/providers/aws/lakeformation/tags/index.md index 36db0fc54a..6dcface37b 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tags/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tags/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tags in a region or create a tags resource, use tag to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of tags in a region or create a tags< Nametags TypeResource DescriptionA resource schema representing a Lake Formation Tag. -Idaws.lakeformation.tags +Id ## Fields - - + +
NameDatatypeDescription
tag_keyundefinedThe key-name for the LF-tag.
regionstringAWS region.
undefinedThe key-name for the LF-tag.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of tags in a region or create a tags< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md index 86ba07f5b7..f669976c77 100644 --- a/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md +++ b/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual code_signing_config resource, use code_signing_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual code_signing_config resource, use Namecode_signing_config TypeResource DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig. -Idaws.lambda.code_signing_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstringA description of the CodeSigningConfig
allowed_publishersobjectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
code_signing_policiesobjectPolicies to control how to act if a signature is invalid
code_signing_config_idstringA unique identifier for CodeSigningConfig resource
code_signing_config_arnstringA unique Arn for CodeSigningConfig resource
regionstringAWS region.
stringA description of the CodeSigningConfig
objectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
objectPolicies to control how to act if a signature is invalid
stringA unique identifier for CodeSigningConfig resource
stringA unique Arn for CodeSigningConfig resource
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual code_signing_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md index 514654ae46..aca2df9955 100644 --- a/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md +++ b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of code_signing_configs in a region or create a code_signing_configs resource, use code_signing_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of code_signing_configs in a region or crea Namecode_signing_configs TypeResource DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig. -Idaws.lambda.code_signing_configs +Id ## Fields - - + +
NameDatatypeDescription
code_signing_config_arnstringA unique Arn for CodeSigningConfig resource
regionstringAWS region.
stringA unique Arn for CodeSigningConfig resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of code_signing_configs in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md index c7d5f69c57..559f47f548 100644 --- a/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_invoke_config resource, use event_invoke_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual event_invoke_config resource, use Nameevent_invoke_config TypeResource DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias. -Idaws.lambda.event_invoke_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
destination_configobject
function_namestringThe name of the Lambda function.
maximum_event_age_in_secondsintegerThe maximum age of a request that Lambda sends to a function for processing.
maximum_retry_attemptsintegerThe maximum number of times to retry when the function returns an error.
qualifierstringThe identifier of a version or alias.
regionstringAWS region.
object
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual event_invoke_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md index 52a553c088..0b5c6f44c9 100644 --- a/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_invoke_configs in a region or create a event_invoke_configs resource, use event_invoke_config to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of event_invoke_configs in a region or crea Nameevent_invoke_configs TypeResource DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias. -Idaws.lambda.event_invoke_configs +Id ## Fields - - - + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function.
qualifierstringThe identifier of a version or alias.
regionstringAWS region.
stringThe name of the Lambda function.
stringThe identifier of a version or alias.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of event_invoke_configs in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md index 610fcbd7c4..62bbfc5beb 100644 --- a/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_source_mapping resource, use event_source_mappings to retrieve a list of resources or to create a resource. ## Overview @@ -21,37 +24,37 @@ Gets or operates on an individual event_source_mapping resource, us Nameevent_source_mapping TypeResource DescriptionThe ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.<br/> For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. <br/> + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)<br/> + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)<br/> + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)<br/> + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)<br/> + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)<br/> + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)<br/> + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) -Idaws.lambda.event_source_mapping +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
batch_sizeintegerThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).<br/> + *Amazon Kinesis* – Default 100. Max 10,000.<br/> + *Amazon DynamoDB Streams* – Default 100. Max 10,000.<br/> + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.<br/> + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.<br/> + *Self-managed Apache Kafka* – Default 100. Max 10,000.<br/> + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.<br/> + *DocumentDB* – Default 100. Max 10,000.
bisect_batch_on_function_errorboolean(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
destination_configobject(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
enabledbooleanWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.<br/> Default: True
event_source_arnstringThe Amazon Resource Name (ARN) of the event source.<br/> + *Amazon Kinesis* – The ARN of the data stream or a stream consumer.<br/> + *Amazon DynamoDB Streams* – The ARN of the stream.<br/> + *Amazon Simple Queue Service* – The ARN of the queue.<br/> + *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).<br/> + *Amazon MQ* – The ARN of the broker.<br/> + *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
filter_criteriaobjectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
function_namestringThe name or ARN of the Lambda function.<br/> **Name formats**<br/> + *Function name* – ``MyFunction``.<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.<br/> + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.<br/> + *Partial ARN* – ``123456789012:function:MyFunction``.<br/> <br/> The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
maximum_batching_window_in_secondsintegerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.<br/> *Default (, , event sources)*: 0<br/> *Default (, Kafka, , event sources)*: 500 ms<br/> *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
maximum_record_age_in_secondsinteger(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.<br/> The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
maximum_retry_attemptsinteger(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
parallelization_factorinteger(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
starting_positionstringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.<br/> + *LATEST* - Read only new records.<br/> + *TRIM_HORIZON* - Process all available records.<br/> + *AT_TIMESTAMP* - Specify a time from which to start reading records.
starting_position_timestampnumberWith ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.
topicsarrayThe name of the Kafka topic.
queuesarray(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
source_access_configurationsarrayAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
tumbling_window_in_secondsinteger(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
function_response_typesarray(Streams and SQS) A list of current response type enums applied to the event source mapping.<br/> Valid Values: ``ReportBatchItemFailures``
self_managed_event_sourceobjectThe self-managed Apache Kafka cluster for your event source.
amazon_managed_kafka_event_source_configobjectSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
self_managed_kafka_event_source_configobjectSpecific configuration settings for a self-managed Apache Kafka event source.
scaling_configobject(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
document_db_event_source_configobjectSpecific configuration settings for a DocumentDB event source.
regionstringAWS region.
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).<br/> + *Amazon Kinesis* – Default 100. Max 10,000.<br/> + *Amazon DynamoDB Streams* – Default 100. Max 10,000.<br/> + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.<br/> + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.<br/> + *Self-managed Apache Kafka* – Default 100. Max 10,000.<br/> + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.<br/> + *DocumentDB* – Default 100. Max 10,000.
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.<br/> Default: True
stringThe Amazon Resource Name (ARN) of the event source.<br/> + *Amazon Kinesis* – The ARN of the data stream or a stream consumer.<br/> + *Amazon DynamoDB Streams* – The ARN of the stream.<br/> + *Amazon Simple Queue Service* – The ARN of the queue.<br/> + *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).<br/> + *Amazon MQ* – The ARN of the broker.<br/> + *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
objectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
stringThe name or ARN of the Lambda function.<br/> **Name formats**<br/> + *Function name* – ``MyFunction``.<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.<br/> + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.<br/> + *Partial ARN* – ``123456789012:function:MyFunction``.<br/> <br/> The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
integerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.<br/> *Default (, , event sources)*: 0<br/> *Default (, Kafka, , event sources)*: 500 ms<br/> *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
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.<br/> The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
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.<br/> + *LATEST* - Read only new records.<br/> + *TRIM_HORIZON* - Process all available records.<br/> + *AT_TIMESTAMP* - Specify a time from which to start reading records.
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(Streams and SQS) A list of current response type enums applied to the event source mapping.<br/> 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.
stringAWS region.
@@ -64,19 +67,19 @@ Gets or operates on an individual event_source_mapping resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md index 37bdb2ac33..8ee19aa5e9 100644 --- a/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_source_mappings in a region or create a event_source_mappings resource, use event_source_mapping to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_source_mappings in a region or cre Nameevent_source_mappings TypeResource DescriptionThe ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.<br/> For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. <br/> + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)<br/> + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)<br/> + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)<br/> + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)<br/> + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)<br/> + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)<br/> + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) -Idaws.lambda.event_source_mappings +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_source_mappings in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/function/index.md b/docs/aws-docs/providers/aws/lambda/function/index.md index 35517d5412..2d36b37714 100644 --- a/docs/aws-docs/providers/aws/lambda/function/index.md +++ b/docs/aws-docs/providers/aws/lambda/function/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual function resource, use functions to retrieve a list of resources or to create a resource. ## Overview @@ -21,40 +24,40 @@ Gets or operates on an individual function resource, use func Namefunction TypeResource DescriptionThe ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.<br/> You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. <br/> You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).<br/> You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.<br/> Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.<br/> For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.* -Idaws.lambda.function +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the function.
tracing_configobjectSet ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
vpc_configobjectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
runtime_management_configobjectSets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
reserved_concurrent_executionsintegerThe number of simultaneous executions to reserve for the function.
snap_startobjectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
file_system_configsarrayConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.<br/> For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
function_namestringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
runtimestringThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive.<br/> The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).
kms_key_arnstringThe ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
package_typestringThe type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
code_signing_config_arnstringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
layersarrayA list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
tagsarrayA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
image_configobjectConfiguration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).
memory_sizeintegerThe amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
dead_letter_configobjectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
timeoutintegerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
handlerstringThe name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
snap_start_responseobject
codeobjectThe code for the function.
rolestringThe Amazon Resource Name (ARN) of the function's execution role.
logging_configobjectThe function's Amazon CloudWatch Logs configuration settings.
environmentobjectEnvironment variables that are accessible from function code during execution.
arnstring
ephemeral_storageobjectThe size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
architecturesarrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.
regionstringAWS region.
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.<br/> 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.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
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.<br/> The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).
stringThe ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
stringThe type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
stringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
arrayA list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
arrayA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
objectConfiguration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).
integerThe amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
objectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
integerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
stringThe name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
object
objectThe code for the function.
stringThe Amazon Resource Name (ARN) of the function's execution role.
objectThe function's Amazon CloudWatch Logs configuration settings.
objectEnvironment variables that are accessible from function code during execution.
string
objectThe size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
arrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.
stringAWS region.
@@ -67,19 +70,19 @@ Gets or operates on an individual function resource, use func Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/functions/index.md b/docs/aws-docs/providers/aws/lambda/functions/index.md index 09c753a0c3..8dcf5a7f03 100644 --- a/docs/aws-docs/providers/aws/lambda/functions/index.md +++ b/docs/aws-docs/providers/aws/lambda/functions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of functions in a region or create a functions resource, use function to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of functions in a region or create a Namefunctions TypeResource DescriptionThe ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.<br/> You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. <br/> You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).<br/> You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.<br/> Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.<br/> For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.* -Idaws.lambda.functions +Id ## Fields - - + +
NameDatatypeDescription
function_namestringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of functions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/layer_version/index.md b/docs/aws-docs/providers/aws/lambda/layer_version/index.md index 3ba8f165b3..38da30f1b2 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_version/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual layer_version resource, use layer_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual layer_version resource, use Namelayer_version TypeResource DescriptionResource Type definition for AWS::Lambda::LayerVersion -Idaws.lambda.layer_version +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
compatible_runtimesarrayA list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
license_infostringThe layer's software license.
descriptionstringThe description of the version.
layer_namestringThe name or Amazon Resource Name (ARN) of the layer.
contentobjectThe function layer archive.
layer_version_arnstring
compatible_architecturesarrayA list of compatible instruction set architectures.
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual layer_version resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md index 4d99979dfd..e3fd47c5c5 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual layer_version_permission resource, use layer_version_permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual layer_version_permission resource Namelayer_version_permission TypeResource DescriptionSchema for Lambda LayerVersionPermission -Idaws.lambda.layer_version_permission +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstringID generated by service
actionstringThe API action that grants access to the layer.
layer_version_arnstringThe name or Amazon Resource Name (ARN) of the layer.
organization_idstringWith the principal set to *, grant permission to all accounts in the specified organization.
principalstringAn account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual layer_version_permission resource Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md index bc3ed78ea7..081723dfc0 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of layer_version_permissions in a region or create a layer_version_permissions resource, use layer_version_permission to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of layer_version_permissions in a region or Namelayer_version_permissions TypeResource DescriptionSchema for Lambda LayerVersionPermission -Idaws.lambda.layer_version_permissions +Id ## Fields - - + +
NameDatatypeDescription
idstringID generated by service
regionstringAWS region.
stringID generated by service
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of layer_version_permissions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/layer_versions/index.md b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md index c2d7dd0a2e..bd687c8537 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_versions/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of layer_versions in a region or create a layer_versions resource, use layer_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of layer_versions in a region or create a < Namelayer_versions TypeResource DescriptionResource Type definition for AWS::Lambda::LayerVersion -Idaws.lambda.layer_versions +Id ## Fields - - + +
NameDatatypeDescription
layer_version_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of layer_versions in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/permission/index.md b/docs/aws-docs/providers/aws/lambda/permission/index.md index cd75df9660..5df398e5aa 100644 --- a/docs/aws-docs/providers/aws/lambda/permission/index.md +++ b/docs/aws-docs/providers/aws/lambda/permission/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual permission resource, use permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual permission resource, use pe Namepermission TypeResource DescriptionThe ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.<br/> To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.<br/> If your function has a fu -Idaws.lambda.permission +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
idstring
actionstringThe action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
event_source_tokenstringFor Alexa Smart Home functions, a token that the invoker must supply.
function_namestringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
function_url_auth_typestringThe type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
principalstringThe AWS-service or AWS-account that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.
principal_org_idstringThe identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
source_accountstringFor AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
source_arnstringFor AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.<br/> Note that Lambda configures the comparison using the ``StringLike`` operator.
regionstringAWS region.
string
stringThe action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
stringFor Alexa Smart Home functions, a token that the invoker must supply.
stringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
stringThe type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
stringThe AWS-service or AWS-account that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.
stringThe identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
stringFor AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
stringFor AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.<br/> Note that Lambda configures the comparison using the ``StringLike`` operator.
stringAWS region.
@@ -49,14 +52,14 @@ Gets or operates on an individual permission resource, use pe Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/permissions/index.md b/docs/aws-docs/providers/aws/lambda/permissions/index.md index 4b26f2a5b1..cb860a2555 100644 --- a/docs/aws-docs/providers/aws/lambda/permissions/index.md +++ b/docs/aws-docs/providers/aws/lambda/permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of permissions in a region or create a permissions resource, use permission to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of permissions in a region or create a Namepermissions TypeResource DescriptionThe ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.<br/> To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.<br/> If your function has a fu -Idaws.lambda.permissions +Id ## Fields - - - + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
idstring
regionstringAWS region.
stringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of permissions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/url/index.md b/docs/aws-docs/providers/aws/lambda/url/index.md index 9141014ed0..b695a8651d 100644 --- a/docs/aws-docs/providers/aws/lambda/url/index.md +++ b/docs/aws-docs/providers/aws/lambda/url/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual url resource, use urls to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual url resource, use urlsNameurl TypeResource DescriptionResource Type definition for AWS::Lambda::Url -Idaws.lambda.url +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
target_function_arnstringThe Amazon Resource Name (ARN) of the function associated with the Function URL.
qualifierstringThe alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
auth_typestringCan be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
invoke_modestringThe invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
function_arnstringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
function_urlstringThe generated url for this resource.
corsobject
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual url resource, use urlsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/urls/index.md b/docs/aws-docs/providers/aws/lambda/urls/index.md index 1f52f11c88..9daa9a50a8 100644 --- a/docs/aws-docs/providers/aws/lambda/urls/index.md +++ b/docs/aws-docs/providers/aws/lambda/urls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of urls in a region or create a urls resource, use url to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of urls in a region or create a urls< Nameurls TypeResource DescriptionResource Type definition for AWS::Lambda::Url -Idaws.lambda.urls +Id ## Fields - - + +
NameDatatypeDescription
function_arnstringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
regionstringAWS region.
stringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of urls in a region or create a urls< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lambda/version/index.md b/docs/aws-docs/providers/aws/lambda/version/index.md index 5ea5defa20..d5fb11999b 100644 --- a/docs/aws-docs/providers/aws/lambda/version/index.md +++ b/docs/aws-docs/providers/aws/lambda/version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual version resource, use versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual version resource, use versi Nameversion TypeResource DescriptionResource Type definition for AWS::Lambda::Version -Idaws.lambda.version +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
function_arnstringThe ARN of the version.
versionstringThe version number.
code_sha256stringOnly publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.
descriptionstringA description for the version to override the description in the function configuration. Updates are not supported for this property.
function_namestringThe name of the Lambda function.
provisioned_concurrency_configobjectSpecifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property.
runtime_policyobjectSpecifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual version resource, use versi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lambda/versions/index.md b/docs/aws-docs/providers/aws/lambda/versions/index.md index b13c661b9b..4f73b80cd0 100644 --- a/docs/aws-docs/providers/aws/lambda/versions/index.md +++ b/docs/aws-docs/providers/aws/lambda/versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of versions in a region or create a versions resource, use version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of versions in a region or create a v Nameversions TypeResource DescriptionResource Type definition for AWS::Lambda::Version -Idaws.lambda.versions +Id ## Fields - - + +
NameDatatypeDescription
function_arnstringThe ARN of the version.
regionstringAWS region.
stringThe ARN of the version.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of versions in a region or create a v Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lex/bot/index.md b/docs/aws-docs/providers/aws/lex/bot/index.md index 59f930e2e5..0faae695c5 100644 --- a/docs/aws-docs/providers/aws/lex/bot/index.md +++ b/docs/aws-docs/providers/aws/lex/bot/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bot resource, use bots to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual bot resource, use botsNamebot TypeResource DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on. -Idaws.lex.bot +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestring
descriptionstring
role_arnstring
data_privacyobjectData privacy setting of the Bot.
idle_session_ttl_in_secondsintegerIdleSessionTTLInSeconds of the resource
bot_localesarrayList of bot locales
bot_file_s3_locationobject
bot_tagsarrayA list of tags to add to the bot, which can only be added at bot creation.
test_bot_alias_tagsarrayA list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.
auto_build_bot_localesbooleanSpecifies whether to build the bot locales after bot creation completes.
test_bot_alias_settingsobject
regionstringAWS region.
string
string
string
string
string
objectData privacy setting of the Bot.
integerIdleSessionTTLInSeconds of the resource
arrayList of bot locales
object
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.
object
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual bot resource, use botsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lex/bot_alias/index.md b/docs/aws-docs/providers/aws/lex/bot_alias/index.md index 47a61fe604..ed908b0fc1 100644 --- a/docs/aws-docs/providers/aws/lex/bot_alias/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bot_alias resource, use bot_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual bot_alias resource, use bot Namebot_alias TypeResource DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot -Idaws.lex.bot_alias +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
bot_alias_idstring
bot_idstring
arnstring
bot_alias_statusstring
bot_alias_locale_settingsarray
bot_alias_namestring
bot_versionobject
conversation_log_settingsobject
descriptionstring
sentiment_analysis_settingsobjectDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_alias_tagsarrayA list of tags to add to the bot alias.
regionstringAWS region.
string
string
string
string
array
string
object
object
string
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual bot_alias resource, use bot Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lex/bot_aliases/index.md b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md index 13c6c67bba..67947af7c0 100644 --- a/docs/aws-docs/providers/aws/lex/bot_aliases/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bot_aliases in a region or create a bot_aliases resource, use bot_alias to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of bot_aliases in a region or create a Namebot_aliases TypeResource DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot -Idaws.lex.bot_aliases +Id ## Fields - - - + + +
NameDatatypeDescription
bot_alias_idundefined
bot_idundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of bot_aliases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lex/bot_version/index.md b/docs/aws-docs/providers/aws/lex/bot_version/index.md index a3b0ebaf30..24a718cf13 100644 --- a/docs/aws-docs/providers/aws/lex/bot_version/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bot_version resource, use bot_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual bot_version resource, use b Namebot_version TypeResource DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production. -Idaws.lex.bot_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
bot_idstring
bot_versionobject
descriptionstring
bot_version_locale_specificationarray
regionstringAWS region.
string
object
string
array
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual bot_version resource, use b Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lex/bot_versions/index.md b/docs/aws-docs/providers/aws/lex/bot_versions/index.md index a62c93dbcf..6462244928 100644 --- a/docs/aws-docs/providers/aws/lex/bot_versions/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bot_versions in a region or create a bot_versions resource, use bot_version to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of bot_versions in a region or create a Namebot_versions TypeResource DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production. -Idaws.lex.bot_versions +Id ## Fields - - - + + +
NameDatatypeDescription
bot_idundefined
bot_versionundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of bot_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lex/bots/index.md b/docs/aws-docs/providers/aws/lex/bots/index.md index 3bbf5a41d1..c75a1a8008 100644 --- a/docs/aws-docs/providers/aws/lex/bots/index.md +++ b/docs/aws-docs/providers/aws/lex/bots/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bots in a region or create a bots resource, use bot to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of bots in a region or create a bots< Namebots TypeResource DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on. -Idaws.lex.bots +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of bots in a region or create a bots< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lex/resource_policies/index.md b/docs/aws-docs/providers/aws/lex/resource_policies/index.md index 8c69ee1fa1..8d4bb2b567 100644 --- a/docs/aws-docs/providers/aws/lex/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/lex/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias. -Idaws.lex.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lex/resource_policy/index.md b/docs/aws-docs/providers/aws/lex/resource_policy/index.md index cdbbac3f7e..bbb6baf1dc 100644 --- a/docs/aws-docs/providers/aws/lex/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/lex/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias. -Idaws.lex.resource_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
resource_arnstring
revision_idstring
policyobject
idstring
regionstringAWS region.
string
string
object
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/licensemanager/grant/index.md b/docs/aws-docs/providers/aws/licensemanager/grant/index.md index 84da1bba51..19b413edf6 100644 --- a/docs/aws-docs/providers/aws/licensemanager/grant/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/grant/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual grant resource, use grants to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual grant resource, use grants< Namegrant TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.licensemanager.grant +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
grant_arnstringArn of the grant.
grant_namestringName for the created Grant.
license_arnstringLicense Arn for the grant.
home_regionstringHome region for the created grant.
versionstringThe version of the grant.
allowed_operationsarray
principalsarray
statusstring
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual grant resource, use grants< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/licensemanager/grants/index.md b/docs/aws-docs/providers/aws/licensemanager/grants/index.md index 64f32baa82..067fb93cb4 100644 --- a/docs/aws-docs/providers/aws/licensemanager/grants/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/grants/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of grants in a region or create a grants resource, use grant to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of grants in a region or create a gra Namegrants TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.licensemanager.grants +Id ## Fields - - + +
NameDatatypeDescription
grant_arnundefinedArn of the grant.
regionstringAWS region.
undefinedArn of the grant.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of grants in a region or create a gra Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/licensemanager/license/index.md b/docs/aws-docs/providers/aws/licensemanager/license/index.md index 29b4ab91c3..cd92d55839 100644 --- a/docs/aws-docs/providers/aws/licensemanager/license/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/license/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual license resource, use licenses to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual license resource, use licen Namelicense TypeResource DescriptionResource Type definition for AWS::LicenseManager::License -Idaws.licensemanager.license +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
product_skustringProductSKU of the license.
issuerobject
license_namestringName for the created license.
product_namestringProduct name for the created license.
home_regionstringHome region for the created license.
validityobject
entitlementsarray
beneficiarystringBeneficiary of the license.
consumption_configurationobject
license_metadataarray
license_arnstringAmazon Resource Name is a unique name for each resource.
statusstring
versionstringThe version of the license.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual license resource, use licen Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/licensemanager/licenses/index.md b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md index 6a53ec2eef..42541fc032 100644 --- a/docs/aws-docs/providers/aws/licensemanager/licenses/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of licenses in a region or create a licenses resource, use license to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of licenses in a region or create a l Namelicenses TypeResource DescriptionResource Type definition for AWS::LicenseManager::License -Idaws.licensemanager.licenses +Id ## Fields - - + +
NameDatatypeDescription
license_arnundefinedAmazon Resource Name is a unique name for each resource.
regionstringAWS region.
undefinedAmazon Resource Name is a unique name for each resource.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of licenses in a region or create a l Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/alarm/index.md b/docs/aws-docs/providers/aws/lightsail/alarm/index.md index eb2f5d9641..b77aa90d6e 100644 --- a/docs/aws-docs/providers/aws/lightsail/alarm/index.md +++ b/docs/aws-docs/providers/aws/lightsail/alarm/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alarm resource, use alarms to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual alarm resource, use alarms< Namealarm TypeResource DescriptionResource Type definition for AWS::Lightsail::Alarm -Idaws.lightsail.alarm +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
alarm_namestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
monitored_resource_namestringThe validation status of the SSL/TLS certificate.
metric_namestringThe name of the metric to associate with the alarm.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contact_protocolsarrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
alarm_arnstring
datapoints_to_alarmintegerThe number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
evaluation_periodsintegerThe number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
notification_enabledbooleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notification_triggersarrayThe alarm states that trigger a notification.
thresholdnumberThe value against which the specified statistic is compared.
treat_missing_datastringSets how this alarm will handle missing data points.
statestringThe current state of the alarm.
regionstringAWS region.
stringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
stringThe validation status of the SSL/TLS certificate.
stringThe name of the metric to associate with the alarm.
stringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
arrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
string
integerThe number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
integerThe number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
booleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
arrayThe alarm states that trigger a notification.
numberThe value against which the specified statistic is compared.
stringSets how this alarm will handle missing data points.
stringThe current state of the alarm.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual alarm resource, use alarms< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/alarms/index.md b/docs/aws-docs/providers/aws/lightsail/alarms/index.md index 290be7dea8..e87fd9730b 100644 --- a/docs/aws-docs/providers/aws/lightsail/alarms/index.md +++ b/docs/aws-docs/providers/aws/lightsail/alarms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of alarms in a region or create a alarms resource, use alarm to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of alarms in a region or create a ala Namealarms TypeResource DescriptionResource Type definition for AWS::Lightsail::Alarm -Idaws.lightsail.alarms +Id ## Fields - - + +
NameDatatypeDescription
alarm_namestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
regionstringAWS region.
stringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of alarms in a region or create a ala Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/bucket/index.md b/docs/aws-docs/providers/aws/lightsail/bucket/index.md index ae454ecea0..b681674102 100644 --- a/docs/aws-docs/providers/aws/lightsail/bucket/index.md +++ b/docs/aws-docs/providers/aws/lightsail/bucket/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket resource, use buckets to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual bucket resource, use bucket Namebucket TypeResource DescriptionResource Type definition for AWS::Lightsail::Bucket -Idaws.lightsail.bucket +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
bucket_namestringThe name for the bucket.
bundle_idstringThe ID of the bundle to use for the bucket.
bucket_arnstring
object_versioningbooleanSpecifies whether to enable or disable versioning of objects in the bucket.
access_rulesobject
resources_receiving_accessarrayThe names of the Lightsail resources for which to set bucket access.
read_only_access_accountsarrayAn array of strings to specify the AWS account IDs that can access the bucket.
tagsarrayAn array of key-value pairs to apply to this resource.
urlstringThe URL of the bucket.
able_to_update_bundlebooleanIndicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
regionstringAWS region.
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.
object
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual bucket resource, use bucket Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/buckets/index.md b/docs/aws-docs/providers/aws/lightsail/buckets/index.md index 6e6e60df77..9327cd0af4 100644 --- a/docs/aws-docs/providers/aws/lightsail/buckets/index.md +++ b/docs/aws-docs/providers/aws/lightsail/buckets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of buckets in a region or create a buckets resource, use bucket to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of buckets in a region or create a bu Namebuckets TypeResource DescriptionResource Type definition for AWS::Lightsail::Bucket -Idaws.lightsail.buckets +Id ## Fields - - + +
NameDatatypeDescription
bucket_namestringThe name for the bucket.
regionstringAWS region.
stringThe name for the bucket.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of buckets in a region or create a bu Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/certificate/index.md b/docs/aws-docs/providers/aws/lightsail/certificate/index.md index f48c5726ac..7bad2fe2f9 100644 --- a/docs/aws-docs/providers/aws/lightsail/certificate/index.md +++ b/docs/aws-docs/providers/aws/lightsail/certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate resource, use certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual certificate resource, use c Namecertificate TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.lightsail.certificate +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
certificate_namestringThe name for the certificate.
domain_namestringThe domain name (e.g., example.com ) for the certificate.
subject_alternative_namesarrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
certificate_arnstring
statusstringThe validation status of the certificate.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual certificate resource, use c Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/certificates/index.md b/docs/aws-docs/providers/aws/lightsail/certificates/index.md index 30c9f48040..a1efa67443 100644 --- a/docs/aws-docs/providers/aws/lightsail/certificates/index.md +++ b/docs/aws-docs/providers/aws/lightsail/certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificates in a region or create a certificates resource, use certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificates in a region or create a Namecertificates TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.lightsail.certificates +Id ## Fields - - + +
NameDatatypeDescription
certificate_namestringThe name for the certificate.
regionstringAWS region.
stringThe name for the certificate.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/container/index.md b/docs/aws-docs/providers/aws/lightsail/container/index.md index 86a0102df8..2da3321081 100644 --- a/docs/aws-docs/providers/aws/lightsail/container/index.md +++ b/docs/aws-docs/providers/aws/lightsail/container/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual container resource, use containers to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual container resource, use con Namecontainer TypeResource DescriptionResource Type definition for AWS::Lightsail::Container -Idaws.lightsail.container +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
service_namestringThe name for the container service.
powerstringThe power specification for the container service.
container_arnstring
scaleintegerThe scale specification for the container service.
public_domain_namesarrayThe public domain names to use with the container service, such as example.com and www.example.com.
container_service_deploymentobjectDescribes a container deployment configuration of an Amazon Lightsail container service.
is_disabledbooleanA Boolean value to indicate whether the container service is disabled.
private_registry_accessobjectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
urlstringThe publicly accessible URL of the container service.
principal_arnstringThe principal ARN of the container service.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual container resource, use con Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/containers/index.md b/docs/aws-docs/providers/aws/lightsail/containers/index.md index 6a865e0446..ae9e3db261 100644 --- a/docs/aws-docs/providers/aws/lightsail/containers/index.md +++ b/docs/aws-docs/providers/aws/lightsail/containers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of containers in a region or create a containers resource, use container to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of containers in a region or create a Namecontainers TypeResource DescriptionResource Type definition for AWS::Lightsail::Container -Idaws.lightsail.containers +Id ## Fields - - + +
NameDatatypeDescription
service_namestringThe name for the container service.
regionstringAWS region.
stringThe name for the container service.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of containers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/database/index.md b/docs/aws-docs/providers/aws/lightsail/database/index.md index 5b99b5e5dd..942e5340c3 100644 --- a/docs/aws-docs/providers/aws/lightsail/database/index.md +++ b/docs/aws-docs/providers/aws/lightsail/database/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual database resource, use databases to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual database resource, use data Namedatabase TypeResource DescriptionResource Type definition for AWS::Lightsail::Database -Idaws.lightsail.database +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
relational_database_namestringThe name to use for your new Lightsail database resource.
database_arnstring
availability_zonestringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
relational_database_blueprint_idstringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
relational_database_bundle_idstringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
master_database_namestringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
master_usernamestringThe name for the master user.
master_user_passwordstringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
preferred_backup_windowstringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
preferred_maintenance_windowstringThe weekly time range during which system maintenance can occur on your new database.
publicly_accessiblebooleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
ca_certificate_identifierstringIndicates the certificate that needs to be associated with the database.
backup_retentionbooleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
rotate_master_user_passwordbooleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
relational_database_parametersarrayUpdate one or more parameters of the relational database.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual database resource, use data Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/databases/index.md b/docs/aws-docs/providers/aws/lightsail/databases/index.md index 693e5314a5..b27a834aab 100644 --- a/docs/aws-docs/providers/aws/lightsail/databases/index.md +++ b/docs/aws-docs/providers/aws/lightsail/databases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of databases in a region or create a databases resource, use database to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of databases in a region or create a Namedatabases TypeResource DescriptionResource Type definition for AWS::Lightsail::Database -Idaws.lightsail.databases +Id ## Fields - - + +
NameDatatypeDescription
relational_database_namestringThe name to use for your new Lightsail database resource.
regionstringAWS region.
stringThe name to use for your new Lightsail database resource.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of databases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/distribution/index.md b/docs/aws-docs/providers/aws/lightsail/distribution/index.md index cdefe7f3e5..de14eced46 100644 --- a/docs/aws-docs/providers/aws/lightsail/distribution/index.md +++ b/docs/aws-docs/providers/aws/lightsail/distribution/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual distribution resource, use distributions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual distribution resource, use Namedistribution TypeResource DescriptionResource Type definition for AWS::Lightsail::Distribution -Idaws.lightsail.distribution +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
distribution_namestringThe name for the distribution.
distribution_arnstring
bundle_idstringThe bundle ID to use for the distribution.
ip_address_typestringThe IP address type for the distribution.
cache_behaviorsarrayAn array of objects that describe the per-path cache behavior for the distribution.
cache_behavior_settingsobjectAn object that describes the cache behavior settings for the distribution.
default_cache_behaviorobjectAn object that describes the default cache behavior for the distribution.
originobjectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
statusstringThe status of the distribution.
able_to_update_bundlebooleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
is_enabledbooleanIndicates whether the distribution is enabled.
certificate_namestringThe certificate attached to the Distribution.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual distribution resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/distributions/index.md b/docs/aws-docs/providers/aws/lightsail/distributions/index.md index 48f75bb092..b2ec9da064 100644 --- a/docs/aws-docs/providers/aws/lightsail/distributions/index.md +++ b/docs/aws-docs/providers/aws/lightsail/distributions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of distributions in a region or create a distributions resource, use distribution to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of distributions in a region or create a Namedistributions TypeResource DescriptionResource Type definition for AWS::Lightsail::Distribution -Idaws.lightsail.distributions +Id ## Fields - - + +
NameDatatypeDescription
distribution_namestringThe name for the distribution.
regionstringAWS region.
stringThe name for the distribution.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of distributions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/instance/index.md b/docs/aws-docs/providers/aws/lightsail/instance/index.md index b4b64fa5d7..979337ae5f 100644 --- a/docs/aws-docs/providers/aws/lightsail/instance/index.md +++ b/docs/aws-docs/providers/aws/lightsail/instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance resource, use instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,33 +24,33 @@ Gets or operates on an individual instance resource, use inst Nameinstance TypeResource DescriptionResource Type definition for AWS::Lightsail::Instance -Idaws.lightsail.instance +Id ## Fields - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
support_codestringSupport code to help identify any issues
resource_typestringResource type of Lightsail instance.
is_static_ipbooleanIs the IP Address of the Instance is the static IP
private_ip_addressstringPrivate IP Address of the Instance
public_ip_addressstringPublic IP Address of the Instance
locationobject
hardwareobject
stateobject
networkingobject
user_namestringUsername of the Lightsail instance.
ssh_key_namestringSSH Key Name of the Lightsail instance.
instance_namestringThe names to use for your new Lightsail instance.
availability_zonestringThe Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
bundle_idstringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
blueprint_idstringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
add_onsarrayAn array of objects representing the add-ons to enable for the new instance.
user_datastringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
key_pair_namestringThe name of your key pair.
tagsarrayAn array of key-value pairs to apply to this resource.
instance_arnstring
regionstringAWS region.
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
object
object
object
object
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.
@@ -60,19 +63,19 @@ Gets or operates on an individual instance resource, use inst Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/instances/index.md b/docs/aws-docs/providers/aws/lightsail/instances/index.md index 51424ed2bf..572bb5acb2 100644 --- a/docs/aws-docs/providers/aws/lightsail/instances/index.md +++ b/docs/aws-docs/providers/aws/lightsail/instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instances in a region or create a instances resource, use instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instances in a region or create a Nameinstances TypeResource DescriptionResource Type definition for AWS::Lightsail::Instance -Idaws.lightsail.instances +Id ## Fields - - + +
NameDatatypeDescription
instance_namestringThe names to use for your new Lightsail instance.
regionstringAWS region.
stringThe names to use for your new Lightsail instance.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instances in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md index 5721f67307..45f18b41f9 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual load_balancer resource, use load_balancers to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual load_balancer resource, use Nameload_balancer TypeResource DescriptionResource Type definition for AWS::Lightsail::LoadBalancer -Idaws.lightsail.load_balancer +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
load_balancer_arnstring
instance_portintegerThe instance port where you're creating your load balancer.
ip_address_typestringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
attached_instancesarrayThe names of the instances attached to the load balancer.
health_check_pathstringThe path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").
session_stickiness_enabledbooleanConfiguration option to enable session stickiness.
session_stickiness_lb_cookie_duration_secondsstringConfiguration option to adjust session stickiness cookie duration parameter.
tls_policy_namestringThe name of the TLS policy to apply to the load balancer.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual load_balancer resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md index 992001b0fc..407d830861 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual load_balancer_tls_certificate resource, use load_balancer_tls_certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual load_balancer_tls_certificate res Nameload_balancer_tls_certificate TypeResource DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate -Idaws.lightsail.load_balancer_tls_certificate +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
certificate_namestringThe SSL/TLS certificate name.
certificate_domain_namestringThe domain name (e.g., example.com ) for your SSL/TLS certificate.
certificate_alternative_namesarrayAn array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
load_balancer_tls_certificate_arnstring
is_attachedbooleanWhen true, the SSL/TLS certificate is attached to the Lightsail load balancer.
https_redirection_enabledbooleanA Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
statusstringThe validation status of the SSL/TLS certificate.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual load_balancer_tls_certificate res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md index 6c3441afac..1725e72d15 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of load_balancer_tls_certificates in a region or create a load_balancer_tls_certificates resource, use load_balancer_tls_certificate to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of load_balancer_tls_certificates in a regi Nameload_balancer_tls_certificates TypeResource DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate -Idaws.lightsail.load_balancer_tls_certificates +Id ## Fields - - - + + +
NameDatatypeDescription
certificate_namestringThe SSL/TLS certificate name.
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
stringThe SSL/TLS certificate name.
stringThe name of your load balancer.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of load_balancer_tls_certificates in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md index eb2652c8cf..578efaaf99 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of load_balancers in a region or create a load_balancers resource, use load_balancer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of load_balancers in a region or create a < Nameload_balancers TypeResource DescriptionResource Type definition for AWS::Lightsail::LoadBalancer -Idaws.lightsail.load_balancers +Id ## Fields - - + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
stringThe name of your load balancer.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of load_balancers in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lightsail/static_ip/index.md b/docs/aws-docs/providers/aws/lightsail/static_ip/index.md index 2ee6ecbd21..919f1ee8ba 100644 --- a/docs/aws-docs/providers/aws/lightsail/static_ip/index.md +++ b/docs/aws-docs/providers/aws/lightsail/static_ip/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual static_ip resource, use static_ips to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual static_ip resource, use sta Namestatic_ip TypeResource DescriptionResource Type definition for AWS::Lightsail::StaticIp -Idaws.lightsail.static_ip +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
static_ip_namestringThe name of the static IP address.
attached_tostringThe instance where the static IP is attached.
is_attachedbooleanA Boolean value indicating whether the static IP is attached.
ip_addressstringThe static IP address.
static_ip_arnstring
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual static_ip resource, use sta Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lightsail/static_ips/index.md b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md index c52f40f989..a7e5f68979 100644 --- a/docs/aws-docs/providers/aws/lightsail/static_ips/index.md +++ b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of static_ips in a region or create a static_ips resource, use static_ip to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of static_ips in a region or create a Namestatic_ips TypeResource DescriptionResource Type definition for AWS::Lightsail::StaticIp -Idaws.lightsail.static_ips +Id ## Fields - - + +
NameDatatypeDescription
static_ip_namestringThe name of the static IP address.
regionstringAWS region.
stringThe name of the static IP address.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of static_ips in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/api_key/index.md b/docs/aws-docs/providers/aws/location/api_key/index.md index 96eea76a40..12540dd4b5 100644 --- a/docs/aws-docs/providers/aws/location/api_key/index.md +++ b/docs/aws-docs/providers/aws/location/api_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual api_key resource, use api_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual api_key resource, use api_k Nameapi_key TypeResource DescriptionDefinition of AWS::Location::APIKey Resource Type -Idaws.location.api_key +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
create_timestring
descriptionstring
expire_timestring
force_updateboolean
key_arnstring
key_namestring
no_expiryboolean
restrictionsobject
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
force_deleteboolean
arnstring
regionstringAWS region.
string
string
string
boolean
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
string
boolean
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual api_key resource, use api_k Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/api_keys/index.md b/docs/aws-docs/providers/aws/location/api_keys/index.md index 24cfbbd6df..b602c423fc 100644 --- a/docs/aws-docs/providers/aws/location/api_keys/index.md +++ b/docs/aws-docs/providers/aws/location/api_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of api_keys in a region or create a api_keys resource, use api_key to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of api_keys in a region or create a a Nameapi_keys TypeResource DescriptionDefinition of AWS::Location::APIKey Resource Type -Idaws.location.api_keys +Id ## Fields - - + +
NameDatatypeDescription
key_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of api_keys in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/geofence_collection/index.md b/docs/aws-docs/providers/aws/location/geofence_collection/index.md index 9b4cc92fae..acaab7665f 100644 --- a/docs/aws-docs/providers/aws/location/geofence_collection/index.md +++ b/docs/aws-docs/providers/aws/location/geofence_collection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual geofence_collection resource, use geofence_collections to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual geofence_collection resource, use Namegeofence_collection TypeResource DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type -Idaws.location.geofence_collection +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
collection_arnstring
collection_namestring
create_timestring
descriptionstring
kms_key_idstring
pricing_planstring
pricing_plan_data_sourcestring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
string
string
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual geofence_collection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/geofence_collections/index.md b/docs/aws-docs/providers/aws/location/geofence_collections/index.md index 1abc1ff6a7..80b0cb9443 100644 --- a/docs/aws-docs/providers/aws/location/geofence_collections/index.md +++ b/docs/aws-docs/providers/aws/location/geofence_collections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of geofence_collections in a region or create a geofence_collections resource, use geofence_collection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of geofence_collections in a region or crea Namegeofence_collections TypeResource DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type -Idaws.location.geofence_collections +Id ## Fields - - + +
NameDatatypeDescription
collection_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of geofence_collections in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/map/index.md b/docs/aws-docs/providers/aws/location/map/index.md index a24fb1972b..64be8eb10a 100644 --- a/docs/aws-docs/providers/aws/location/map/index.md +++ b/docs/aws-docs/providers/aws/location/map/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual map resource, use maps to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual map resource, use mapsNamemap TypeResource DescriptionDefinition of AWS::Location::Map Resource Type -Idaws.location.map +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
configurationobject
create_timestring
descriptionstring
map_arnstring
map_namestring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
object
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual map resource, use mapsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/maps/index.md b/docs/aws-docs/providers/aws/location/maps/index.md index 3576004051..c45721f6cf 100644 --- a/docs/aws-docs/providers/aws/location/maps/index.md +++ b/docs/aws-docs/providers/aws/location/maps/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of maps in a region or create a maps resource, use map to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of maps in a region or create a maps< Namemaps TypeResource DescriptionDefinition of AWS::Location::Map Resource Type -Idaws.location.maps +Id ## Fields - - + +
NameDatatypeDescription
map_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of maps in a region or create a maps< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/place_index/index.md b/docs/aws-docs/providers/aws/location/place_index/index.md index 143648a0f2..2248da8b5b 100644 --- a/docs/aws-docs/providers/aws/location/place_index/index.md +++ b/docs/aws-docs/providers/aws/location/place_index/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual place_index resource, use place_indices to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual place_index resource, use p Nameplace_index TypeResource DescriptionDefinition of AWS::Location::PlaceIndex Resource Type -Idaws.location.place_index +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
create_timestring
data_sourcestring
data_source_configurationobject
descriptionstring
index_arnstring
index_namestring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
string
string
object
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual place_index resource, use p Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/place_indices/index.md b/docs/aws-docs/providers/aws/location/place_indices/index.md index a2e5dc15f8..a85614a3b2 100644 --- a/docs/aws-docs/providers/aws/location/place_indices/index.md +++ b/docs/aws-docs/providers/aws/location/place_indices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of place_indices in a region or create a place_indices resource, use place_index to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of place_indices in a region or create a Nameplace_indices TypeResource DescriptionDefinition of AWS::Location::PlaceIndex Resource Type -Idaws.location.place_indices +Id ## Fields - - + +
NameDatatypeDescription
index_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of place_indices in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/route_calculator/index.md b/docs/aws-docs/providers/aws/location/route_calculator/index.md index a412020c17..8fa9507f82 100644 --- a/docs/aws-docs/providers/aws/location/route_calculator/index.md +++ b/docs/aws-docs/providers/aws/location/route_calculator/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route_calculator resource, use route_calculators to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual route_calculator resource, use Nameroute_calculator TypeResource DescriptionDefinition of AWS::Location::RouteCalculator Resource Type -Idaws.location.route_calculator +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
calculator_arnstring
calculator_namestring
create_timestring
data_sourcestring
descriptionstring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
string
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual route_calculator resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/route_calculators/index.md b/docs/aws-docs/providers/aws/location/route_calculators/index.md index 2ba9243973..55ffa186ab 100644 --- a/docs/aws-docs/providers/aws/location/route_calculators/index.md +++ b/docs/aws-docs/providers/aws/location/route_calculators/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of route_calculators in a region or create a route_calculators resource, use route_calculator to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of route_calculators in a region or create Nameroute_calculators TypeResource DescriptionDefinition of AWS::Location::RouteCalculator Resource Type -Idaws.location.route_calculators +Id ## Fields - - + +
NameDatatypeDescription
calculator_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of route_calculators in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/tracker/index.md b/docs/aws-docs/providers/aws/location/tracker/index.md index 182a794f32..867811c4ff 100644 --- a/docs/aws-docs/providers/aws/location/tracker/index.md +++ b/docs/aws-docs/providers/aws/location/tracker/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual tracker resource, use trackers to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual tracker resource, use track Nametracker TypeResource DescriptionDefinition of AWS::Location::Tracker Resource Type -Idaws.location.tracker +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
create_timestring
descriptionstring
event_bridge_enabledboolean
kms_key_enable_geospatial_queriesboolean
kms_key_idstring
position_filteringstring
pricing_planstring
pricing_plan_data_sourcestring
tagsarrayAn array of key-value pairs to apply to this resource.
tracker_arnstring
tracker_namestring
update_timestring
arnstring
regionstringAWS region.
string
string
boolean
boolean
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
string
string
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual tracker resource, use track Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/tracker_consumer/index.md b/docs/aws-docs/providers/aws/location/tracker_consumer/index.md index ce3089232d..42d2d46586 100644 --- a/docs/aws-docs/providers/aws/location/tracker_consumer/index.md +++ b/docs/aws-docs/providers/aws/location/tracker_consumer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual tracker_consumer resource, use tracker_consumers to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual tracker_consumer resource, use Nametracker_consumer TypeResource DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type -Idaws.location.tracker_consumer +Id ## Fields - - - + + +
NameDatatypeDescription
consumer_arnstring
tracker_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual tracker_consumer resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/location/tracker_consumers/index.md b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md index 518f42368d..ee4cf1a0a5 100644 --- a/docs/aws-docs/providers/aws/location/tracker_consumers/index.md +++ b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tracker_consumers in a region or create a tracker_consumers resource, use tracker_consumer to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of tracker_consumers in a region or create Nametracker_consumers TypeResource DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type -Idaws.location.tracker_consumers +Id ## Fields - - - + + +
NameDatatypeDescription
tracker_namestring
consumer_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of tracker_consumers in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/location/trackers/index.md b/docs/aws-docs/providers/aws/location/trackers/index.md index cdb6d7979b..c179806ba2 100644 --- a/docs/aws-docs/providers/aws/location/trackers/index.md +++ b/docs/aws-docs/providers/aws/location/trackers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trackers in a region or create a trackers resource, use tracker to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of trackers in a region or create a t Nametrackers TypeResource DescriptionDefinition of AWS::Location::Tracker Resource Type -Idaws.location.trackers +Id ## Fields - - + +
NameDatatypeDescription
tracker_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of trackers in a region or create a t Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/account_policies/index.md b/docs/aws-docs/providers/aws/logs/account_policies/index.md index 4a826fe3c6..3a4e42b4e5 100644 --- a/docs/aws-docs/providers/aws/logs/account_policies/index.md +++ b/docs/aws-docs/providers/aws/logs/account_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of account_policies in a region or create a account_policies resource, use account_policy to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of account_policies in a region or create a Nameaccount_policies TypeResource DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy. -Idaws.logs.account_policies +Id ## Fields - - - - + + + +
NameDatatypeDescription
account_idstringUser account id
policy_typestringType of the policy.
policy_namestringThe name of the account policy
regionstringAWS region.
stringUser account id
stringType of the policy.
stringThe name of the account policy
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of account_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/account_policy/index.md b/docs/aws-docs/providers/aws/logs/account_policy/index.md index a345ecc969..ef6b3b0c4b 100644 --- a/docs/aws-docs/providers/aws/logs/account_policy/index.md +++ b/docs/aws-docs/providers/aws/logs/account_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account_policy resource, use account_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual account_policy resource, use Nameaccount_policy TypeResource DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy. -Idaws.logs.account_policy +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
account_idstringUser account id
policy_namestringThe name of the account policy
policy_documentstringThe body of the policy document you want to use for this topic.<br/><br/>You can only add one policy per PolicyType.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 30720
policy_typestringType of the policy.
scopestringScope for policy application
selection_criteriastringLog group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes
regionstringAWS region.
stringUser account id
stringThe name of the account policy
stringThe body of the policy document you want to use for this topic.<br/><br/>You can only add one policy per PolicyType.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 30720
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual account_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/deliveries/index.md b/docs/aws-docs/providers/aws/logs/deliveries/index.md index e202ac1aa5..d8ec156dd9 100644 --- a/docs/aws-docs/providers/aws/logs/deliveries/index.md +++ b/docs/aws-docs/providers/aws/logs/deliveries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of deliveries in a region or create a deliveries resource, use delivery to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of deliveries in a region or create a Namedeliveries TypeResource DescriptionThis structure contains information about one delivery in your account.<br/><br/>A delivery is a connection between a logical delivery source and a logical delivery destination.<br/><br/>For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html). -Idaws.logs.deliveries +Id ## Fields - - + +
NameDatatypeDescription
delivery_idstringThe unique ID that identifies this delivery in your account.
regionstringAWS region.
stringThe unique ID that identifies this delivery in your account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of deliveries in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/delivery/index.md b/docs/aws-docs/providers/aws/logs/delivery/index.md index 483c5299b9..0e1fecd41c 100644 --- a/docs/aws-docs/providers/aws/logs/delivery/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual delivery resource, use deliveries to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual delivery resource, use deli Namedelivery TypeResource DescriptionThis structure contains information about one delivery in your account.<br/><br/>A delivery is a connection between a logical delivery source and a logical delivery destination.<br/><br/>For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html). -Idaws.logs.delivery +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
delivery_idstringThe unique ID that identifies this delivery in your account.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
delivery_source_namestringThe name of the delivery source that is associated with this delivery.
delivery_destination_arnstringThe ARN of the delivery destination that is associated with this delivery.
delivery_destination_typestringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
tagsarrayThe tags that have been assigned to this delivery.
regionstringAWS region.
stringThe unique ID that identifies this delivery in your account.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
stringThe name of the delivery source that is associated with this delivery.
stringThe ARN of the delivery destination that is associated with this delivery.
stringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
arrayThe tags that have been assigned to this delivery.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual delivery resource, use deli Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destination/index.md b/docs/aws-docs/providers/aws/logs/delivery_destination/index.md index 4518b6ce46..9c1d333c4d 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_destination/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual delivery_destination resource, use delivery_destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual delivery_destination resource, us Namedelivery_destination TypeResource DescriptionThis structure contains information about one delivery destination in your account.<br/><br/>A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations. -Idaws.logs.delivery_destination +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name of this delivery destination.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
destination_resource_arnstringThe ARN of the AWS resource that will receive the logs.
tagsarrayThe tags that have been assigned to this delivery destination.
delivery_destination_typestringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
delivery_destination_policyobjectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 51200
regionstringAWS region.
stringThe name of this delivery destination.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
stringThe ARN of the AWS resource that will receive the logs.
arrayThe tags that have been assigned to this delivery destination.
stringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
objectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 51200
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual delivery_destination resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md index 649616a954..eb9096eb6d 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of delivery_destinations in a region or create a delivery_destinations resource, use delivery_destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of delivery_destinations in a region or cre Namedelivery_destinations TypeResource DescriptionThis structure contains information about one delivery destination in your account.<br/><br/>A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations. -Idaws.logs.delivery_destinations +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of this delivery destination.
regionstringAWS region.
stringThe name of this delivery destination.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of delivery_destinations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/delivery_source/index.md b/docs/aws-docs/providers/aws/logs/delivery_source/index.md index 99b6c958f7..db6384120a 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_source/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual delivery_source resource, use delivery_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual delivery_source resource, use Namedelivery_source TypeResource Description A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.<br/><br/>Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html). -Idaws.logs.delivery_source +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringThe unique name of the Log source.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
resource_arnsarrayThis array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
resource_arnstringThe ARN of the resource that will be sending the logs.
servicestringThe AWS service that is sending logs.
log_typestringThe type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.
tagsarrayThe tags that have been assigned to this delivery source.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual delivery_source resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/delivery_sources/index.md b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md index 691c56a395..22ed2bc70d 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_sources/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of delivery_sources in a region or create a delivery_sources resource, use delivery_source to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of delivery_sources in a region or create a Namedelivery_sources TypeResource Description A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.<br/><br/>Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html). -Idaws.logs.delivery_sources +Id ## Fields - - + +
NameDatatypeDescription
namestringThe unique name of the Log source.
regionstringAWS region.
stringThe unique name of the Log source.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of delivery_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/destination/index.md b/docs/aws-docs/providers/aws/logs/destination/index.md index c89b67bb96..434c3dbe58 100644 --- a/docs/aws-docs/providers/aws/logs/destination/index.md +++ b/docs/aws-docs/providers/aws/logs/destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual destination resource, use destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual destination resource, use d Namedestination TypeResource DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events. -Idaws.logs.destination +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
destination_namestringThe name of the destination resource
destination_policystringAn IAM policy document that governs which AWS accounts can create subscription filters against this destination.
role_arnstringThe ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource
target_arnstringThe ARN of the physical target where the log events are delivered (for example, a Kinesis stream)
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual destination resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/destinations/index.md b/docs/aws-docs/providers/aws/logs/destinations/index.md index abb044b3c1..51a078c875 100644 --- a/docs/aws-docs/providers/aws/logs/destinations/index.md +++ b/docs/aws-docs/providers/aws/logs/destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of destinations in a region or create a destinations resource, use destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of destinations in a region or create a Namedestinations TypeResource DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events. -Idaws.logs.destinations +Id ## Fields - - + +
NameDatatypeDescription
destination_namestringThe name of the destination resource
regionstringAWS region.
stringThe name of the destination resource
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of destinations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md index e49c5f16f2..b31420d16f 100644 --- a/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual log_anomaly_detector resource, use log_anomaly_detectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual log_anomaly_detector resource, us Namelog_anomaly_detector TypeResource DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector. -Idaws.logs.log_anomaly_detector +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
account_idstringAccount ID for owner of detector
kms_key_idstringThe Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
detector_namestringName of detector
log_group_arn_listarrayList of Arns for the given log group
evaluation_frequencystringHow often log group is evaluated
filter_patternstring
anomaly_detector_statusstringCurrent status of detector.
anomaly_visibility_timenumber
creation_time_stampnumberWhen detector was created.
last_modified_time_stampnumberWhen detector was lsat modified.
anomaly_detector_arnstringARN of LogAnomalyDetector
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual log_anomaly_detector resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md index 9b259a8c31..60bf60ae63 100644 --- a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of log_anomaly_detectors in a region or create a log_anomaly_detectors resource, use log_anomaly_detector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of log_anomaly_detectors in a region or cre Namelog_anomaly_detectors TypeResource DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector. -Idaws.logs.log_anomaly_detectors +Id ## Fields - - + +
NameDatatypeDescription
anomaly_detector_arnstringARN of LogAnomalyDetector
regionstringAWS region.
stringARN of LogAnomalyDetector
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of log_anomaly_detectors in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/log_stream/index.md b/docs/aws-docs/providers/aws/logs/log_stream/index.md index 34f852ba93..af88027baa 100644 --- a/docs/aws-docs/providers/aws/logs/log_stream/index.md +++ b/docs/aws-docs/providers/aws/logs/log_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual log_stream resource, use log_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual log_stream resource, use lo Namelog_stream TypeResource DescriptionResource Type definition for AWS::Logs::LogStream -Idaws.logs.log_stream +Id ## Fields - - - + + +
NameDatatypeDescription
log_stream_namestringThe name of the log stream. The name must be unique wihtin the log group.
log_group_namestringThe name of the log group where the log stream is created.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Gets or operates on an individual log_stream resource, use lo Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/log_streams/index.md b/docs/aws-docs/providers/aws/logs/log_streams/index.md index 6818f2f703..ec955f5636 100644 --- a/docs/aws-docs/providers/aws/logs/log_streams/index.md +++ b/docs/aws-docs/providers/aws/logs/log_streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of log_streams in a region or create a log_streams resource, use log_stream to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of log_streams in a region or create a Namelog_streams TypeResource DescriptionResource Type definition for AWS::Logs::LogStream -Idaws.logs.log_streams +Id ## Fields - - - + + +
NameDatatypeDescription
log_group_namestringThe name of the log group where the log stream is created.
log_stream_namestringThe name of the log stream. The name must be unique wihtin the log group.
regionstringAWS region.
stringThe name of the log group where the log stream is created.
stringThe name of the log stream. The name must be unique wihtin the log group.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of log_streams in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/metric_filter/index.md b/docs/aws-docs/providers/aws/logs/metric_filter/index.md index 702ba8192b..32cca98c00 100644 --- a/docs/aws-docs/providers/aws/logs/metric_filter/index.md +++ b/docs/aws-docs/providers/aws/logs/metric_filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual metric_filter resource, use metric_filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual metric_filter resource, use Namemetric_filter TypeResource DescriptionThe ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.<br/> The maximum number of metric filters that can be associated with a log group is 100. -Idaws.logs.metric_filter +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
metric_transformationsarrayThe metric transformations.
filter_patternstringA filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
log_group_namestringThe name of an existing log group that you want to associate with this metric filter.
filter_namestringThe name of the metric filter.
regionstringAWS region.
arrayThe metric transformations.
stringA filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe name of an existing log group that you want to associate with this metric filter.
stringThe name of the metric filter.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual metric_filter resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/metric_filters/index.md b/docs/aws-docs/providers/aws/logs/metric_filters/index.md index 1db6bdae18..84c99370e4 100644 --- a/docs/aws-docs/providers/aws/logs/metric_filters/index.md +++ b/docs/aws-docs/providers/aws/logs/metric_filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of metric_filters in a region or create a metric_filters resource, use metric_filter to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of metric_filters in a region or create a < Namemetric_filters TypeResource DescriptionThe ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.<br/> The maximum number of metric filters that can be associated with a log group is 100. -Idaws.logs.metric_filters +Id ## Fields - - - + + +
NameDatatypeDescription
log_group_namestringThe name of an existing log group that you want to associate with this metric filter.
filter_namestringThe name of the metric filter.
regionstringAWS region.
stringThe name of an existing log group that you want to associate with this metric filter.
stringThe name of the metric filter.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of metric_filters in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/query_definition/index.md b/docs/aws-docs/providers/aws/logs/query_definition/index.md index 2f3dddd86b..2bcc2dd7b0 100644 --- a/docs/aws-docs/providers/aws/logs/query_definition/index.md +++ b/docs/aws-docs/providers/aws/logs/query_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual query_definition resource, use query_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual query_definition resource, use Namequery_definition TypeResource DescriptionThe resource schema for AWSLogs QueryDefinition -Idaws.logs.query_definition +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringA name for the saved query definition
query_stringstringThe query string to use for this definition
log_group_namesarrayOptionally define specific log groups as part of your query definition
query_definition_idstringUnique identifier of a query definition
regionstringAWS region.
stringA name for the saved query definition
stringThe query string to use for this definition
arrayOptionally define specific log groups as part of your query definition
stringUnique identifier of a query definition
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual query_definition resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/query_definitions/index.md b/docs/aws-docs/providers/aws/logs/query_definitions/index.md index aa2115c488..8eb56c5089 100644 --- a/docs/aws-docs/providers/aws/logs/query_definitions/index.md +++ b/docs/aws-docs/providers/aws/logs/query_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of query_definitions in a region or create a query_definitions resource, use query_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of query_definitions in a region or create Namequery_definitions TypeResource DescriptionThe resource schema for AWSLogs QueryDefinition -Idaws.logs.query_definitions +Id ## Fields - - + +
NameDatatypeDescription
query_definition_idstringUnique identifier of a query definition
regionstringAWS region.
stringUnique identifier of a query definition
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of query_definitions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/resource_policies/index.md b/docs/aws-docs/providers/aws/logs/resource_policies/index.md index c319ea21c3..6ff78b2efb 100644 --- a/docs/aws-docs/providers/aws/logs/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/logs/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionThe resource schema for AWSLogs ResourcePolicy -Idaws.logs.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
policy_namestringA name for resource policy
regionstringAWS region.
stringA name for resource policy
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/logs/resource_policy/index.md b/docs/aws-docs/providers/aws/logs/resource_policy/index.md index 7b9b96b57a..07d0bcf637 100644 --- a/docs/aws-docs/providers/aws/logs/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/logs/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionThe resource schema for AWSLogs ResourcePolicy -Idaws.logs.resource_policy +Id ## Fields - - - + + +
NameDatatypeDescription
policy_namestringA name for resource policy
policy_documentstringThe policy document
regionstringAWS region.
stringA name for resource policy
stringThe policy document
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/subscription_filter/index.md b/docs/aws-docs/providers/aws/logs/subscription_filter/index.md index 27c46cb28e..2180596b19 100644 --- a/docs/aws-docs/providers/aws/logs/subscription_filter/index.md +++ b/docs/aws-docs/providers/aws/logs/subscription_filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subscription_filter resource, use subscription_filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual subscription_filter resource, use Namesubscription_filter TypeResource DescriptionThe ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:<br/> + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.<br/> + A logical destination that belongs to a different account, for cross-account delivery.<br/> + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.<br/> + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.<br/> <br/> There can be as many as two subscription filters associated with a log group. -Idaws.logs.subscription_filter +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
filter_namestringThe name of the subscription filter.
destination_arnstringThe Amazon Resource Name (ARN) of the destination.
filter_patternstringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
log_group_namestringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
role_arnstringThe ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
distributionstringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
regionstringAWS region.
stringThe name of the subscription filter.
stringThe Amazon Resource Name (ARN) of the destination.
stringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
stringThe ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
stringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual subscription_filter resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/logs/subscription_filters/index.md b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md index 22b0629bb4..6027eb381f 100644 --- a/docs/aws-docs/providers/aws/logs/subscription_filters/index.md +++ b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subscription_filters in a region or create a subscription_filters resource, use subscription_filter to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of subscription_filters in a region or crea Namesubscription_filters TypeResource DescriptionThe ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:<br/> + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.<br/> + A logical destination that belongs to a different account, for cross-account delivery.<br/> + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.<br/> + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.<br/> <br/> There can be as many as two subscription filters associated with a log group. -Idaws.logs.subscription_filters +Id ## Fields - - - + + +
NameDatatypeDescription
filter_namestringThe name of the subscription filter.
log_group_namestringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of subscription_filters in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md index f453de4db1..d81195181b 100644 --- a/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual inference_scheduler resource, use inference_schedulers to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual inference_scheduler resource, use Nameinference_scheduler TypeResource DescriptionResource schema for LookoutEquipment InferenceScheduler. -Idaws.lookoutequipment.inference_scheduler +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
data_delay_offset_in_minutesintegerA period of time (in minutes) by which inference on the data is delayed after the data starts.
data_input_configurationobjectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
data_output_configurationobjectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
data_upload_frequencystringHow often data is uploaded to the source S3 bucket for the input data.
inference_scheduler_namestringThe name of the inference scheduler being created.
model_namestringThe name of the previously trained ML model being used to create the inference scheduler.
role_arnstringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
server_side_kms_key_idstringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
tagsarrayAny tags associated with the inference scheduler.
inference_scheduler_arnstringThe Amazon Resource Name (ARN) of the inference scheduler being created.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual inference_scheduler resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md index 0a2f1a97cd..cbbd832e0c 100644 --- a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of inference_schedulers in a region or create a inference_schedulers resource, use inference_scheduler to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of inference_schedulers in a region or crea Nameinference_schedulers TypeResource DescriptionResource schema for LookoutEquipment InferenceScheduler. -Idaws.lookoutequipment.inference_schedulers +Id ## Fields - - + +
NameDatatypeDescription
inference_scheduler_namestringThe name of the inference scheduler being created.
regionstringAWS region.
stringThe name of the inference scheduler being created.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of inference_schedulers in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md index 2cea22f899..db66699ad4 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual alert resource, use alerts to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual alert resource, use alerts< Namealert TypeResource DescriptionResource Type definition for AWS::LookoutMetrics::Alert -Idaws.lookoutmetrics.alert +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
alert_namestringThe name of the alert. If not provided, a name is generated automatically.
arnstringARN assigned to the alert.
alert_descriptionstringA description for the alert.
anomaly_detector_arnstringThe Amazon resource name (ARN) of the Anomaly Detector to alert.
alert_sensitivity_thresholdintegerA number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
actionobjectThe action to be taken by the alert when an anomaly is detected.
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual alert resource, use alerts< Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md index d1fcdcc522..e98c67dcb3 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of alerts in a region or create a alerts resource, use alert to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of alerts in a region or create a ale Namealerts TypeResource DescriptionResource Type definition for AWS::LookoutMetrics::Alert -Idaws.lookoutmetrics.alerts +Id ## Fields - - + +
NameDatatypeDescription
arnundefinedARN assigned to the alert.
regionstringAWS region.
undefinedARN assigned to the alert.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of alerts in a region or create a ale Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md index 37cdda8dec..fe197f0922 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual anomaly_detector resource, use anomaly_detectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual anomaly_detector resource, use Nameanomaly_detector TypeResource DescriptionAn Amazon Lookout for Metrics Detector -Idaws.lookoutmetrics.anomaly_detector +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
anomaly_detector_namestringName for the Amazon Lookout for Metrics Anomaly Detector
anomaly_detector_descriptionstringA description for the AnomalyDetector.
anomaly_detector_configobjectConfiguration options for the AnomalyDetector
metric_set_listarrayList of metric sets for anomaly detection
kms_key_arnstringKMS key used to encrypt the AnomalyDetector data
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual anomaly_detector resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md index d598aaa381..921bb87d8e 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of anomaly_detectors in a region or create a anomaly_detectors resource, use anomaly_detector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of anomaly_detectors in a region or create Nameanomaly_detectors TypeResource DescriptionAn Amazon Lookout for Metrics Detector -Idaws.lookoutmetrics.anomaly_detectors +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of anomaly_detectors in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/lookoutvision/project/index.md b/docs/aws-docs/providers/aws/lookoutvision/project/index.md index 357cb7831d..a8e533964c 100644 --- a/docs/aws-docs/providers/aws/lookoutvision/project/index.md +++ b/docs/aws-docs/providers/aws/lookoutvision/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model. -Idaws.lookoutvision.project +Id ## Fields - - - + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/lookoutvision/projects/index.md b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md index 7ed5ca363c..8a6b861a99 100644 --- a/docs/aws-docs/providers/aws/lookoutvision/projects/index.md +++ b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model. -Idaws.lookoutvision.projects +Id ## Fields - - + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/m2/application/index.md b/docs/aws-docs/providers/aws/m2/application/index.md index 859ed6b0a5..0c5a71bc10 100644 --- a/docs/aws-docs/providers/aws/m2/application/index.md +++ b/docs/aws-docs/providers/aws/m2/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment -Idaws.m2.application +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
application_arnstring
application_idstring
definitionundefined
descriptionstring
engine_typestring
kms_key_idstringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
namestring
role_arnstring
tagsobject
regionstringAWS region.
string
string
undefined
string
string
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
string
string
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/m2/applications/index.md b/docs/aws-docs/providers/aws/m2/applications/index.md index be882eb559..ac56986a9e 100644 --- a/docs/aws-docs/providers/aws/m2/applications/index.md +++ b/docs/aws-docs/providers/aws/m2/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment -Idaws.m2.applications +Id ## Fields - - + +
NameDatatypeDescription
application_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/m2/environment/index.md b/docs/aws-docs/providers/aws/m2/environment/index.md index a7220416cc..414be1f5c5 100644 --- a/docs/aws-docs/providers/aws/m2/environment/index.md +++ b/docs/aws-docs/providers/aws/m2/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionRepresents a runtime environment that can run migrated mainframe applications. -Idaws.m2.environment +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the environment.
engine_typestring
engine_versionstringThe version of the runtime engine for the environment.
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
environment_idstringThe unique identifier of the environment.
high_availability_configobject
instance_typestringThe type of instance underlying the environment.
kms_key_idstringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
namestringThe name of the environment.
preferred_maintenance_windowstringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
publicly_accessiblebooleanSpecifies whether the environment is publicly accessible.
security_group_idsarrayThe list of security groups for the VPC associated with this environment.
storage_configurationsarrayThe storage configurations defined for the runtime environment.
subnet_idsarrayThe unique identifiers of the subnets assigned to this runtime environment.
tagsobjectTags associated to this environment.
regionstringAWS region.
stringThe description of the environment.
string
stringThe version of the runtime engine for the environment.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringThe unique identifier of the environment.
object
stringThe type of instance underlying the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
stringThe name of the environment.
stringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
booleanSpecifies whether the environment is publicly accessible.
arrayThe list of security groups for the VPC associated with this environment.
arrayThe storage configurations defined for the runtime environment.
arrayThe unique identifiers of the subnets assigned to this runtime environment.
objectTags associated to this environment.
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/m2/environments/index.md b/docs/aws-docs/providers/aws/m2/environments/index.md index 9c96794713..6e57ab60c6 100644 --- a/docs/aws-docs/providers/aws/m2/environments/index.md +++ b/docs/aws-docs/providers/aws/m2/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionRepresents a runtime environment that can run migrated mainframe applications. -Idaws.m2.environments +Id ## Fields - - + +
NameDatatypeDescription
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/macie/allow_list/index.md b/docs/aws-docs/providers/aws/macie/allow_list/index.md index be4135ba61..24dfee0ee9 100644 --- a/docs/aws-docs/providers/aws/macie/allow_list/index.md +++ b/docs/aws-docs/providers/aws/macie/allow_list/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual allow_list resource, use allow_lists to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual allow_list resource, use al Nameallow_list TypeResource DescriptionMacie AllowList resource schema -Idaws.macie.allow_list +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringName of AllowList.
descriptionstringDescription of AllowList.
criteriaobjectAllowList criteria.
idstringAllowList ID.
arnstringAllowList ARN.
statusstringAllowList status.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
stringName of AllowList.
stringDescription of AllowList.
objectAllowList criteria.
stringAllowList ID.
stringAllowList ARN.
stringAllowList status.
arrayA collection of tags associated with a resource
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual allow_list resource, use al Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/macie/allow_lists/index.md b/docs/aws-docs/providers/aws/macie/allow_lists/index.md index 45f79c70c7..93b72bf7ba 100644 --- a/docs/aws-docs/providers/aws/macie/allow_lists/index.md +++ b/docs/aws-docs/providers/aws/macie/allow_lists/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of allow_lists in a region or create a allow_lists resource, use allow_list to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of allow_lists in a region or create a Nameallow_lists TypeResource DescriptionMacie AllowList resource schema -Idaws.macie.allow_lists +Id ## Fields - - + +
NameDatatypeDescription
idstringAllowList ID.
regionstringAWS region.
stringAllowList ID.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of allow_lists in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md index 9bfa691c0d..86225ca1ad 100644 --- a/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual custom_data_identifier resource, use custom_data_identifiers to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual custom_data_identifier resource, Namecustom_data_identifier TypeResource DescriptionMacie CustomDataIdentifier resource schema -Idaws.macie.custom_data_identifier +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringName of custom data identifier.
descriptionstringDescription of custom data identifier.
regexstringRegular expression for custom data identifier.
maximum_match_distanceintegerMaximum match distance.
keywordsarrayKeywords to be matched against.
ignore_wordsarrayWords to be ignored.
idstringCustom data identifier ID.
arnstringCustom data identifier ARN.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual custom_data_identifier resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md index 6e8f99879c..2c086ca34c 100644 --- a/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of custom_data_identifiers in a region or create a custom_data_identifiers resource, use custom_data_identifier to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of custom_data_identifiers in a region or c Namecustom_data_identifiers TypeResource DescriptionMacie CustomDataIdentifier resource schema -Idaws.macie.custom_data_identifiers +Id ## Fields - - + +
NameDatatypeDescription
idstringCustom data identifier ID.
regionstringAWS region.
stringCustom data identifier ID.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of custom_data_identifiers in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/macie/findings_filter/index.md b/docs/aws-docs/providers/aws/macie/findings_filter/index.md index f5f8250b31..106aa459b5 100644 --- a/docs/aws-docs/providers/aws/macie/findings_filter/index.md +++ b/docs/aws-docs/providers/aws/macie/findings_filter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual findings_filter resource, use findings_filters to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual findings_filter resource, use Namefindings_filter TypeResource DescriptionMacie FindingsFilter resource schema. -Idaws.macie.findings_filter +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringFindings filter name
descriptionstringFindings filter description
finding_criteriaobjectFindings filter criteria.
actionstringFindings filter action.
positionintegerFindings filter position.
idstringFindings filter ID.
arnstringFindings filter ARN.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual findings_filter resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/macie/findings_filters/index.md b/docs/aws-docs/providers/aws/macie/findings_filters/index.md index 3db330942f..c152ed4935 100644 --- a/docs/aws-docs/providers/aws/macie/findings_filters/index.md +++ b/docs/aws-docs/providers/aws/macie/findings_filters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of findings_filters in a region or create a findings_filters resource, use findings_filter to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of findings_filters in a region or create a Namefindings_filters TypeResource DescriptionMacie FindingsFilter resource schema. -Idaws.macie.findings_filters +Id ## Fields - - + +
NameDatatypeDescription
idstringFindings filter ID.
regionstringAWS region.
stringFindings filter ID.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of findings_filters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/macie/session/index.md b/docs/aws-docs/providers/aws/macie/session/index.md index 7f1db90989..adefadea69 100644 --- a/docs/aws-docs/providers/aws/macie/session/index.md +++ b/docs/aws-docs/providers/aws/macie/session/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual session resource, use sessions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual session resource, use sessi Namesession TypeResource DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational. -Idaws.macie.session +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
aws_account_idstringAWS account ID of customer
statusstringA enumeration value that specifies the status of the Macie Session.
finding_publishing_frequencystringA enumeration value that specifies how frequently finding updates are published.
service_rolestringService role used by Macie
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual session resource, use sessi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/macie/sessions/index.md b/docs/aws-docs/providers/aws/macie/sessions/index.md index 3e0c4cc5a8..944d8ffa9c 100644 --- a/docs/aws-docs/providers/aws/macie/sessions/index.md +++ b/docs/aws-docs/providers/aws/macie/sessions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sessions in a region or create a sessions resource, use session to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of sessions in a region or create a s Namesessions TypeResource DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational. -Idaws.macie.sessions +Id ## Fields - - + +
NameDatatypeDescription
aws_account_idstringAWS account ID of customer
regionstringAWS region.
stringAWS account ID of customer
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of sessions in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md index cccd077363..177498e9ee 100644 --- a/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md +++ b/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual accessor resource, use accessors to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual accessor resource, use acce Nameaccessor TypeResource DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type -Idaws.managedblockchain.accessor +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
billing_tokenstring
creation_datestring
idstring
statusstring
accessor_typestring
network_typestring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual accessor resource, use acce Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md index 52714b38da..ff018f9bf4 100644 --- a/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md +++ b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of accessors in a region or create a accessors resource, use accessor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of accessors in a region or create a Nameaccessors TypeResource DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type -Idaws.managedblockchain.accessors +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of accessors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md index ecf2259cac..31787dd898 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bridge resource, use bridges to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual bridge resource, use bridge Namebridge TypeResource DescriptionResource schema for AWS::MediaConnect::Bridge -Idaws.mediaconnect.bridge +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the bridge.
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
placement_arnstringThe placement Amazon Resource Number (ARN) of the bridge.
bridge_statestring
source_failover_configobject
outputsarrayThe outputs on this bridge.
sourcesarrayThe sources on this bridge.
ingress_gateway_bridgeobject
egress_gateway_bridgeobject
regionstringAWS region.
stringThe name of the bridge.
stringThe Amazon Resource Number (ARN) of the bridge.
stringThe placement Amazon Resource Number (ARN) of the bridge.
string
object
arrayThe outputs on this bridge.
arrayThe sources on this bridge.
object
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual bridge resource, use bridge Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md index 8d5f0125fb..ece59014f8 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bridge_output resource, use bridge_outputs to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual bridge_output resource, use Namebridge_output TypeResource DescriptionResource schema for AWS::MediaConnect::BridgeOutput -Idaws.mediaconnect.bridge_output +Id ## Fields - - - - + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
network_outputobjectThe output of the bridge.
namestringThe network output name.
regionstringAWS region.
stringThe Amazon Resource Number (ARN) of the bridge.
objectThe output of the bridge.
stringThe network output name.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual bridge_output resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md index 6bf71d6cae..bd01227b07 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bridge_outputs in a region or create a bridge_outputs resource, use bridge_output to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of bridge_outputs in a region or create a < Namebridge_outputs TypeResource DescriptionResource schema for AWS::MediaConnect::BridgeOutput -Idaws.mediaconnect.bridge_outputs +Id ## Fields - - - + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe network output name.
regionstringAWS region.
stringThe Amazon Resource Number (ARN) of the bridge.
stringThe network output name.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of bridge_outputs in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md index 164e8ba708..e259ddc714 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bridge_source resource, use bridge_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual bridge_source resource, use Namebridge_source TypeResource DescriptionResource schema for AWS::MediaConnect::BridgeSource -Idaws.mediaconnect.bridge_source +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringThe name of the source.
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
flow_sourceobject
network_sourceobject
regionstringAWS region.
stringThe name of the source.
stringThe Amazon Resource Number (ARN) of the bridge.
object
object
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual bridge_source resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md index 5256130236..030d87a54b 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bridge_sources in a region or create a bridge_sources resource, use bridge_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of bridge_sources in a region or create a < Namebridge_sources TypeResource DescriptionResource schema for AWS::MediaConnect::BridgeSource -Idaws.mediaconnect.bridge_sources +Id ## Fields - - - + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe name of the source.
regionstringAWS region.
stringThe Amazon Resource Number (ARN) of the bridge.
stringThe name of the source.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of bridge_sources in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md index fca079b9b6..b11cb0a356 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bridges in a region or create a bridges resource, use bridge to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of bridges in a region or create a br Namebridges TypeResource DescriptionResource schema for AWS::MediaConnect::Bridge -Idaws.mediaconnect.bridges +Id ## Fields - - + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
regionstringAWS region.
stringThe Amazon Resource Number (ARN) of the bridge.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of bridges in a region or create a br Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow/index.md index c11eb2fe7f..e1feace6ca 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow resource, use flows to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual flow resource, use flowsNameflow TypeResource DescriptionResource schema for AWS::MediaConnect::Flow -Idaws.mediaconnect.flow +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringThe name of the flow.
availability_zonestringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
flow_availability_zonestringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)
sourceobjectThe source of the flow.
source_failover_configobjectThe source failover config of the flow.
regionstringAWS region.
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
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.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual flow resource, use flowsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md index 6f23f04c34..1b514f1f1c 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow_entitlement resource, use flow_entitlements to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual flow_entitlement resource, use Nameflow_entitlement TypeResource DescriptionResource schema for AWS::MediaConnect::FlowEntitlement -Idaws.mediaconnect.flow_entitlement +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe ARN of the flow.
entitlement_arnstringThe ARN of the entitlement.
data_transfer_subscriber_fee_percentintegerPercentage from 0-100 of the data transfer cost to be billed to the subscriber.
descriptionstringA description of the entitlement.
encryptionobjectThe type of encryption that will be used on the output that is associated with this entitlement.
entitlement_statusstring An indication of whether the entitlement is enabled.
namestringThe name of the entitlement.
subscribersarrayThe AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
regionstringAWS region.
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.
string An 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.
@@ -48,19 +51,19 @@ Gets or operates on an individual flow_entitlement resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md index 45569835b4..1a288462e3 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flow_entitlements in a region or create a flow_entitlements resource, use flow_entitlement to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flow_entitlements in a region or create Nameflow_entitlements TypeResource DescriptionResource schema for AWS::MediaConnect::FlowEntitlement -Idaws.mediaconnect.flow_entitlements +Id ## Fields - - + +
NameDatatypeDescription
entitlement_arnstringThe ARN of the entitlement.
regionstringAWS region.
stringThe ARN of the entitlement.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flow_entitlements in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md index 1b62c1c63f..6253e3d256 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow_output resource, use flow_outputs to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual flow_output resource, use f Nameflow_output TypeResource DescriptionResource schema for AWS::MediaConnect::FlowOutput -Idaws.mediaconnect.flow_output +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
output_arnstringThe ARN of the output.
cidr_allow_listarrayThe range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
encryptionobjectThe type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
descriptionstringA description of the output.
destinationstringThe address where you want to send the output.
max_latencyintegerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latencyintegerThe minimum latency in milliseconds.
namestringThe name of the output. This value must be unique within the current flow.
portintegerThe port to use when content is distributed to this output.
protocolstringThe protocol that is used by the source or output.
remote_idstringThe remote ID for the Zixi-pull stream.
smoothing_latencyintegerThe smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
stream_idstringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpc_interface_attachmentobjectThe name of the VPC interface attachment to use for this output.
regionstringAWS region.
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.
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual flow_output resource, use f Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md index e5a84afcb7..45c1e89b33 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flow_outputs in a region or create a flow_outputs resource, use flow_output to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flow_outputs in a region or create a Nameflow_outputs TypeResource DescriptionResource schema for AWS::MediaConnect::FlowOutput -Idaws.mediaconnect.flow_outputs +Id ## Fields - - + +
NameDatatypeDescription
output_arnstringThe ARN of the output.
regionstringAWS region.
stringThe ARN of the output.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flow_outputs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md index 758fbef74c..ddd60cbcba 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow_source resource, use flow_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,34 +24,34 @@ Gets or operates on an individual flow_source resource, use f Nameflow_source TypeResource DescriptionResource schema for AWS::MediaConnect::FlowSource -Idaws.mediaconnect.flow_source +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe ARN of the flow.
source_arnstringThe ARN of the source.
decryptionobjectThe type of encryption that is used on the content ingested from this source.
descriptionstringA description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
entitlement_arnstringThe ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
gateway_bridge_sourceobjectThe source configuration for cloud flows receiving a stream from a bridge.
ingest_ipstringThe IP address that the flow will be listening on for incoming content.
ingest_portintegerThe port that the flow will be listening on for incoming content.
max_bitrateintegerThe smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
max_latencyintegerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latencyintegerThe minimum latency in milliseconds.
namestringThe name of the source.
protocolstringThe protocol that is used by the source.
sender_ip_addressstringThe IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sender_control_portintegerThe port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
stream_idstringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
source_ingest_portstringThe port that the flow will be listening on for incoming content.(ReadOnly)
source_listener_addressstringSource IP or domain name for SRT-caller protocol.
source_listener_portintegerSource port for SRT-caller protocol.
vpc_interface_namestringThe name of the VPC Interface this Source is configured with.
whitelist_cidrstringThe range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
regionstringAWS region.
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.
@@ -61,19 +64,19 @@ Gets or operates on an individual flow_source resource, use f Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md index a4283ba4fe..9d6b041bbb 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flow_sources in a region or create a flow_sources resource, use flow_source to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flow_sources in a region or create a Nameflow_sources TypeResource DescriptionResource schema for AWS::MediaConnect::FlowSource -Idaws.mediaconnect.flow_sources +Id ## Fields - - + +
NameDatatypeDescription
source_arnstringThe ARN of the source.
regionstringAWS region.
stringThe ARN of the source.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flow_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md index af6182e420..31b46013af 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual flow_vpc_interface resource, use flow_vpc_interfaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual flow_vpc_interface resource, use Nameflow_vpc_interface TypeResource DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface -Idaws.mediaconnect.flow_vpc_interface +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringImmutable and has to be a unique against other VpcInterfaces in this Flow.
role_arnstringRole Arn MediaConnect can assumes to create ENIs in customer's account.
security_group_idsarraySecurity Group IDs to be used on ENI.
subnet_idstringSubnet must be in the AZ of the Flow
network_interface_idsarrayIDs of the network interfaces created in customer's account by MediaConnect.
regionstringAWS region.
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 assumes 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.
@@ -46,19 +49,19 @@ Gets or operates on an individual flow_vpc_interface resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md index f67c00cac1..7a83ad2a41 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flow_vpc_interfaces in a region or create a flow_vpc_interfaces resource, use flow_vpc_interface to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of flow_vpc_interfaces in a region or creat Nameflow_vpc_interfaces TypeResource DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface -Idaws.mediaconnect.flow_vpc_interfaces +Id ## Fields - - - + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringImmutable and has to be a unique against other VpcInterfaces in this Flow.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of flow_vpc_interfaces in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flows/index.md b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md index 3696287875..4b4f3487ce 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flows/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of flows in a region or create a flows resource, use flow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of flows in a region or create a flow Nameflows TypeResource DescriptionResource schema for AWS::MediaConnect::Flow -Idaws.mediaconnect.flows +Id ## Fields - - + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
regionstringAWS region.
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of flows in a region or create a flow Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md index 24a892629d..55270fd2f1 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual gateway resource, use gateways to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual gateway resource, use gatew Namegateway TypeResource DescriptionResource schema for AWS::MediaConnect::Gateway -Idaws.mediaconnect.gateway +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringThe name of the gateway. This name can not be modified after the gateway is created.
gateway_arnstringThe Amazon Resource Name (ARN) of the gateway.
gateway_statestringThe current status of the gateway.
egress_cidr_blocksarrayThe range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
networksarrayThe list of networks in the gateway.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual gateway resource, use gatew Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md index 36ace76955..9ca4d75372 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of gateways in a region or create a gateways resource, use gateway to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of gateways in a region or create a g Namegateways TypeResource DescriptionResource schema for AWS::MediaConnect::Gateway -Idaws.mediaconnect.gateways +Id ## Fields - - + +
NameDatatypeDescription
gateway_arnstringThe Amazon Resource Name (ARN) of the gateway.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the gateway.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of gateways in a region or create a g Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/medialive/multiplex/index.md b/docs/aws-docs/providers/aws/medialive/multiplex/index.md index b45b79423c..956814020d 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplex/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplex/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual multiplex resource, use multiplexes to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual multiplex resource, use mul Namemultiplex TypeResource DescriptionResource schema for AWS::MediaLive::Multiplex -Idaws.medialive.multiplex +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe unique arn of the multiplex.
availability_zonesarrayA list of availability zones for the multiplex.
destinationsarrayA list of the multiplex output destinations.
idstringThe unique id of the multiplex.
multiplex_settingsobjectConfiguration for a multiplex event.
namestringName of multiplex.
pipelines_running_countintegerThe number of currently healthy pipelines.
program_countintegerThe number of programs in the multiplex.
statestring
tagsarrayA collection of key-value pairs.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual multiplex resource, use mul Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexes/index.md b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md index c91de0b10c..d7b630d126 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplexes/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of multiplexes in a region or create a multiplexes resource, use multiplex to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of multiplexes in a region or create a Namemultiplexes TypeResource DescriptionResource schema for AWS::MediaLive::Multiplex -Idaws.medialive.multiplexes +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique id of the multiplex.
regionstringAWS region.
stringThe unique id of the multiplex.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of multiplexes in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md index 3cbfc34004..5e2596a9f5 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual multiplexprogram resource, use multiplexprograms to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual multiplexprogram resource, use Namemultiplexprogram TypeResource DescriptionResource schema for AWS::MediaLive::Multiplexprogram -Idaws.medialive.multiplexprogram +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
channel_idstringThe MediaLive channel associated with the program.
multiplex_idstringThe ID of the multiplex that the program belongs to.
multiplex_program_settingsobjectThe settings for this multiplex program.
preferred_channel_pipelinestringThe settings for this multiplex program.
packet_identifiers_mapobjectThe packet identifier map for this multiplex program.
pipeline_detailsarrayContains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
program_namestringThe name of the multiplex program.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual multiplexprogram resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md index da60191ec5..a06307967c 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of multiplexprograms in a region or create a multiplexprograms resource, use multiplexprogram to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of multiplexprograms in a region or create Namemultiplexprograms TypeResource DescriptionResource schema for AWS::MediaLive::Multiplexprogram -Idaws.medialive.multiplexprograms +Id ## Fields - - - + + +
NameDatatypeDescription
program_namestringThe name of the multiplex program.
multiplex_idstringThe ID of the multiplex that the program belongs to.
regionstringAWS region.
stringThe name of the multiplex program.
stringThe ID of the multiplex that the program belongs to.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of multiplexprograms in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackage/asset/index.md b/docs/aws-docs/providers/aws/mediapackage/asset/index.md index df819ddc0c..2df54ace90 100644 --- a/docs/aws-docs/providers/aws/mediapackage/asset/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/asset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual asset resource, use assets to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual asset resource, use assets< Nameasset TypeResource DescriptionResource schema for AWS::MediaPackage::Asset -Idaws.mediapackage.asset +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Asset.
created_atstringThe time the Asset was initially submitted for Ingest.
egress_endpointsarrayThe list of egress endpoints available for the Asset.
idstringThe unique identifier for the Asset.
packaging_group_idstringThe ID of the PackagingGroup for the Asset.
resource_idstringThe resource ID to include in SPEKE key requests.
source_arnstringARN of the source object in S3.
source_role_arnstringThe IAM role_arn used to access the source S3 bucket.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -49,14 +52,14 @@ Gets or operates on an individual asset resource, use assets< Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackage/assets/index.md b/docs/aws-docs/providers/aws/mediapackage/assets/index.md index 8f1aa84573..e26c4a91c2 100644 --- a/docs/aws-docs/providers/aws/mediapackage/assets/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/assets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assets in a region or create a assets resource, use asset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assets in a region or create a ass Nameassets TypeResource DescriptionResource schema for AWS::MediaPackage::Asset -Idaws.mediapackage.assets +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique identifier for the Asset.
regionstringAWS region.
stringThe unique identifier for the Asset.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assets in a region or create a ass Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackage/channel/index.md b/docs/aws-docs/providers/aws/mediapackage/channel/index.md index 94ffaa817b..fe6b8cb7d0 100644 --- a/docs/aws-docs/providers/aws/mediapackage/channel/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel resource, use channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual channel resource, use chann Namechannel TypeResource DescriptionResource schema for AWS::MediaPackage::Channel -Idaws.mediapackage.channel +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) assigned to the Channel.
idstringThe ID of the Channel.
descriptionstringA short text description of the Channel.
hls_ingestobjectAn HTTP Live Streaming (HLS) ingest resource configuration.
tagsarrayA collection of tags associated with a resource
egress_access_logsobjectThe configuration parameters for egress access logging.
ingress_access_logsobjectThe configuration parameters for egress access logging.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual channel resource, use chann Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackage/channels/index.md b/docs/aws-docs/providers/aws/mediapackage/channels/index.md index bfbf7de33f..da66299ad4 100644 --- a/docs/aws-docs/providers/aws/mediapackage/channels/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channels in a region or create a channels resource, use channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channels in a region or create a c Namechannels TypeResource DescriptionResource schema for AWS::MediaPackage::Channel -Idaws.mediapackage.channels +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the Channel.
regionstringAWS region.
stringThe ID of the Channel.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channels in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md index f8c74c2fd7..7359ea75d8 100644 --- a/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual origin_endpoint resource, use origin_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual origin_endpoint resource, use Nameorigin_endpoint TypeResource DescriptionResource schema for AWS::MediaPackage::OriginEndpoint -Idaws.mediapackage.origin_endpoint +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
urlstringThe URL of the packaged OriginEndpoint for consumption.
idstringThe ID of the OriginEndpoint.
channel_idstringThe ID of the Channel the OriginEndpoint is associated with.
descriptionstringA short text description of the OriginEndpoint.
whitelistarrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
startover_window_secondsintegerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
time_delay_secondsintegerAmount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
manifest_namestringA short string appended to the end of the OriginEndpoint URL.
originationstringControl whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
authorizationobject
hls_packageobject
dash_packageobject
mss_packageobject
cmaf_packageobject
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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
object
object
object
object
arrayA collection of tags associated with a resource
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual origin_endpoint resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md index 6988fb4933..ad46c631b9 100644 --- a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of origin_endpoints in a region or create a origin_endpoints resource, use origin_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of origin_endpoints in a region or create a Nameorigin_endpoints TypeResource DescriptionResource schema for AWS::MediaPackage::OriginEndpoint -Idaws.mediapackage.origin_endpoints +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the OriginEndpoint.
regionstringAWS region.
stringThe ID of the OriginEndpoint.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of origin_endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md index dde2356e1a..7881faa4ca 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual packaging_configuration resource, use packaging_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual packaging_configuration resource, Namepackaging_configuration TypeResource DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration -Idaws.mediapackage.packaging_configuration +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingConfiguration.
packaging_group_idstringThe ID of a PackagingGroup.
arnstringThe ARN of the PackagingConfiguration.
cmaf_packageobjectA CMAF packaging configuration.
dash_packageobjectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
hls_packageobjectAn HTTP Live Streaming (HLS) packaging configuration.
mss_packageobjectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -48,14 +51,14 @@ Gets or operates on an individual packaging_configuration resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md index 4222976d8b..8ac0d1db5e 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of packaging_configurations in a region or create a packaging_configurations resource, use packaging_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of packaging_configurations in a region or Namepackaging_configurations TypeResource DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration -Idaws.mediapackage.packaging_configurations +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the PackagingConfiguration.
regionstringAWS region.
stringThe ID of the PackagingConfiguration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of packaging_configurations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md index 46367fdb5d..363ad1e362 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual packaging_group resource, use packaging_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual packaging_group resource, use Namepackaging_group TypeResource DescriptionResource schema for AWS::MediaPackage::PackagingGroup -Idaws.mediapackage.packaging_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingGroup.
arnstringThe ARN of the PackagingGroup.
domain_namestringThe fully qualified domain name for Assets in the PackagingGroup.
authorizationobjectCDN Authorization
tagsarrayA collection of tags associated with a resource
egress_access_logsobjectThe configuration parameters for egress access logging.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual packaging_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md index 4e43911e01..e5ab6b0f79 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of packaging_groups in a region or create a packaging_groups resource, use packaging_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of packaging_groups in a region or create a Namepackaging_groups TypeResource DescriptionResource schema for AWS::MediaPackage::PackagingGroup -Idaws.mediapackage.packaging_groups +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the PackagingGroup.
regionstringAWS region.
stringThe ID of the PackagingGroup.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of packaging_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md index c6ff2067ba..a2b316b435 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel resource, use channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual channel resource, use chann Namechannel TypeResource Description<p>Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.</p> -Idaws.mediapackagev2.channel +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
channel_namestring
created_atstring<p>The date and time the channel was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the channel.</p>
ingest_endpointsarray<p>The list of ingest endpoints.</p>
modified_atstring<p>The date and time the channel was modified.</p>
tagsarray
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
string
string
string<p>The date and time the channel was created.</p>
string<p>Enter any descriptive text that helps you to identify the channel.</p>
array<p>The list of ingest endpoints.</p>
string<p>The date and time the channel was modified.</p>
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual channel resource, use chann Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md index 473453ae6a..fff9eea8a3 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel_group resource, use channel_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual channel_group resource, use Namechannel_group TypeResource Description<p>Represents a channel group that facilitates the grouping of multiple channels.</p> -Idaws.mediapackagev2.channel_group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
created_atstring<p>The date and time the channel group was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the channel group.</p>
egress_domainstring<p>The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
modified_atstring<p>The date and time the channel group was modified.</p>
tagsarray
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
string
string<p>The date and time the channel group was created.</p>
string<p>Enter any descriptive text that helps you to identify the channel group.</p>
string<p>The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
string<p>The date and time the channel group was modified.</p>
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual channel_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md index b4a52f2d3b..c021e39616 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channel_groups in a region or create a channel_groups resource, use channel_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channel_groups in a region or create a < Namechannel_groups TypeResource Description<p>Represents a channel group that facilitates the grouping of multiple channels.</p> -Idaws.mediapackagev2.channel_groups +Id ## Fields - - + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channel_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md index ba053a9b12..5696a062b9 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channel_policies in a region or create a channel_policies resource, use channel_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of channel_policies in a region or create a Namechannel_policies TypeResource Description<p>Represents a resource-based policy that allows or denies access to a channel.</p> -Idaws.mediapackagev2.channel_policies +Id ## Fields - - - + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of channel_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md index 30121b3b17..9cea031b1e 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel_policy resource, use channel_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual channel_policy resource, use Namechannel_policy TypeResource Description<p>Represents a resource-based policy that allows or denies access to a channel.</p> -Idaws.mediapackagev2.channel_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
policyobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual channel_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md index 3ff8d3e4e0..8cb52ba463 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channels in a region or create a channels resource, use channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channels in a region or create a c Namechannels TypeResource Description<p>Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.</p> -Idaws.mediapackagev2.channels +Id ## Fields - - + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channels in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md index 17cf7f1b52..fcb41750ef 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual origin_endpoint resource, use origin_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual origin_endpoint resource, use Nameorigin_endpoint TypeResource Description<p>Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.</p> -Idaws.mediapackagev2.origin_endpoint +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
channel_namestring
container_typestring
created_atstring<p>The date and time the origin endpoint was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the origin endpoint.</p>
hls_manifestsarray<p>An HTTP live streaming (HLS) manifest configuration.</p>
low_latency_hls_manifestsarray<p>A low-latency HLS manifest configuration.</p>
modified_atstring<p>The date and time the origin endpoint was modified.</p>
origin_endpoint_namestring
segmentobject
startover_window_secondsinteger<p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).</p>
tagsarray
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
string
string
string
string<p>The date and time the origin endpoint was created.</p>
string<p>Enter any descriptive text that helps you to identify the origin endpoint.</p>
array<p>An HTTP live streaming (HLS) manifest configuration.</p>
array<p>A low-latency HLS manifest configuration.</p>
string<p>The date and time the origin endpoint was modified.</p>
string
object
integer<p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).</p>
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual origin_endpoint resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md index db7e51dd55..b6987719eb 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of origin_endpoint_policies in a region or create a origin_endpoint_policies resource, use origin_endpoint_policy to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of origin_endpoint_policies in a region or Nameorigin_endpoint_policies TypeResource Description<p>Represents a resource policy that allows or denies access to an origin endpoint.</p> -Idaws.mediapackagev2.origin_endpoint_policies +Id ## Fields - - - - + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of origin_endpoint_policies in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md index f86e06ed21..33529cf80f 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual origin_endpoint_policy resource, use origin_endpoint_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual origin_endpoint_policy resource, Nameorigin_endpoint_policy TypeResource Description<p>Represents a resource policy that allows or denies access to an origin endpoint.</p> -Idaws.mediapackagev2.origin_endpoint_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
policyobject
regionstringAWS region.
string
string
string
object
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual origin_endpoint_policy resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md index f37052e771..02b02af79c 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of origin_endpoints in a region or create a origin_endpoints resource, use origin_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of origin_endpoints in a region or create a Nameorigin_endpoints TypeResource Description<p>Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.</p> -Idaws.mediapackagev2.origin_endpoints +Id ## Fields - - + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) associated with the resource.</p>
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of origin_endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel/index.md b/docs/aws-docs/providers/aws/mediatailor/channel/index.md index 7a18c245be..0f36eb6ca0 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channel/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel resource, use channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual channel resource, use chann Namechannel TypeResource DescriptionDefinition of AWS::MediaTailor::Channel Resource Type -Idaws.mediatailor.channel +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the channel.</p>
audiencesarray<p>The list of audiences defined in channel.</p>
channel_namestring
filler_slateobject
log_configurationobject
outputsarray<p>The channel's output properties.</p>
playback_modestring
tagsarrayThe tags to assign to the channel.
tierstring
time_shift_configurationobject
regionstringAWS region.
string<p>The ARN of the channel.</p>
array<p>The list of audiences defined in channel.</p>
string
object
object
array<p>The channel's output properties.</p>
string
arrayThe tags to assign to the channel.
string
object
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual channel resource, use chann Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md index 5487f06dfe..4af8f546c3 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channel_policies in a region or create a channel_policies resource, use channel_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channel_policies in a region or create a Namechannel_policies TypeResource DescriptionDefinition of AWS::MediaTailor::ChannelPolicy Resource Type -Idaws.mediatailor.channel_policies +Id ## Fields - - + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channel_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md index 8ee8ffc6d7..2cab158d8a 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual channel_policy resource, use channel_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual channel_policy resource, use Namechannel_policy TypeResource DescriptionDefinition of AWS::MediaTailor::ChannelPolicy Resource Type -Idaws.mediatailor.channel_policy +Id ## Fields - - - + + +
NameDatatypeDescription
channel_namestring
policyobject<p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
regionstringAWS region.
string
object<p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual channel_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/channels/index.md b/docs/aws-docs/providers/aws/mediatailor/channels/index.md index df0035f1c2..5662ac7ff9 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channels/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of channels in a region or create a channels resource, use channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of channels in a region or create a c Namechannels TypeResource DescriptionDefinition of AWS::MediaTailor::Channel Resource Type -Idaws.mediatailor.channels +Id ## Fields - - + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of channels in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/live_source/index.md b/docs/aws-docs/providers/aws/mediatailor/live_source/index.md index d031e5717c..ed7cb87d0d 100644 --- a/docs/aws-docs/providers/aws/mediatailor/live_source/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/live_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual live_source resource, use live_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual live_source resource, use l Namelive_source TypeResource DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type -Idaws.mediatailor.live_source +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the live source.</p>
http_package_configurationsarray<p>A list of HTTP package configuration parameters for this live source.</p>
live_source_namestring
source_location_namestring
tagsarrayThe tags to assign to the live source.
regionstringAWS region.
string<p>The ARN of the live source.</p>
array<p>A list of HTTP package configuration parameters for this live source.</p>
string
string
arrayThe tags to assign to the live source.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual live_source resource, use l Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md index 090ab4a978..4c3ab8ca7f 100644 --- a/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of live_sources in a region or create a live_sources resource, use live_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of live_sources in a region or create a Namelive_sources TypeResource DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type -Idaws.mediatailor.live_sources +Id ## Fields - - - + + +
NameDatatypeDescription
live_source_namestring
source_location_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of live_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md index b1f4e2c55d..50acb040e5 100644 --- a/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual playback_configuration resource, use playback_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual playback_configuration resource, Nameplayback_configuration TypeResource DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration -Idaws.mediatailor.playback_configuration +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ad_decision_server_urlstringThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
avail_suppressionobjectThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
bumperobjectThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
cdn_configurationobjectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliasesundefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
dash_configurationobjectThe configuration for DASH content.
live_pre_roll_configurationobjectThe configuration for pre-roll ad insertion.
manifest_processing_rulesobjectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
namestringThe identifier for the playback configuration.
personalization_threshold_secondsintegerDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
session_initialization_endpoint_prefixstringThe URL that the player uses to initialize a session that uses client-side reporting.
hls_configurationobjectThe configuration for HLS content.
playback_configuration_arnstringThe Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefixstringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
slate_ad_urlstringThe URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
tagsarrayThe tags to assign to the playback configuration.
transcode_profile_namestringThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
video_content_source_urlstringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
regionstringAWS region.
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.
@@ -58,19 +61,19 @@ Gets or operates on an individual playback_configuration resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md index 70b7701df5..d0fa607ee4 100644 --- a/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of playback_configurations in a region or create a playback_configurations resource, use playback_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of playback_configurations in a region or c Nameplayback_configurations TypeResource DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration -Idaws.mediatailor.playback_configurations +Id ## Fields - - + +
NameDatatypeDescription
namestringThe identifier for the playback configuration.
regionstringAWS region.
stringThe identifier for the playback configuration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of playback_configurations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_location/index.md b/docs/aws-docs/providers/aws/mediatailor/source_location/index.md index b74f070575..ba9ef58728 100644 --- a/docs/aws-docs/providers/aws/mediatailor/source_location/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/source_location/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual source_location resource, use source_locations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual source_location resource, use Namesource_location TypeResource DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type -Idaws.mediatailor.source_location +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
access_configurationobject
arnstring<p>The ARN of the source location.</p>
default_segment_delivery_configurationobject
http_configurationobject
segment_delivery_configurationsarray<p>A list of the segment delivery configurations associated with this resource.</p>
source_location_namestring
tagsarrayThe tags to assign to the source location.
regionstringAWS region.
object
string<p>The ARN of the source location.</p>
object
object
array<p>A list of the segment delivery configurations associated with this resource.</p>
string
arrayThe tags to assign to the source location.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual source_location resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md index 8e865346c8..826a3dcaa7 100644 --- a/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of source_locations in a region or create a source_locations resource, use source_location to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of source_locations in a region or create a Namesource_locations TypeResource DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type -Idaws.mediatailor.source_locations +Id ## Fields - - + +
NameDatatypeDescription
source_location_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of source_locations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md index 5b8e6e536e..c6a7a216b9 100644 --- a/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vod_source resource, use vod_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual vod_source resource, use vo Namevod_source TypeResource DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type -Idaws.mediatailor.vod_source +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the VOD source.</p>
http_package_configurationsarray<p>A list of HTTP package configuration parameters for this VOD source.</p>
source_location_namestring
tagsarrayThe tags to assign to the VOD source.
vod_source_namestring
regionstringAWS region.
string<p>The ARN of the VOD source.</p>
array<p>A list of HTTP package configuration parameters for this VOD source.</p>
string
arrayThe tags to assign to the VOD source.
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual vod_source resource, use vo Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md index 84b554982e..55f4ae78d3 100644 --- a/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vod_sources in a region or create a vod_sources resource, use vod_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vod_sources in a region or create a Namevod_sources TypeResource DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type -Idaws.mediatailor.vod_sources +Id ## Fields - - - + + +
NameDatatypeDescription
source_location_namestring
vod_source_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vod_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/memorydb/acl/index.md b/docs/aws-docs/providers/aws/memorydb/acl/index.md index 0128a2d293..a2baf071da 100644 --- a/docs/aws-docs/providers/aws/memorydb/acl/index.md +++ b/docs/aws-docs/providers/aws/memorydb/acl/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual acl resource, use acls to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual acl resource, use aclsNameacl TypeResource DescriptionResource Type definition for AWS::MemoryDB::ACL -Idaws.memorydb.acl +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
statusstringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
acl_namestringThe name of the acl.
user_namesarrayList of users associated to this acl.
arnstringThe Amazon Resource Name (ARN) of the acl.
tagsarrayAn array of key-value pairs to apply to this cluster.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual acl resource, use aclsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/memorydb/acls/index.md b/docs/aws-docs/providers/aws/memorydb/acls/index.md index ca97c40198..bb3d035cc1 100644 --- a/docs/aws-docs/providers/aws/memorydb/acls/index.md +++ b/docs/aws-docs/providers/aws/memorydb/acls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of acls in a region or create a acls resource, use acl to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of acls in a region or create a acls< Nameacls TypeResource DescriptionResource Type definition for AWS::MemoryDB::ACL -Idaws.memorydb.acls +Id ## Fields - - + +
NameDatatypeDescription
acl_namestringThe name of the acl.
regionstringAWS region.
stringThe name of the acl.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of acls in a region or create a acls< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/memorydb/cluster/index.md b/docs/aws-docs/providers/aws/memorydb/cluster/index.md index de9807544c..541d2cb1e9 100644 --- a/docs/aws-docs/providers/aws/memorydb/cluster/index.md +++ b/docs/aws-docs/providers/aws/memorydb/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,41 +24,41 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster. -Idaws.memorydb.cluster +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
descriptionstringAn optional description of the cluster.
statusstringThe status of the cluster. For example, Available, Updating, Creating.
node_typestringThe compute and memory capacity of the nodes in the cluster.
num_shardsintegerThe number of shards the cluster will contain.
num_replicas_per_shardintegerThe number of replicas to apply to each shard. The limit is 5.
subnet_group_namestringThe name of the subnet group to be used for the cluster.
security_group_idsarrayOne or more Amazon VPC security groups associated with this cluster.
maintenance_windowstringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
parameter_group_namestringThe name of the parameter group associated with the cluster.
parameter_group_statusstringThe status of the parameter group used by the cluster.
portintegerThe port number on which each member of the cluster accepts connections.
snapshot_retention_limitintegerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshot_windowstringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
acl_namestringThe name of the Access Control List to associate with the cluster.
sns_topic_arnstringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
sns_topic_statusstringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
tls_enabledbooleanA flag that enables in-transit encryption when set to true.<br/><br/>You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
data_tieringstringEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
kms_key_idstringThe ID of the KMS key used to encrypt the cluster.
snapshot_arnsarrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
snapshot_namestringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
final_snapshot_namestringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
arnstringThe Amazon Resource Name (ARN) of the cluster.
engine_versionstringThe Redis engine version used by the cluster.
cluster_endpointobjectThe cluster endpoint.
auto_minor_version_upgradebooleanA flag that enables automatic minor version upgrade when set to true.<br/><br/>You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
tagsarrayAn array of key-value pairs to apply to this cluster.
regionstringAWS region.
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAn optional description of the cluster.
stringThe status of the cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the cluster.
integerThe number of shards the cluster will contain.
integerThe number of replicas to apply to each shard. The limit is 5.
stringThe name of the subnet group to be used for the cluster.
arrayOne or more Amazon VPC security groups associated with this cluster.
stringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
stringThe name of the parameter group associated with the cluster.
stringThe status of the parameter group used by the cluster.
integerThe port number on which each member of the cluster accepts connections.
integerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
stringThe name of the Access Control List to associate with the cluster.
stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
booleanA flag that enables in-transit encryption when set to true.<br/><br/>You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
stringEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
stringThe ID of the KMS key used to encrypt the cluster.
arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe Redis engine version used by the cluster.
objectThe cluster endpoint.
booleanA flag that enables automatic minor version upgrade when set to true.<br/><br/>You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
arrayAn array of key-value pairs to apply to this cluster.
stringAWS region.
@@ -68,19 +71,19 @@ Gets or operates on an individual cluster resource, use clust Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/memorydb/clusters/index.md b/docs/aws-docs/providers/aws/memorydb/clusters/index.md index cc906d1297..351ef4e192 100644 --- a/docs/aws-docs/providers/aws/memorydb/clusters/index.md +++ b/docs/aws-docs/providers/aws/memorydb/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster. -Idaws.memorydb.clusters +Id ## Fields - - + +
NameDatatypeDescription
cluster_namestringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
regionstringAWS region.
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md index 8a752ea04f..a963a254b8 100644 --- a/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md +++ b/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual parameter_group resource, use parameter_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual parameter_group resource, use Nameparameter_group TypeResource DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup. -Idaws.memorydb.parameter_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
familystringThe name of the parameter group family that this parameter group is compatible with.
descriptionstringA description of the parameter group.
tagsarrayAn array of key-value pairs to apply to this parameter group.
parametersobjectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
arnstringThe Amazon Resource Name (ARN) of the parameter group.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual parameter_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md index 7d005f1f81..47e9fde0a0 100644 --- a/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of parameter_groups in a region or create a parameter_groups resource, use parameter_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of parameter_groups in a region or create a Nameparameter_groups TypeResource DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup. -Idaws.memorydb.parameter_groups +Id ## Fields - - + +
NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
regionstringAWS region.
stringThe name of the parameter group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of parameter_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md index f4101701aa..b3ef9da22c 100644 --- a/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md +++ b/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subnet_group resource, use subnet_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual subnet_group resource, use Namesubnet_group TypeResource DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group. -Idaws.memorydb.subnet_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
subnet_group_namestringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
descriptionstringAn optional description of the subnet group.
subnet_idsarrayA list of VPC subnet IDs for the subnet group.
tagsarrayAn array of key-value pairs to apply to this subnet group.
arnstringThe Amazon Resource Name (ARN) of the subnet group.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual subnet_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md index 1a472ffc68..438acd7a0b 100644 --- a/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subnet_groups in a region or create a subnet_groups resource, use subnet_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subnet_groups in a region or create a Namesubnet_groups TypeResource DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group. -Idaws.memorydb.subnet_groups +Id ## Fields - - + +
NameDatatypeDescription
subnet_group_namestringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
regionstringAWS region.
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subnet_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/memorydb/user/index.md b/docs/aws-docs/providers/aws/memorydb/user/index.md index 59ca0f6981..25552d701e 100644 --- a/docs/aws-docs/providers/aws/memorydb/user/index.md +++ b/docs/aws-docs/providers/aws/memorydb/user/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user resource, use users to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual user resource, use usersNameuser TypeResource DescriptionResource Type definition for AWS::MemoryDB::User -Idaws.memorydb.user +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
statusstringIndicates the user status. Can be "active", "modifying" or "deleting".
user_namestringThe name of the user.
access_stringstringAccess permissions string used for this user account.
authentication_modeobject
arnstringThe Amazon Resource Name (ARN) of the user account.
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual user resource, use usersRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/memorydb/users/index.md b/docs/aws-docs/providers/aws/memorydb/users/index.md index 8cbf9db5a8..1e282c926c 100644 --- a/docs/aws-docs/providers/aws/memorydb/users/index.md +++ b/docs/aws-docs/providers/aws/memorydb/users/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of users in a region or create a users resource, use user to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of users in a region or create a user Nameusers TypeResource DescriptionResource Type definition for AWS::MemoryDB::User -Idaws.memorydb.users +Id ## Fields - - + +
NameDatatypeDescription
user_namestringThe name of the user.
regionstringAWS region.
stringThe name of the user.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of users in a region or create a user Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md index ded97029cf..b42689dc7e 100644 --- a/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual batch_scram_secret resource, use batch_scram_secrets to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual batch_scram_secret resource, use Namebatch_scram_secret TypeResource DescriptionResource Type definition for AWS::MSK::BatchScramSecret -Idaws.msk.batch_scram_secret +Id ## Fields - - - + + +
NameDatatypeDescription
cluster_arnstring
secret_arn_listarray
regionstringAWS region.
string
array
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual batch_scram_secret resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md index e5ec38f572..c73c2ce6c6 100644 --- a/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of batch_scram_secrets in a region or create a batch_scram_secrets resource, use batch_scram_secret to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of batch_scram_secrets in a region or creat Namebatch_scram_secrets TypeResource DescriptionResource Type definition for AWS::MSK::BatchScramSecret -Idaws.msk.batch_scram_secrets +Id ## Fields - - + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of batch_scram_secrets in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/cluster/index.md b/docs/aws-docs/providers/aws/msk/cluster/index.md index 094dfabfad..4e0321fc7d 100644 --- a/docs/aws-docs/providers/aws/msk/cluster/index.md +++ b/docs/aws-docs/providers/aws/msk/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionResource Type definition for AWS::MSK::Cluster -Idaws.msk.cluster +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
broker_node_group_infoobject
enhanced_monitoringstring
kafka_versionstring
number_of_broker_nodesinteger
encryption_infoobject
open_monitoringobject
cluster_namestring
arnstring
current_versionstringThe current version of the MSK cluster
client_authenticationobject
logging_infoobject
tagsobjectA key-value pair to associate with a resource.
configuration_infoobject
storage_modestring
regionstringAWS region.
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.
@@ -54,19 +57,19 @@ Gets or operates on an individual cluster resource, use clust Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/cluster_policies/index.md b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md index dc20455e82..ff8a2cd1de 100644 --- a/docs/aws-docs/providers/aws/msk/cluster_policies/index.md +++ b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cluster_policies in a region or create a cluster_policies resource, use cluster_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cluster_policies in a region or create a Namecluster_policies TypeResource DescriptionResource Type definition for AWS::MSK::ClusterPolicy -Idaws.msk.cluster_policies +Id ## Fields - - + +
NameDatatypeDescription
cluster_arnstringThe arn of the cluster for the resource policy.
regionstringAWS region.
stringThe arn of the cluster for the resource policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cluster_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/cluster_policy/index.md b/docs/aws-docs/providers/aws/msk/cluster_policy/index.md index d48b56fabb..9dbb618069 100644 --- a/docs/aws-docs/providers/aws/msk/cluster_policy/index.md +++ b/docs/aws-docs/providers/aws/msk/cluster_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster_policy resource, use cluster_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual cluster_policy resource, use Namecluster_policy TypeResource DescriptionResource Type definition for AWS::MSK::ClusterPolicy -Idaws.msk.cluster_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
policyobjectA policy document containing permissions to add to the specified cluster.
cluster_arnstringThe arn of the cluster for the resource policy.
current_versionstringThe current version of the policy attached to the specified cluster
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual cluster_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/clusters/index.md b/docs/aws-docs/providers/aws/msk/clusters/index.md index b76b6ec736..002d372e7a 100644 --- a/docs/aws-docs/providers/aws/msk/clusters/index.md +++ b/docs/aws-docs/providers/aws/msk/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionResource Type definition for AWS::MSK::Cluster -Idaws.msk.clusters +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/configuration/index.md b/docs/aws-docs/providers/aws/msk/configuration/index.md index a16135da36..a344967ebf 100644 --- a/docs/aws-docs/providers/aws/msk/configuration/index.md +++ b/docs/aws-docs/providers/aws/msk/configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration resource, use configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual configuration resource, use Nameconfiguration TypeResource DescriptionResource Type definition for AWS::MSK::Configuration -Idaws.msk.configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestring
descriptionstring
server_propertiesstring
kafka_versions_listarray
arnstring
latest_revisionobject
regionstringAWS region.
string
string
string
array
string
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual configuration resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/configurations/index.md b/docs/aws-docs/providers/aws/msk/configurations/index.md index c7f88e2899..7a93cf46cb 100644 --- a/docs/aws-docs/providers/aws/msk/configurations/index.md +++ b/docs/aws-docs/providers/aws/msk/configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configurations in a region or create a configurations resource, use configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configurations in a region or create a < Nameconfigurations TypeResource DescriptionResource Type definition for AWS::MSK::Configuration -Idaws.msk.configurations +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configurations in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/replicator/index.md b/docs/aws-docs/providers/aws/msk/replicator/index.md index c3d9507be1..1ab5dcc0c0 100644 --- a/docs/aws-docs/providers/aws/msk/replicator/index.md +++ b/docs/aws-docs/providers/aws/msk/replicator/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual replicator resource, use replicators to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual replicator resource, use re Namereplicator TypeResource DescriptionResource Type definition for AWS::MSK::Replicator -Idaws.msk.replicator +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
replicator_arnstringAmazon Resource Name for the created replicator.
replicator_namestringThe name of the replicator.
current_versionstringThe current version of the MSK replicator.
descriptionstringA summary description of the replicator.
kafka_clustersarraySpecifies a list of Kafka clusters which are targets of the replicator.
replication_info_listarrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
service_execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual replicator resource, use re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/replicators/index.md b/docs/aws-docs/providers/aws/msk/replicators/index.md index 84876089d6..14264d03ac 100644 --- a/docs/aws-docs/providers/aws/msk/replicators/index.md +++ b/docs/aws-docs/providers/aws/msk/replicators/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of replicators in a region or create a replicators resource, use replicator to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of replicators in a region or create a Namereplicators TypeResource DescriptionResource Type definition for AWS::MSK::Replicator -Idaws.msk.replicators +Id ## Fields - - + +
NameDatatypeDescription
replicator_arnstringAmazon Resource Name for the created replicator.
regionstringAWS region.
stringAmazon Resource Name for the created replicator.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of replicators in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md b/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md index 2cc5ee30fc..0ab07f72fe 100644 --- a/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md +++ b/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual serverless_cluster resource, use serverless_clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual serverless_cluster resource, use Nameserverless_cluster TypeResource DescriptionResource Type definition for AWS::MSK::ServerlessCluster -Idaws.msk.serverless_cluster +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
cluster_namestring
vpc_configsarray
client_authenticationobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
string
string
array
object
objectA key-value pair to associate with a resource.
stringAWS region.
@@ -45,14 +48,14 @@ Gets or operates on an individual serverless_cluster resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md index 8650940a2d..dafd050737 100644 --- a/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md +++ b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of serverless_clusters in a region or create a serverless_clusters resource, use serverless_cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of serverless_clusters in a region or creat Nameserverless_clusters TypeResource DescriptionResource Type definition for AWS::MSK::ServerlessCluster -Idaws.msk.serverless_clusters +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of serverless_clusters in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connection/index.md b/docs/aws-docs/providers/aws/msk/vpc_connection/index.md index 4a8ec38cfa..aa223bad74 100644 --- a/docs/aws-docs/providers/aws/msk/vpc_connection/index.md +++ b/docs/aws-docs/providers/aws/msk/vpc_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_connection resource, use vpc_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual vpc_connection resource, use Namevpc_connection TypeResource DescriptionResource Type definition for AWS::MSK::VpcConnection -Idaws.msk.vpc_connection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
authenticationstring
client_subnetsarray
target_cluster_arnstringThe Amazon Resource Name (ARN) of the target cluster
security_groupsarray
tagsobject
vpc_idstring
regionstringAWS region.
string
string
array
stringThe Amazon Resource Name (ARN) of the target cluster
array
object
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual vpc_connection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connections/index.md b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md index 7721eefe9b..0496f2ce04 100644 --- a/docs/aws-docs/providers/aws/msk/vpc_connections/index.md +++ b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_connections in a region or create a vpc_connections resource, use vpc_connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_connections in a region or create a Namevpc_connections TypeResource DescriptionResource Type definition for AWS::MSK::VpcConnection -Idaws.msk.vpc_connections +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/mwaa/environment/index.md b/docs/aws-docs/providers/aws/mwaa/environment/index.md index 2fbdb0f480..fce494889b 100644 --- a/docs/aws-docs/providers/aws/mwaa/environment/index.md +++ b/docs/aws-docs/providers/aws/mwaa/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,41 +24,41 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionResource schema for AWS::MWAA::Environment -Idaws.mwaa.environment +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
webserver_urlstring
execution_role_arnstring
kms_keystring
airflow_versionstring
source_bucket_arnstring
dag_s3_pathstring
plugins_s3_pathstring
plugins_s3_object_versionstring
requirements_s3_pathstring
requirements_s3_object_versionstring
startup_script_s3_pathstring
startup_script_s3_object_versionstring
airflow_configuration_optionsobjectKey/value pairs representing Airflow configuration variables.<br/> Keys are prefixed by their section:<br/><br/> [core]<br/> dags_folder={AIRFLOW_HOME}/dags<br/><br/> Would be represented as<br/><br/> "core.dags_folder": "{AIRFLOW_HOME}/dags"
environment_classstring
max_workersinteger
min_workersinteger
schedulersinteger
network_configurationobject
logging_configurationobject
weekly_maintenance_window_startstring
tagsobjectA map of tags for the environment.
webserver_access_modestring
endpoint_managementstring
celery_executor_queuestring
database_vpc_endpoint_servicestring
webserver_vpc_endpoint_servicestring
regionstringAWS region.
string
string
string
string
string
string
string
string
string
string
string
string
string
string
objectKey/value pairs representing Airflow configuration variables.<br/> Keys are prefixed by their section:<br/><br/> [core]<br/> dags_folder={AIRFLOW_HOME}/dags<br/><br/> Would be represented as<br/><br/> "core.dags_folder": "{AIRFLOW_HOME}/dags"
string
integer
integer
integer
object
object
string
objectA map of tags for the environment.
string
string
string
string
string
stringAWS region.
@@ -68,19 +71,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/mwaa/environments/index.md b/docs/aws-docs/providers/aws/mwaa/environments/index.md index 969d47531d..d6c32e2fa1 100644 --- a/docs/aws-docs/providers/aws/mwaa/environments/index.md +++ b/docs/aws-docs/providers/aws/mwaa/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionResource schema for AWS::MWAA::Environment -Idaws.mwaa.environments +Id ## Fields - - + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/neptune/db_cluster/index.md b/docs/aws-docs/providers/aws/neptune/db_cluster/index.md index 92ddc8ab80..ea77fee50f 100644 --- a/docs/aws-docs/providers/aws/neptune/db_cluster/index.md +++ b/docs/aws-docs/providers/aws/neptune/db_cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_cluster resource, use db_clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,42 +24,42 @@ Gets or operates on an individual db_cluster resource, use db Namedb_cluster TypeResource DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. -Idaws.neptune.db_cluster +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
endpointstringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
read_endpointstringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
cluster_resource_idstringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
associated_rolesarrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
availability_zonesarrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_periodintegerSpecifies the number of days for which automatic DB snapshots are retained.
copy_tags_to_snapshotbooleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
db_cluster_identifierstringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
db_cluster_parameter_group_namestringProvides the name of the DB cluster parameter group.
db_instance_parameter_group_namestringThe name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
db_portintegerThe port number on which the DB instances in the DB cluster accept connections. <br/><br/>If not specified, the default port used is `8182`. <br/><br/>Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
db_subnet_group_namestringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletion_protectionbooleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enable_cloudwatch_logs_exportsarraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
engine_versionstringIndicates the database engine version.
iam_auth_enabledbooleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kms_key_idstringIf `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
portstringThe port number on which the DB cluster accepts connections. For example: `8182`.
preferred_backup_windowstringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferred_maintenance_windowstringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restore_to_timestringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
restore_typestringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
serverless_scaling_configurationobjectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
snapshot_identifierstringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.<br/><br/>After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.<br/><br/>However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
source_db_cluster_identifierstringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
storage_encryptedbooleanIndicates whether the DB cluster is encrypted.<br/><br/>If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.<br/><br/>If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
tagsarrayThe tags assigned to this cluster.
use_latest_restorable_timebooleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
vpc_security_group_idsarrayProvides a list of VPC security groups that the DB cluster belongs to.
regionstringAWS region.
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. <br/><br/>If not specified, the default port used is `8182`. <br/><br/>Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
booleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
arraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
stringIndicates the database engine version.
booleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
stringIf `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
stringThe port number on which the DB cluster accepts connections. For example: `8182`.
stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
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.<br/><br/>After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.<br/><br/>However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
booleanIndicates whether the DB cluster is encrypted.<br/><br/>If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.<br/><br/>If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
arrayThe tags assigned to this cluster.
booleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.<br/><br/>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
arrayProvides a list of VPC security groups that the DB cluster belongs to.
stringAWS region.
@@ -69,19 +72,19 @@ Gets or operates on an individual db_cluster resource, use db Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/neptune/db_clusters/index.md b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md index 8681c4420c..6e2dba735f 100644 --- a/docs/aws-docs/providers/aws/neptune/db_clusters/index.md +++ b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_clusters in a region or create a db_clusters resource, use db_cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_clusters in a region or create a Namedb_clusters TypeResource DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. -Idaws.neptune.db_clusters +Id ## Fields - - + +
NameDatatypeDescription
db_cluster_identifierstringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_clusters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/neptunegraph/graph/index.md b/docs/aws-docs/providers/aws/neptunegraph/graph/index.md index d1c734bab2..34221cddee 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/graph/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/graph/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual graph resource, use graphs to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual graph resource, use graphs< Namegraph TypeResource DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph. -Idaws.neptunegraph.graph +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
deletion_protectionbooleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.<br/><br/>_Default_: If not specified, the default value is true.
graph_namestringContains a user-supplied name for the Graph. <br/><br/>If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.<br/><br/>_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
provisioned_memoryintegerMemory for the Graph.
public_connectivitybooleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.<br/><br/>When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.<br/><br/>When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.<br/><br/>_Default_: If not specified, the default value is false.
replica_countintegerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.<br/><br/>Replica Count should always be less than or equal to 2.<br/><br/>_Default_: If not specified, the default value is 1.
tagsarrayThe tags associated with this graph.
vector_search_configurationobjectVector Search Configuration
endpointstringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
graph_arnstringGraph resource ARN
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.
booleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.<br/><br/>_Default_: If not specified, the default value is true.
stringContains a user-supplied name for the Graph. <br/><br/>If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.<br/><br/>_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
integerMemory for the Graph.
booleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.<br/><br/>When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.<br/><br/>When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.<br/><br/>_Default_: If not specified, the default value is false.
integerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.<br/><br/>Replica Count should always be less than or equal to 2.<br/><br/>_Default_: If not specified, the default value is 1.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual graph resource, use graphs< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md index 941019a548..5b2921ce95 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of graphs in a region or create a graphs resource, use graph to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of graphs in a region or create a gra Namegraphs TypeResource DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph. -Idaws.neptunegraph.graphs +Id ## Fields - - + +
NameDatatypeDescription
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.
stringThe auto-generated id assigned by the service.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of graphs in a region or create a gra Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md index 106bf2af9f..73d878a7ba 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual private_graph_endpoint resource, use private_graph_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual private_graph_endpoint resource, Nameprivate_graph_endpoint TypeResource DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint. -Idaws.neptunegraph.private_graph_endpoint +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
graph_identifierstringThe auto-generated Graph Id assigned by the service.
security_group_idsarrayThe security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
subnet_idsarrayThe subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
vpc_idstringThe VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
private_graph_endpoint_identifierstringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.<br/><br/> For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
vpc_endpoint_idstringVPC endpoint that provides a private connection between the Graph and specified VPC.
regionstringAWS region.
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.<br/><br/> 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.
@@ -46,19 +49,19 @@ Gets or operates on an individual private_graph_endpoint resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md index 80b3d1dbba..1c5edec112 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of private_graph_endpoints in a region or create a private_graph_endpoints resource, use private_graph_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of private_graph_endpoints in a region or c Nameprivate_graph_endpoints TypeResource DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint. -Idaws.neptunegraph.private_graph_endpoints +Id ## Fields - - + +
NameDatatypeDescription
private_graph_endpoint_identifierstringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.<br/><br/> For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
regionstringAWS region.
stringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.<br/><br/> For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of private_graph_endpoints in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md index 1f110486c3..bde3bfeb34 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual firewall resource, use firewalls to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual firewall resource, use fire Namefirewall TypeResource DescriptionResource type definition for AWS::NetworkFirewall::Firewall -Idaws.networkfirewall.firewall +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
firewall_namestring
firewall_arnstring
firewall_idstring
firewall_policy_arnstring
vpc_idstring
subnet_mappingsarray
delete_protectionboolean
subnet_change_protectionboolean
firewall_policy_change_protectionboolean
descriptionstring
endpoint_idsarray
tagsarray
regionstringAWS region.
string
string
string
string
string
array
boolean
boolean
boolean
string
array
array
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual firewall resource, use fire Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md index 7de5b798d7..af40901acd 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of firewall_policies in a region or create a firewall_policies resource, use firewall_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of firewall_policies in a region or create Namefirewall_policies TypeResource DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy -Idaws.networkfirewall.firewall_policies +Id ## Fields - - + +
NameDatatypeDescription
firewall_policy_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of firewall_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md index 3058d33fc4..518255ab07 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual firewall_policy resource, use firewall_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual firewall_policy resource, use Namefirewall_policy TypeResource DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy -Idaws.networkfirewall.firewall_policy +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
firewall_policy_namestring
firewall_policy_arnstring
firewall_policyobject
firewall_policy_idstring
descriptionstring
tagsarray
regionstringAWS region.
string
string
object
string
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual firewall_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md index 421ea206df..ac4aad0be2 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of firewalls in a region or create a firewalls resource, use firewall to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of firewalls in a region or create a Namefirewalls TypeResource DescriptionResource type definition for AWS::NetworkFirewall::Firewall -Idaws.networkfirewall.firewalls +Id ## Fields - - + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of firewalls in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md index 208ec8c529..0d2b9857d9 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual logging_configuration resource, use logging_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual logging_configuration resource, u Namelogging_configuration TypeResource DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration -Idaws.networkfirewall.logging_configuration +Id ## Fields - - - - + + + +
NameDatatypeDescription
firewall_namestring
firewall_arnstring
logging_configurationobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual logging_configuration resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md index b2d71547a2..74ae8c4f81 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of logging_configurations in a region or create a logging_configurations resource, use logging_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of logging_configurations in a region or cr Namelogging_configurations TypeResource DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration -Idaws.networkfirewall.logging_configurations +Id ## Fields - - + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of logging_configurations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md index 3192dbb961..a904582c23 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule_group resource, use rule_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual rule_group resource, use ru Namerule_group TypeResource DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup -Idaws.networkfirewall.rule_group +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
rule_group_namestring
rule_group_arnstring
rule_group_idstring
rule_groupobject
typestring
capacityinteger
descriptionstring
tagsarray
regionstringAWS region.
string
string
string
object
string
integer
string
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual rule_group resource, use ru Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md index c434147122..33752e7fe5 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rule_groups in a region or create a rule_groups resource, use rule_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rule_groups in a region or create a Namerule_groups TypeResource DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup -Idaws.networkfirewall.rule_groups +Id ## Fields - - + +
NameDatatypeDescription
rule_group_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rule_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md index ecfce14a76..60dfd9abd8 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual tls_inspection_configuration resource, use tls_inspection_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual tls_inspection_configuration reso Nametls_inspection_configuration TypeResource DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration -Idaws.networkfirewall.tls_inspection_configuration +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
tls_inspection_configuration_namestring
tls_inspection_configuration_arnstring
tls_inspection_configurationobject
tls_inspection_configuration_idstring
descriptionstring
tagsarray
regionstringAWS region.
string
string
object
string
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual tls_inspection_configuration reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md index 41da336b0f..b7dd930319 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tls_inspection_configurations in a region or create a tls_inspection_configurations resource, use tls_inspection_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of tls_inspection_configurations in a regio Nametls_inspection_configurations TypeResource DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration -Idaws.networkfirewall.tls_inspection_configurations +Id ## Fields - - + +
NameDatatypeDescription
tls_inspection_configuration_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of tls_inspection_configurations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md index 02c3667fa4..ed2e321576 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connect_attachment resource, use connect_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual connect_attachment resource, use Nameconnect_attachment TypeResource DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition -Idaws.networkmanager.connect_attachment +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringID of the CoreNetwork that the attachment will be attached to.
core_network_arnstringThe ARN of a core network.
attachment_idstringThe ID of the attachment.
owner_account_idstringThe ID of the attachment account owner.
attachment_typestringThe type of attachment.
statestringState of the attachment.
edge_locationstringEdge location of the attachment.
resource_arnstringThe attachment resource ARN.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment attachment.
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
transport_attachment_idstringId of transport attachment
optionsobjectProtocol options for connect attachment
regionstringAWS region.
stringID of the CoreNetwork that the attachment will be attached to.
stringThe ARN of a core network.
stringThe ID of the attachment.
stringThe ID of the attachment account owner.
stringThe type of attachment.
stringState of the attachment.
stringEdge location of the attachment.
stringThe attachment resource ARN.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment.
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringId of transport attachment
objectProtocol options for connect attachment
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual connect_attachment resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md index 2a647c1d53..768fd8f3dc 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connect_attachments in a region or create a connect_attachments resource, use connect_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connect_attachments in a region or creat Nameconnect_attachments TypeResource DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition -Idaws.networkmanager.connect_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
stringThe ID of the attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connect_attachments in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md index 9ee549ba35..5ba6c18299 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connect_peer resource, use connect_peers to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual connect_peer resource, use Nameconnect_peer TypeResource DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition. -Idaws.networkmanager.connect_peer +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
peer_addressstringThe IP address of the Connect peer.
core_network_addressstringThe IP address of a core network.
bgp_optionsobjectBgp options for connect peer.
inside_cidr_blocksarrayThe inside IP addresses used for a Connect peer configuration.
core_network_idstringThe ID of the core network.
connect_attachment_idstringThe ID of the attachment to connect.
connect_peer_idstringThe ID of the Connect peer.
edge_locationstringThe Connect peer Regions where edges are located.
statestringState of the connect peer.
created_atstringConnect peer creation time.
configurationobjectConfiguration of the connect peer.
subnet_arnstringThe subnet ARN for the connect peer.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual connect_peer resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md index a0bcd80417..b373c1e2aa 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connect_peers in a region or create a connect_peers resource, use connect_peer to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connect_peers in a region or create a Nameconnect_peers TypeResource DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition. -Idaws.networkmanager.connect_peers +Id ## Fields - - + +
NameDatatypeDescription
connect_peer_idstringThe ID of the Connect peer.
regionstringAWS region.
stringThe ID of the Connect peer.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connect_peers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_network/index.md b/docs/aws-docs/providers/aws/networkmanager/core_network/index.md index aab9c6c5a3..c2711f03c1 100644 --- a/docs/aws-docs/providers/aws/networkmanager/core_network/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/core_network/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual core_network resource, use core_networks to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual core_network resource, use Namecore_network TypeResource DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition. -Idaws.networkmanager.core_network +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network that your core network is a part of.
core_network_idstringThe Id of core network
core_network_arnstringThe ARN (Amazon resource name) of core network
policy_documentobjectLive policy document for the core network, you must provide PolicyDocument in Json Format
descriptionstringThe description of core network
created_atstringThe creation time of core network
statestringThe state of core network
segmentsarrayThe segments within a core network.
edgesarrayThe edges within a core network.
owner_accountstringOwner of the core network
tagsarrayThe tags for the global network.
regionstringAWS region.
stringThe ID of the global network that your core network is a part of.
stringThe Id of core network
stringThe ARN (Amazon resource name) of core network
objectLive policy document for the core network, you must provide PolicyDocument in Json Format
stringThe description of core network
stringThe creation time of core network
stringThe state of core network
arrayThe segments within a core network.
arrayThe edges within a core network.
stringOwner of the core network
arrayThe tags for the global network.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual core_network resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md index d5ec6b1d3f..dedb1e610b 100644 --- a/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of core_networks in a region or create a core_networks resource, use core_network to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of core_networks in a region or create a Namecore_networks TypeResource DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition. -Idaws.networkmanager.core_networks +Id ## Fields - - + +
NameDatatypeDescription
core_network_idstringThe Id of core network
regionstringAWS region.
stringThe Id of core network
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of core_networks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md index 45ca380b0f..5e2cc146da 100644 --- a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual customer_gateway_association resource, use customer_gateway_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual customer_gateway_association reso Namecustomer_gateway_association TypeResource DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link. -Idaws.networkmanager.customer_gateway_association +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
customer_gateway_arnstringThe Amazon Resource Name (ARN) of the customer gateway.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual customer_gateway_association reso Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md index 57c94328f2..d7f695604f 100644 --- a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of customer_gateway_associations in a region or create a customer_gateway_associations resource, use customer_gateway_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of customer_gateway_associations in a regio Namecustomer_gateway_associations TypeResource DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link. -Idaws.networkmanager.customer_gateway_associations +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
customer_gateway_arnstringThe Amazon Resource Name (ARN) of the customer gateway.
regionstringAWS region.
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the customer gateway.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of customer_gateway_associations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/device/index.md b/docs/aws-docs/providers/aws/networkmanager/device/index.md index ff7c20bd14..091cf35c37 100644 --- a/docs/aws-docs/providers/aws/networkmanager/device/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/device/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual device resource, use devices to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual device resource, use device Namedevice TypeResource DescriptionThe AWS::NetworkManager::Device type describes a device. -Idaws.networkmanager.device +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
device_arnstringThe Amazon Resource Name (ARN) of the device.
device_idstringThe ID of the device.
descriptionstringThe description of the device.
tagsarrayThe tags for the device.
global_network_idstringThe ID of the global network.
aws_locationobjectThe Amazon Web Services location of the device, if applicable.
locationobjectThe site location.
modelstringThe device model
serial_numberstringThe device serial number.
site_idstringThe site ID.
typestringThe device type.
vendorstringThe device vendor.
created_atstringThe date and time that the device was created.
statestringThe state of the device.
regionstringAWS region.
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.
@@ -54,19 +57,19 @@ Gets or operates on an individual device resource, use device Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/devices/index.md b/docs/aws-docs/providers/aws/networkmanager/devices/index.md index 446c8b979f..bf0e0be10d 100644 --- a/docs/aws-docs/providers/aws/networkmanager/devices/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/devices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of devices in a region or create a devices resource, use device to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of devices in a region or create a de Namedevices TypeResource DescriptionThe AWS::NetworkManager::Device type describes a device. -Idaws.networkmanager.devices +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device.
regionstringAWS region.
stringThe ID of the global network.
stringThe ID of the device.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of devices in a region or create a de Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_network/index.md b/docs/aws-docs/providers/aws/networkmanager/global_network/index.md index d1d7c93c45..8e2d55f28b 100644 --- a/docs/aws-docs/providers/aws/networkmanager/global_network/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/global_network/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual global_network resource, use global_networks to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual global_network resource, use Nameglobal_network TypeResource DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account -Idaws.networkmanager.global_network +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the global network.
idstringThe ID of the global network.
descriptionstringThe description of the global network.
tagsarrayThe tags for the global network.
created_atstringThe date and time that the global network was created.
statestringThe state of the global network.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual global_network resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md index 102bba2209..2cb7cb55e1 100644 --- a/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of global_networks in a region or create a global_networks resource, use global_network to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of global_networks in a region or create a Nameglobal_networks TypeResource DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account -Idaws.networkmanager.global_networks +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the global network.
regionstringAWS region.
stringThe ID of the global network.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of global_networks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/link/index.md b/docs/aws-docs/providers/aws/networkmanager/link/index.md index 0e53fd66f4..dd0a0ceeb3 100644 --- a/docs/aws-docs/providers/aws/networkmanager/link/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/link/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual link resource, use links to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual link resource, use linksNamelink TypeResource DescriptionThe AWS::NetworkManager::Link type describes a link. -Idaws.networkmanager.link +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
link_arnstringThe Amazon Resource Name (ARN) of the link.
link_idstringThe ID of the link.
global_network_idstringThe ID of the global network.
site_idstringThe ID of the site
bandwidthobjectThe Bandwidth for the link.
providerstringThe provider of the link.
descriptionstringThe description of the link.
tagsarrayThe tags for the link.
typestringThe type of the link.
created_atstringThe date and time that the device was created.
statestringThe state of the link.
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual link resource, use linksRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/link_association/index.md b/docs/aws-docs/providers/aws/networkmanager/link_association/index.md index c61c0c9012..c22a4e3e16 100644 --- a/docs/aws-docs/providers/aws/networkmanager/link_association/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/link_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual link_association resource, use link_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual link_association resource, use Namelink_association TypeResource DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site. -Idaws.networkmanager.link_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
stringThe ID of the global network.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual link_association resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md index d187e0531b..f116e968de 100644 --- a/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of link_associations in a region or create a link_associations resource, use link_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of link_associations in a region or create Namelink_associations TypeResource DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site. -Idaws.networkmanager.link_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
stringThe ID of the global network.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of link_associations in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/links/index.md b/docs/aws-docs/providers/aws/networkmanager/links/index.md index 01d3bc936d..13427d1b48 100644 --- a/docs/aws-docs/providers/aws/networkmanager/links/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/links/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of links in a region or create a links resource, use link to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of links in a region or create a link Namelinks TypeResource DescriptionThe AWS::NetworkManager::Link type describes a link. -Idaws.networkmanager.links +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
link_idstringThe ID of the link.
regionstringAWS region.
stringThe ID of the global network.
stringThe ID of the link.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of links in a region or create a link Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/site/index.md b/docs/aws-docs/providers/aws/networkmanager/site/index.md index f905bd24ee..64073bf393 100644 --- a/docs/aws-docs/providers/aws/networkmanager/site/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/site/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual site resource, use sites to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual site resource, use sitesNamesite TypeResource DescriptionThe AWS::NetworkManager::Site type describes a site. -Idaws.networkmanager.site +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
site_arnstringThe Amazon Resource Name (ARN) of the site.
site_idstringThe ID of the site.
descriptionstringThe description of the site.
tagsarrayThe tags for the site.
global_network_idstringThe ID of the global network.
locationobjectThe location of the site.
created_atstringThe date and time that the device was created.
statestringThe state of the site.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual site resource, use sitesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md index 18c1439348..aeea9eee19 100644 --- a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual site_to_site_vpn_attachment resource, use site_to_site_vpn_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual site_to_site_vpn_attachment resou Namesite_to_site_vpn_attachment TypeResource DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition. -Idaws.networkmanager.site_to_site_vpn_attachment +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe ID of a core network where you're creating a site-to-site VPN attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringThe ID of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringThe type of attachment.
statestringThe state of the attachment.
edge_locationstringThe Region where the edge is located.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment that attachment is in.
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
vpn_connection_arnstringThe ARN of the site-to-site VPN attachment.
regionstringAWS region.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringThe ARN of the site-to-site VPN attachment.
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual site_to_site_vpn_attachment resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md index 48cf9d9748..864eddea5c 100644 --- a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of site_to_site_vpn_attachments in a region or create a site_to_site_vpn_attachments resource, use site_to_site_vpn_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of site_to_site_vpn_attachments in a region Namesite_to_site_vpn_attachments TypeResource DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition. -Idaws.networkmanager.site_to_site_vpn_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
stringThe ID of the attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of site_to_site_vpn_attachments in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/sites/index.md b/docs/aws-docs/providers/aws/networkmanager/sites/index.md index 13cc694e86..1ec36e033e 100644 --- a/docs/aws-docs/providers/aws/networkmanager/sites/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/sites/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sites in a region or create a sites resource, use site to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of sites in a region or create a site Namesites TypeResource DescriptionThe AWS::NetworkManager::Site type describes a site. -Idaws.networkmanager.sites +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
site_idstringThe ID of the site.
regionstringAWS region.
stringThe ID of the global network.
stringThe ID of the site.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of sites in a region or create a site Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md index 7ee023b065..92e0e2f06f 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_peering resource, use transit_gateway_peerings to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual transit_gateway_peering resource, Nametransit_gateway_peering TypeResource DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type. -Idaws.networkmanager.transit_gateway_peering +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe Id of the core network that you want to peer a transit gateway to.
core_network_arnstringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
transit_gateway_arnstringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
transit_gateway_peering_attachment_idstringThe ID of the TransitGatewayPeeringAttachment
peering_idstringThe Id of the transit gateway peering
statestringThe state of the transit gateway peering
edge_locationstringThe location of the transit gateway peering
resource_arnstringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
owner_account_idstringPeering owner account Id
peering_typestringPeering type (TransitGatewayPeering)
created_atstringThe creation time of the transit gateway peering
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual transit_gateway_peering resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md index adc4d7d78e..e176f436ce 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_peerings in a region or create a transit_gateway_peerings resource, use transit_gateway_peering to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_peerings in a region or Nametransit_gateway_peerings TypeResource DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type. -Idaws.networkmanager.transit_gateway_peerings +Id ## Fields - - + +
NameDatatypeDescription
peering_idstringThe Id of the transit gateway peering
regionstringAWS region.
stringThe Id of the transit gateway peering
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_peerings in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md index c3521959e1..68cd1d4fcd 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_registration resource, use transit_gateway_registrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual transit_gateway_registration reso Nametransit_gateway_registration TypeResource DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network. -Idaws.networkmanager.transit_gateway_registration +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
transit_gateway_arnstringThe Amazon Resource Name (ARN) of the transit gateway.
regionstringAWS region.
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the transit gateway.
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual transit_gateway_registration reso Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md index dc9845bb04..5e48d29e6f 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_registrations in a region or create a transit_gateway_registrations resource, use transit_gateway_registration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of transit_gateway_registrations in a regio Nametransit_gateway_registrations TypeResource DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network. -Idaws.networkmanager.transit_gateway_registrations +Id ## Fields - - - + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
transit_gateway_arnstringThe Amazon Resource Name (ARN) of the transit gateway.
regionstringAWS region.
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the transit gateway.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of transit_gateway_registrations in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md index 1a4255991d..452cab6e48 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual transit_gateway_route_table_attachment resource, use transit_gateway_route_table_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual transit_gateway_route_table_attachmentNametransit_gateway_route_table_attachment TypeResource DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition. -Idaws.networkmanager.transit_gateway_route_table_attachment +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
peering_idstringThe Id of peering between transit gateway and core network.
transit_gateway_route_table_arnstringThe Arn of transit gateway route table.
core_network_idstringThe ID of a core network where you're creating a site-to-site VPN attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringThe ID of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringThe type of attachment.
statestringThe state of the attachment.
edge_locationstringThe Region where the edge is located.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment that attachment is in.
proposed_segment_changeobjectThe attachment to move from one segment to another.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringThe Id of peering between transit gateway and core network.
stringThe Arn of transit gateway route table.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual transit_gateway_route_table_attachmentRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md index b46c5d8c46..fda719c148 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of transit_gateway_route_table_attachments in a region or create a transit_gateway_route_table_attachments resource, use transit_gateway_route_table_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of transit_gateway_route_table_attachments Nametransit_gateway_route_table_attachments TypeResource DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition. -Idaws.networkmanager.transit_gateway_route_table_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
stringThe ID of the attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of transit_gateway_route_table_attachments Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md index d1b8e9da4e..74665dd35d 100644 --- a/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_attachment resource, use vpc_attachments to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual vpc_attachment resource, use Namevpc_attachment TypeResource DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type -Idaws.networkmanager.vpc_attachment +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe ID of a core network for the VPC attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringId of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringAttachment type.
statestringState of the attachment.
edge_locationstringThe Region where the edge is located.
vpc_arnstringThe ARN of the VPC.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment attachment..
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
subnet_arnsarraySubnet Arn list
optionsobjectVpc options of the attachment.
regionstringAWS region.
stringThe ID of a core network for the VPC attachment.
stringThe ARN of a core network for the VPC attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the VPC.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
arraySubnet Arn list
objectVpc options of the attachment.
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual vpc_attachment resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md index d114be7fd3..dc58d24d7c 100644 --- a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_attachments in a region or create a vpc_attachments resource, use vpc_attachment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_attachments in a region or create a Namevpc_attachments TypeResource DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type -Idaws.networkmanager.vpc_attachments +Id ## Fields - - + +
NameDatatypeDescription
attachment_idstringId of the attachment.
regionstringAWS region.
stringId of the attachment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_attachments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md index ed0e7a9486..8a4267faac 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual launch_profile resource, use launch_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual launch_profile resource, use Namelaunch_profile TypeResource DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users -Idaws.nimblestudio.launch_profile +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
descriptionstring<p>The description.</p>
ec2_subnet_idsarray<p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.<br/> These subnets must support the specified instance types. </p>
launch_profile_idstring
launch_profile_protocol_versionsarray<p>The version number of the protocol that is used by the launch profile. The only valid<br/> version is "2021-03-31".</p>
namestring<p>The name for the launch profile.</p>
stream_configurationobject
studio_component_idsarray<p>Unique identifiers for a collection of studio components that can be used with this<br/> launch profile.</p>
studio_idstring<p>The studio ID. </p>
tagsobject
regionstringAWS region.
string<p>The description.</p>
array<p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.<br/> These subnets must support the specified instance types. </p>
string
array<p>The version number of the protocol that is used by the launch profile. The only valid<br/> version is "2021-03-31".</p>
string<p>The name for the launch profile.</p>
object
array<p>Unique identifiers for a collection of studio components that can be used with this<br/> launch profile.</p>
string<p>The studio ID. </p>
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual launch_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md index 24b2b9272e..570548b7d7 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of launch_profiles in a region or create a launch_profiles resource, use launch_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of launch_profiles in a region or create a Namelaunch_profiles TypeResource DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users -Idaws.nimblestudio.launch_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
launch_profile_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
string
string<p>The studio ID. </p>
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of launch_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md index 2e363f59e5..dce16a946c 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual streaming_image resource, use streaming_images to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual streaming_image resource, use Namestreaming_image TypeResource DescriptionRepresents a streaming session machine image that can be used to launch a streaming session -Idaws.nimblestudio.streaming_image +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
descriptionstring<p>A human-readable description of the streaming image.</p>
ec2_image_idstring<p>The ID of an EC2 machine image with which to create this streaming image.</p>
encryption_configurationobject
eula_idsarray<p>The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.</p>
namestring<p>A friendly name for a streaming image resource.</p>
ownerstring<p>The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.</p>
platformstring<p>The platform of the streaming image, either WINDOWS or LINUX.</p>
streaming_image_idstring
studio_idstring<p>The studioId. </p>
tagsobject
regionstringAWS region.
string<p>A human-readable description of the streaming image.</p>
string<p>The ID of an EC2 machine image with which to create this streaming image.</p>
object
array<p>The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.</p>
string<p>A friendly name for a streaming image resource.</p>
string<p>The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.</p>
string<p>The platform of the streaming image, either WINDOWS or LINUX.</p>
string
string<p>The studioId. </p>
object
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual streaming_image resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md index bddaa29651..52b60ddf78 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of streaming_images in a region or create a streaming_images resource, use streaming_image to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of streaming_images in a region or create a Namestreaming_images TypeResource DescriptionRepresents a streaming session machine image that can be used to launch a streaming session -Idaws.nimblestudio.streaming_images +Id ## Fields - - - + + +
NameDatatypeDescription
studio_idstring<p>The studioId. </p>
streaming_image_idstring
regionstringAWS region.
string<p>The studioId. </p>
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of streaming_images in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio/index.md index d1650f037d..815b5d3afe 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studio/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studio/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual studio resource, use studios to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual studio resource, use studio Namestudio TypeResource DescriptionRepresents a studio that contains other Nimble Studio resources -Idaws.nimblestudio.studio +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
admin_role_arnstring<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>
display_namestring<p>A friendly name for the studio.</p>
home_regionstring<p>The Amazon Web Services Region where the studio resource is located.</p>
sso_client_idstring<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>
studio_encryption_configurationobject
studio_idstring
studio_namestring<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>
studio_urlstring<p>The address of the web page for the studio.</p>
tagsobject
user_role_arnstring<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>
regionstringAWS region.
string<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>
string<p>A friendly name for the studio.</p>
string<p>The Amazon Web Services Region where the studio resource is located.</p>
string<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>
object
string
string<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>
string<p>The address of the web page for the studio.</p>
object
string<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual studio resource, use studio Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md index ff5fe9d290..e6ccf6de67 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual studio_component resource, use studio_components to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual studio_component resource, use Namestudio_component TypeResource DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio -Idaws.nimblestudio.studio_component +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
configurationundefined
descriptionstring<p>The description.</p>
ec2_security_group_idsarray<p>The EC2 security groups that control access to the studio component.</p>
initialization_scriptsarray<p>Initialization scripts for studio components.</p>
namestring<p>The name for the studio component.</p>
runtime_role_arnstring
script_parametersarray<p>Parameters for the studio component scripts.</p>
secure_initialization_role_arnstring
studio_component_idstring
studio_idstring<p>The studio ID. </p>
subtypestring
tagsobject
typestring
regionstringAWS region.
undefined
string<p>The description.</p>
array<p>The EC2 security groups that control access to the studio component.</p>
array<p>Initialization scripts for studio components.</p>
string<p>The name for the studio component.</p>
string
array<p>Parameters for the studio component scripts.</p>
string
string
string<p>The studio ID. </p>
string
object
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual studio_component resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md index ed9bef0868..73105b316b 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of studio_components in a region or create a studio_components resource, use studio_component to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of studio_components in a region or create Namestudio_components TypeResource DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio -Idaws.nimblestudio.studio_components +Id ## Fields - - - + + +
NameDatatypeDescription
studio_component_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
string
string<p>The studio ID. </p>
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of studio_components in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studios/index.md b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md index 05dd283717..39773a863d 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studios/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of studios in a region or create a studios resource, use studio to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of studios in a region or create a st Namestudios TypeResource DescriptionRepresents a studio that contains other Nimble Studio resources -Idaws.nimblestudio.studios +Id ## Fields - - + +
NameDatatypeDescription
studio_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of studios in a region or create a st Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/oam/link/index.md b/docs/aws-docs/providers/aws/oam/link/index.md index 7c11f19d1f..6efd4b3dbb 100644 --- a/docs/aws-docs/providers/aws/oam/link/index.md +++ b/docs/aws-docs/providers/aws/oam/link/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual link resource, use links to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual link resource, use linksNamelink TypeResource DescriptionDefinition of AWS::Oam::Link Resource Type -Idaws.oam.link +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
labelstring
label_templatestring
resource_typesarray
sink_identifierstring
link_configurationobject
tagsobjectTags to apply to the link
regionstringAWS region.
string
string
string
array
string
object
objectTags to apply to the link
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual link resource, use linksRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/oam/links/index.md b/docs/aws-docs/providers/aws/oam/links/index.md index 74eaefc523..6f1933e49f 100644 --- a/docs/aws-docs/providers/aws/oam/links/index.md +++ b/docs/aws-docs/providers/aws/oam/links/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of links in a region or create a links resource, use link to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of links in a region or create a link Namelinks TypeResource DescriptionDefinition of AWS::Oam::Link Resource Type -Idaws.oam.links +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of links in a region or create a link Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/oam/sink/index.md b/docs/aws-docs/providers/aws/oam/sink/index.md index eeb34acc2e..e0b7572eeb 100644 --- a/docs/aws-docs/providers/aws/oam/sink/index.md +++ b/docs/aws-docs/providers/aws/oam/sink/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual sink resource, use sinks to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual sink resource, use sinksNamesink TypeResource DescriptionResource Type definition for AWS::Oam::Sink -Idaws.oam.sink +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
namestringThe name of the ObservabilityAccessManager Sink.
policyobjectThe policy of this ObservabilityAccessManager Sink.
tagsobjectTags to apply to the sink
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual sink resource, use sinksRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/oam/sinks/index.md b/docs/aws-docs/providers/aws/oam/sinks/index.md index b71e6ee75a..e7371564ef 100644 --- a/docs/aws-docs/providers/aws/oam/sinks/index.md +++ b/docs/aws-docs/providers/aws/oam/sinks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sinks in a region or create a sinks resource, use sink to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of sinks in a region or create a sink Namesinks TypeResource DescriptionResource Type definition for AWS::Oam::Sink -Idaws.oam.sinks +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
regionstringAWS region.
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of sinks in a region or create a sink Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/annotation_store/index.md b/docs/aws-docs/providers/aws/omics/annotation_store/index.md index 6be89ea5b7..9460b31c81 100644 --- a/docs/aws-docs/providers/aws/omics/annotation_store/index.md +++ b/docs/aws-docs/providers/aws/omics/annotation_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual annotation_store resource, use annotation_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual annotation_store resource, use Nameannotation_store TypeResource DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type -Idaws.omics.annotation_store +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
creation_timestring
descriptionstring
idstring
namestring
referenceobject
sse_configobject
statusstring
status_messagestring
store_arnstring
store_formatstring
store_optionsundefined
store_size_bytesnumber
tagsobject
update_timestring
regionstringAWS region.
string
string
string
string
object
object
string
string
string
string
undefined
number
object
string
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual annotation_store resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/annotation_stores/index.md b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md index b28becd36b..9375d26dac 100644 --- a/docs/aws-docs/providers/aws/omics/annotation_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of annotation_stores in a region or create a annotation_stores resource, use annotation_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of annotation_stores in a region or create Nameannotation_stores TypeResource DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type -Idaws.omics.annotation_stores +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of annotation_stores in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/reference_store/index.md b/docs/aws-docs/providers/aws/omics/reference_store/index.md index 8b20277df0..dda8276ddd 100644 --- a/docs/aws-docs/providers/aws/omics/reference_store/index.md +++ b/docs/aws-docs/providers/aws/omics/reference_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual reference_store resource, use reference_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual reference_store resource, use Namereference_store TypeResource DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type -Idaws.omics.reference_store +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstringThe store's ARN.
creation_timestringWhen the store was created.
descriptionstringA description for the store.
namestringA name for the store.
reference_store_idstring
sse_configobject
tagsobject
regionstringAWS region.
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
string
object
object
stringAWS region.
@@ -47,14 +50,14 @@ Gets or operates on an individual reference_store resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/reference_stores/index.md b/docs/aws-docs/providers/aws/omics/reference_stores/index.md index b1954427e6..53484078a4 100644 --- a/docs/aws-docs/providers/aws/omics/reference_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/reference_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of reference_stores in a region or create a reference_stores resource, use reference_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of reference_stores in a region or create a Namereference_stores TypeResource DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type -Idaws.omics.reference_stores +Id ## Fields - - + +
NameDatatypeDescription
reference_store_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of reference_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/run_group/index.md b/docs/aws-docs/providers/aws/omics/run_group/index.md index 148f7800ee..7d8fea6ed4 100644 --- a/docs/aws-docs/providers/aws/omics/run_group/index.md +++ b/docs/aws-docs/providers/aws/omics/run_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual run_group resource, use run_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual run_group resource, use run Namerun_group TypeResource DescriptionDefinition of AWS::Omics::RunGroup Resource Type -Idaws.omics.run_group +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
idstring
max_cpusnumber
max_gpusnumber
max_durationnumber
max_runsnumber
namestring
tagsobject
regionstringAWS region.
string
string
string
number
number
number
number
string
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual run_group resource, use run Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/run_groups/index.md b/docs/aws-docs/providers/aws/omics/run_groups/index.md index 12357fd911..f609657b38 100644 --- a/docs/aws-docs/providers/aws/omics/run_groups/index.md +++ b/docs/aws-docs/providers/aws/omics/run_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of run_groups in a region or create a run_groups resource, use run_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of run_groups in a region or create a Namerun_groups TypeResource DescriptionDefinition of AWS::Omics::RunGroup Resource Type -Idaws.omics.run_groups +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of run_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/sequence_store/index.md b/docs/aws-docs/providers/aws/omics/sequence_store/index.md index 133fbddbab..c0135420e2 100644 --- a/docs/aws-docs/providers/aws/omics/sequence_store/index.md +++ b/docs/aws-docs/providers/aws/omics/sequence_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual sequence_store resource, use sequence_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual sequence_store resource, use Namesequence_store TypeResource DescriptionDefinition of AWS::Omics::SequenceStore Resource Type -Idaws.omics.sequence_store +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstringThe store's ARN.
creation_timestringWhen the store was created.
descriptionstringA description for the store.
namestringA name for the store.
fallback_locationstringAn S3 URI representing the bucket and folder to store failed read set uploads.
sequence_store_idstring
sse_configobject
tagsobject
regionstringAWS region.
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
object
stringAWS region.
@@ -48,14 +51,14 @@ Gets or operates on an individual sequence_store resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/sequence_stores/index.md b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md index 2fd146c1e5..1fb2cd587a 100644 --- a/docs/aws-docs/providers/aws/omics/sequence_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sequence_stores in a region or create a sequence_stores resource, use sequence_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of sequence_stores in a region or create a Namesequence_stores TypeResource DescriptionDefinition of AWS::Omics::SequenceStore Resource Type -Idaws.omics.sequence_stores +Id ## Fields - - + +
NameDatatypeDescription
sequence_store_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of sequence_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/variant_store/index.md b/docs/aws-docs/providers/aws/omics/variant_store/index.md index c59caf2400..9ffece4e35 100644 --- a/docs/aws-docs/providers/aws/omics/variant_store/index.md +++ b/docs/aws-docs/providers/aws/omics/variant_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual variant_store resource, use variant_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual variant_store resource, use Namevariant_store TypeResource DescriptionDefinition of AWS::Omics::VariantStore Resource Type -Idaws.omics.variant_store +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
creation_timestring
descriptionstring
idstring
namestring
referenceobject
sse_configobject
statusstring
status_messagestring
store_arnstring
store_size_bytesnumber
tagsobject
update_timestring
regionstringAWS region.
string
string
string
string
object
object
string
string
string
number
object
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual variant_store resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/variant_stores/index.md b/docs/aws-docs/providers/aws/omics/variant_stores/index.md index 8b017e245b..775b4154c3 100644 --- a/docs/aws-docs/providers/aws/omics/variant_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/variant_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of variant_stores in a region or create a variant_stores resource, use variant_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of variant_stores in a region or create a < Namevariant_stores TypeResource DescriptionDefinition of AWS::Omics::VariantStore Resource Type -Idaws.omics.variant_stores +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of variant_stores in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/omics/workflow/index.md b/docs/aws-docs/providers/aws/omics/workflow/index.md index 290afe6c97..af963c1eae 100644 --- a/docs/aws-docs/providers/aws/omics/workflow/index.md +++ b/docs/aws-docs/providers/aws/omics/workflow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workflow resource, use workflows to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual workflow resource, use work Nameworkflow TypeResource DescriptionDefinition of AWS::Omics::Workflow Resource Type -Idaws.omics.workflow +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
definition_uristring
descriptionstring
enginestring
idstring
mainstring
namestring
parameter_templateobject
statusstring
acceleratorsstring
storage_capacitynumber
tagsobject
typestring
regionstringAWS region.
string
string
string
string
string
string
string
string
object
string
string
number
object
string
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual workflow resource, use work Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/omics/workflows/index.md b/docs/aws-docs/providers/aws/omics/workflows/index.md index 7927f01ea8..6231b48fe5 100644 --- a/docs/aws-docs/providers/aws/omics/workflows/index.md +++ b/docs/aws-docs/providers/aws/omics/workflows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workflows in a region or create a workflows resource, use workflow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workflows in a region or create a Nameworkflows TypeResource DescriptionDefinition of AWS::Omics::Workflow Resource Type -Idaws.omics.workflows +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workflows in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md index 076e11662c..725b76ff73 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_policies in a region or create a access_policies resource, use access_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of access_policies in a region or create a Nameaccess_policies TypeResource DescriptionAmazon OpenSearchServerless access policy resource -Idaws.opensearchserverless.access_policies +Id ## Fields - - - + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
undefined
stringThe name of the policy
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of access_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md index e8dd15ec28..a5ae894595 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_policy resource, use access_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual access_policy resource, use Nameaccess_policy TypeResource DescriptionAmazon OpenSearchServerless access policy resource -Idaws.opensearchserverless.access_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringThe name of the policy
typestring
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
regionstringAWS region.
stringThe name of the policy
string
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual access_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md index 5dc9da932e..5868eb8ab7 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual collection resource, use collections to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual collection resource, use co Namecollection TypeResource DescriptionAmazon OpenSearchServerless collection resource -Idaws.opensearchserverless.collection +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the collection
idstringThe identifier of the collection
namestringThe name of the collection.<br/><br/>The name must meet the following criteria:<br/>Unique to your account and AWS Region<br/>Starts with a lowercase letter<br/>Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)<br/>Contains between 3 and 32 characters<br/>
tagsarrayList of tags to be added to the resource
arnstringThe Amazon Resource Name (ARN) of the collection.
collection_endpointstringThe endpoint for the collection.
dashboard_endpointstringThe OpenSearch Dashboards endpoint for the collection.
typestring
standby_replicasstring
regionstringAWS region.
stringThe description of the collection
stringThe identifier of the collection
stringThe name of the collection.<br/><br/>The name must meet the following criteria:<br/>Unique to your account and AWS Region<br/>Starts with a lowercase letter<br/>Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)<br/>Contains between 3 and 32 characters<br/>
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.
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual collection resource, use co Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md index 2feb247bbe..7f6ba764bd 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of collections in a region or create a collections resource, use collection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of collections in a region or create a Namecollections TypeResource DescriptionAmazon OpenSearchServerless collection resource -Idaws.opensearchserverless.collections +Id ## Fields - - + +
NameDatatypeDescription
idstringThe identifier of the collection
regionstringAWS region.
stringThe identifier of the collection
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of collections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md index 622a0de9fc..cd4b5a0476 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of lifecycle_policies in a region or create a lifecycle_policies resource, use lifecycle_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of lifecycle_policies in a region or create Namelifecycle_policies TypeResource DescriptionAmazon OpenSearchServerless lifecycle policy resource -Idaws.opensearchserverless.lifecycle_policies +Id ## Fields - - - + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
undefined
stringThe name of the policy
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of lifecycle_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md index 2da42b6462..8ff44646ab 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual lifecycle_policy resource, use lifecycle_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual lifecycle_policy resource, use Namelifecycle_policy TypeResource DescriptionAmazon OpenSearchServerless lifecycle policy resource -Idaws.opensearchserverless.lifecycle_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringThe name of the policy
typestring
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
regionstringAWS region.
stringThe name of the policy
string
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual lifecycle_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md index 3520df9d58..bf71424b3f 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_config resource, use security_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual security_config resource, use Namesecurity_config TypeResource DescriptionAmazon OpenSearchServerless security config resource -Idaws.opensearchserverless.security_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstringSecurity config description
idstringThe identifier of the security config
namestringThe friendly name of the security config
saml_optionsobject
typestring
regionstringAWS region.
stringSecurity config description
stringThe identifier of the security config
stringThe friendly name of the security config
object
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual security_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md index 38e0597a44..a06deb1e5e 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_configs in a region or create a security_configs resource, use security_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of security_configs in a region or create a Namesecurity_configs TypeResource DescriptionAmazon OpenSearchServerless security config resource -Idaws.opensearchserverless.security_configs +Id ## Fields - - + +
NameDatatypeDescription
idstringThe identifier of the security config
regionstringAWS region.
stringThe identifier of the security config
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of security_configs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md index 0e4e63430f..ed55333902 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of security_policies in a region or create a security_policies resource, use security_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of security_policies in a region or create Namesecurity_policies TypeResource DescriptionAmazon OpenSearchServerless security policy resource -Idaws.opensearchserverless.security_policies +Id ## Fields - - - + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
undefined
stringThe name of the policy
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of security_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md index 378a9b2819..1403ceb2bc 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual security_policy resource, use security_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual security_policy resource, use Namesecurity_policy TypeResource DescriptionAmazon OpenSearchServerless security policy resource -Idaws.opensearchserverless.security_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
namestringThe name of the policy
typestring
regionstringAWS region.
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringThe name of the policy
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual security_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md index 5370d2c4d7..e01c56508e 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_endpoint resource, use vpc_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual vpc_endpoint resource, use Namevpc_endpoint TypeResource DescriptionAmazon OpenSearchServerless vpc endpoint resource -Idaws.opensearchserverless.vpc_endpoint +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstringThe identifier of the VPC Endpoint
namestringThe name of the VPC Endpoint
security_group_idsarrayThe ID of one or more security groups to associate with the endpoint network interface
subnet_idsarrayThe ID of one or more subnets in which to create an endpoint network interface
vpc_idstringThe ID of the VPC in which the endpoint will be used.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual vpc_endpoint resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md index 1db1cdb441..52cc2bdf7b 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_endpoints in a region or create a vpc_endpoints resource, use vpc_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of vpc_endpoints in a region or create a Namevpc_endpoints TypeResource DescriptionAmazon OpenSearchServerless vpc endpoint resource -Idaws.opensearchserverless.vpc_endpoints +Id ## Fields - - + +
NameDatatypeDescription
idstringThe identifier of the VPC Endpoint
regionstringAWS region.
stringThe identifier of the VPC Endpoint
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of vpc_endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opensearchservice/domain/index.md b/docs/aws-docs/providers/aws/opensearchservice/domain/index.md index b5d9d87c8a..936f081884 100644 --- a/docs/aws-docs/providers/aws/opensearchservice/domain/index.md +++ b/docs/aws-docs/providers/aws/opensearchservice/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,38 +24,38 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.opensearchservice.domain +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_configobject
domain_namestring
access_policiesobject
ip_address_typestring
engine_versionstring
advanced_optionsobject
log_publishing_optionsobject
snapshot_optionsobject
vpc_optionsobject
node_to_node_encryption_optionsobject
domain_endpoint_optionsobject
cognito_optionsobject
advanced_security_optionsobject
domain_endpointstring
domain_endpoint_v2string
domain_endpointsobject
ebs_optionsobject
idstring
arnstring
domain_arnstring
encryption_at_rest_optionsobject
tagsarrayAn arbitrary set of tags (key-value pairs) for this Domain.
service_software_optionsobject
off_peak_window_optionsobject
software_update_optionsobject
regionstringAWS region.
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
stringAWS region.
@@ -65,19 +68,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opensearchservice/domains/index.md b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md index a932d52a27..6a874f3827 100644 --- a/docs/aws-docs/providers/aws/opensearchservice/domains/index.md +++ b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.opensearchservice.domains +Id ## Fields - - + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/opsworkscm/server/index.md b/docs/aws-docs/providers/aws/opsworkscm/server/index.md index 83a81e74fa..c3af6053a7 100644 --- a/docs/aws-docs/providers/aws/opsworkscm/server/index.md +++ b/docs/aws-docs/providers/aws/opsworkscm/server/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual server resource, use servers to retrieve a list of resources or to create a resource. ## Overview @@ -21,36 +24,36 @@ Gets or operates on an individual server resource, use server Nameserver TypeResource DescriptionResource Type definition for AWS::OpsWorksCM::Server -Idaws.opsworkscm.server +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
key_pairstring
engine_versionstring
service_role_arnstring
disable_automated_backupboolean
backup_idstring
engine_modelstring
preferred_maintenance_windowstring
associate_public_ip_addressboolean
instance_profile_arnstring
custom_certificatestring
preferred_backup_windowstring
security_group_idsarray
subnet_idsarray
custom_domainstring
endpointstring
custom_private_keystring
server_namestring
engine_attributesarray
backup_retention_countinteger
arnstring
instance_typestring
tagsarray
enginestring
regionstringAWS region.
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.
@@ -63,19 +66,19 @@ Gets or operates on an individual server resource, use server Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/opsworkscm/servers/index.md b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md index b3f81d94ae..58c0bd324f 100644 --- a/docs/aws-docs/providers/aws/opsworkscm/servers/index.md +++ b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of servers in a region or create a servers resource, use server to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of servers in a region or create a se Nameservers TypeResource DescriptionResource Type definition for AWS::OpsWorksCM::Server -Idaws.opsworkscm.servers +Id ## Fields - - + +
NameDatatypeDescription
server_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of servers in a region or create a se Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/account/index.md b/docs/aws-docs/providers/aws/organizations/account/index.md index 3fde0910e4..5608c761c7 100644 --- a/docs/aws-docs/providers/aws/organizations/account/index.md +++ b/docs/aws-docs/providers/aws/organizations/account/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account resource, use accounts to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual account resource, use accou Nameaccount TypeResource DescriptionYou can use AWS::Organizations::Account to manage accounts in organization. -Idaws.organizations.account +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
account_namestringThe friendly name of the member account.
emailstringThe email address of the owner to assign to the new member account.
role_namestringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
parent_idsarrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
tagsarrayA list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
account_idstringIf the account was created successfully, the unique identifier (ID) of the new account.
arnstringThe Amazon Resource Name (ARN) of the account.
joined_methodstringThe method by which the account joined the organization.
joined_timestampstringThe date the account became a part of the organization.
statusstringThe status of the account in the organization.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual account resource, use accou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/organizations/accounts/index.md b/docs/aws-docs/providers/aws/organizations/accounts/index.md index 160c84508f..975038a23b 100644 --- a/docs/aws-docs/providers/aws/organizations/accounts/index.md +++ b/docs/aws-docs/providers/aws/organizations/accounts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of accounts in a region or create a accounts resource, use account to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of accounts in a region or create a a Nameaccounts TypeResource DescriptionYou can use AWS::Organizations::Account to manage accounts in organization. -Idaws.organizations.accounts +Id ## Fields - - + +
NameDatatypeDescription
account_idstringIf the account was created successfully, the unique identifier (ID) of the new account.
regionstringAWS region.
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of accounts in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/organization/index.md b/docs/aws-docs/providers/aws/organizations/organization/index.md index 2cf08cb69c..640af015fb 100644 --- a/docs/aws-docs/providers/aws/organizations/organization/index.md +++ b/docs/aws-docs/providers/aws/organizations/organization/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual organization resource, use organizations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual organization resource, use Nameorganization TypeResource DescriptionResource schema for AWS::Organizations::Organization -Idaws.organizations.organization +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) of an organization.
arnstringThe Amazon Resource Name (ARN) of an organization.
feature_setstringSpecifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
management_account_arnstringThe Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
management_account_idstringThe unique identifier (ID) of the management account of an organization.
management_account_emailstringThe email address that is associated with the AWS account that is designated as the management account for the organization.
root_idstringThe unique identifier (ID) for the root.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual organization resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md b/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md index 3a068cb8cd..7c3b1009b9 100644 --- a/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md +++ b/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual organizational_unit resource, use organizational_units to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual organizational_unit resource, use Nameorganizational_unit TypeResource DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root. -Idaws.organizations.organizational_unit +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of this OU.
idstringThe unique identifier (ID) associated with this OU.
namestringThe friendly name of this OU.
parent_idstringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
tagsarrayA list of tags that you want to attach to the newly created OU.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual organizational_unit resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/organizations/organizational_units/index.md b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md index 6032cd89ca..64e5017303 100644 --- a/docs/aws-docs/providers/aws/organizations/organizational_units/index.md +++ b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of organizational_units in a region or create a organizational_units resource, use organizational_unit to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of organizational_units in a region or crea Nameorganizational_units TypeResource DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root. -Idaws.organizations.organizational_units +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this OU.
regionstringAWS region.
stringThe unique identifier (ID) associated with this OU.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of organizational_units in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/organizations/index.md b/docs/aws-docs/providers/aws/organizations/organizations/index.md index 7f6e85adc9..979407041b 100644 --- a/docs/aws-docs/providers/aws/organizations/organizations/index.md +++ b/docs/aws-docs/providers/aws/organizations/organizations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of organizations in a region or create a organizations resource, use organization to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of organizations in a region or create a Nameorganizations TypeResource DescriptionResource schema for AWS::Organizations::Organization -Idaws.organizations.organizations +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique identifier (ID) of an organization.
regionstringAWS region.
stringThe unique identifier (ID) of an organization.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of organizations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/policies/index.md b/docs/aws-docs/providers/aws/organizations/policies/index.md index 4135e138ea..e88281dbe3 100644 --- a/docs/aws-docs/providers/aws/organizations/policies/index.md +++ b/docs/aws-docs/providers/aws/organizations/policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policies in a region or create a policies resource, use policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of policies in a region or create a p Namepolicies TypeResource DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization. -Idaws.organizations.policies +Id ## Fields - - + +
NameDatatypeDescription
idstringId of the Policy
regionstringAWS region.
stringId of the Policy
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of policies in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/policy/index.md b/docs/aws-docs/providers/aws/organizations/policy/index.md index 86d0fde45e..a5af5537a6 100644 --- a/docs/aws-docs/providers/aws/organizations/policy/index.md +++ b/docs/aws-docs/providers/aws/organizations/policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy resource, use policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual policy resource, use polici Namepolicy TypeResource DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization. -Idaws.organizations.policy +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringName of the Policy
typestringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
contentobjectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
descriptionstringHuman readable description of the policy
target_idsarrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
tagsarrayA list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
idstringId of the Policy
arnstringARN of the Policy
aws_managedbooleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
regionstringAWS region.
stringName of the Policy
stringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
objectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringHuman readable description of the policy
arrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
arrayA list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
stringId of the Policy
stringARN of the Policy
booleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual policy resource, use polici Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policies/index.md b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md index 351d6d2b80..3cedfac2d2 100644 --- a/docs/aws-docs/providers/aws/organizations/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account. -Idaws.organizations.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this resource policy.
regionstringAWS region.
stringThe unique identifier (ID) associated with this resource policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policy/index.md b/docs/aws-docs/providers/aws/organizations/resource_policy/index.md index d33d394120..e9f289ba82 100644 --- a/docs/aws-docs/providers/aws/organizations/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/organizations/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account. -Idaws.organizations.resource_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this resource policy.
arnstringThe Amazon Resource Name (ARN) of the resource policy.
contentobjectThe policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
tagsarrayA list of tags that you want to attach to the resource policy
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/osis/pipeline/index.md b/docs/aws-docs/providers/aws/osis/pipeline/index.md index 5662388e15..7c2ed6118a 100644 --- a/docs/aws-docs/providers/aws/osis/pipeline/index.md +++ b/docs/aws-docs/providers/aws/osis/pipeline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pipeline resource, use pipelines to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual pipeline resource, use pipe Namepipeline TypeResource DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper. -Idaws.osis.pipeline +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
buffer_optionsobject
encryption_at_rest_optionsobject
log_publishing_optionsobject
max_unitsintegerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
min_unitsintegerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
pipeline_configuration_bodystringThe Data Prepper pipeline configuration.
pipeline_namestringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
tagsarrayAn array of key-value pairs to apply to this resource.
vpc_optionsobject
vpc_endpointsarrayThe VPC interface endpoints that have access to the pipeline.
pipeline_arnstringThe Amazon Resource Name (ARN) of the pipeline.
ingest_endpoint_urlsarrayA list of endpoints that can be used for ingesting data into a pipeline
regionstringAWS region.
object
object
object
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.
object
arrayThe VPC interface endpoints that have access to the pipeline.
stringThe Amazon Resource Name (ARN) of the pipeline.
arrayA list of endpoints that can be used for ingesting data into a pipeline
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual pipeline resource, use pipe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/osis/pipelines/index.md b/docs/aws-docs/providers/aws/osis/pipelines/index.md index d539a08c90..8802961b36 100644 --- a/docs/aws-docs/providers/aws/osis/pipelines/index.md +++ b/docs/aws-docs/providers/aws/osis/pipelines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pipelines in a region or create a pipelines resource, use pipeline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pipelines in a region or create a Namepipelines TypeResource DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper. -Idaws.osis.pipelines +Id ## Fields - - + +
NameDatatypeDescription
pipeline_arnstringThe Amazon Resource Name (ARN) of the pipeline.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the pipeline.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pipelines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/panorama/application_instance/index.md b/docs/aws-docs/providers/aws/panorama/application_instance/index.md index 65b8b2756c..b8d5f845ac 100644 --- a/docs/aws-docs/providers/aws/panorama/application_instance/index.md +++ b/docs/aws-docs/providers/aws/panorama/application_instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application_instance resource, use application_instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual application_instance resource, us Nameapplication_instance TypeResource DescriptionSchema for ApplicationInstance CloudFormation Resource -Idaws.panorama.application_instance +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
default_runtime_context_device_namestring
statusstring
default_runtime_context_devicestring
descriptionstring
application_instance_id_to_replacestring
created_timeinteger
health_statusstring
manifest_overrides_payloadobject
last_updated_timeinteger
runtime_role_arnstring
namestring
application_instance_idstring
status_descriptionstring
manifest_payloadobject
arnstring
tagsarray
regionstringAWS region.
string
string
string
string
string
integer
string
object
integer
string
string
string
string
object
string
array
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual application_instance resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/panorama/application_instances/index.md b/docs/aws-docs/providers/aws/panorama/application_instances/index.md index 10d3cfbe9c..4450808346 100644 --- a/docs/aws-docs/providers/aws/panorama/application_instances/index.md +++ b/docs/aws-docs/providers/aws/panorama/application_instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of application_instances in a region or create a application_instances resource, use application_instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of application_instances in a region or cre Nameapplication_instances TypeResource DescriptionSchema for ApplicationInstance CloudFormation Resource -Idaws.panorama.application_instances +Id ## Fields - - + +
NameDatatypeDescription
application_instance_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of application_instances in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/panorama/package/index.md b/docs/aws-docs/providers/aws/panorama/package/index.md index f164a9aca2..146361d4d9 100644 --- a/docs/aws-docs/providers/aws/panorama/package/index.md +++ b/docs/aws-docs/providers/aws/panorama/package/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual package resource, use packages to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual package resource, use packa Namepackage TypeResource DescriptionSchema for Package CloudFormation Resource -Idaws.panorama.package +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
package_namestring
package_idstring
arnstring
storage_locationobject
created_timeinteger
tagsarray
regionstringAWS region.
string
string
string
object
integer
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual package resource, use packa Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/panorama/package_version/index.md b/docs/aws-docs/providers/aws/panorama/package_version/index.md index b6ca555dde..e765175aff 100644 --- a/docs/aws-docs/providers/aws/panorama/package_version/index.md +++ b/docs/aws-docs/providers/aws/panorama/package_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual package_version resource, use package_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual package_version resource, use Namepackage_version TypeResource DescriptionSchema for PackageVersion Resource Type -Idaws.panorama.package_version +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
owner_accountstring
package_idstring
package_arnstring
package_versionstring
patch_versionstring
mark_latestboolean
is_latest_patchboolean
package_namestring
statusstring
status_descriptionstring
registered_timeinteger
updated_latest_patch_versionstring
regionstringAWS region.
string
string
string
string
string
boolean
boolean
string
string
string
integer
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual package_version resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/panorama/package_versions/index.md b/docs/aws-docs/providers/aws/panorama/package_versions/index.md index a1a51ee7c8..a913ea7ce9 100644 --- a/docs/aws-docs/providers/aws/panorama/package_versions/index.md +++ b/docs/aws-docs/providers/aws/panorama/package_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of package_versions in a region or create a package_versions resource, use package_version to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of package_versions in a region or create a Namepackage_versions TypeResource DescriptionSchema for PackageVersion Resource Type -Idaws.panorama.package_versions +Id ## Fields - - - - + + + +
NameDatatypeDescription
package_idundefined
package_versionundefined
patch_versionundefined
regionstringAWS region.
undefined
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of package_versions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/panorama/packages/index.md b/docs/aws-docs/providers/aws/panorama/packages/index.md index a257b17d50..92ce4c18f6 100644 --- a/docs/aws-docs/providers/aws/panorama/packages/index.md +++ b/docs/aws-docs/providers/aws/panorama/packages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of packages in a region or create a packages resource, use package to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of packages in a region or create a p Namepackages TypeResource DescriptionSchema for Package CloudFormation Resource -Idaws.panorama.packages +Id ## Fields - - + +
NameDatatypeDescription
package_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of packages in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md index 2f0fd067bb..fd8ac2329f 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connector resource, use connectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual connector resource, use con Nameconnector TypeResource DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type -Idaws.pcaconnectorad.connector +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
certificate_authority_arnstring
connector_arnstring
directory_idstring
tagsobject
vpc_informationobject
regionstringAWS region.
string
string
string
object
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual connector resource, use con Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md index 72cb9300c0..013865d570 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connectors in a region or create a connectors resource, use connector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connectors in a region or create a Nameconnectors TypeResource DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type -Idaws.pcaconnectorad.connectors +Id ## Fields - - + +
NameDatatypeDescription
connector_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md index 478557ac24..6feb351bca 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual directory_registration resource, use directory_registrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual directory_registration resource, Namedirectory_registration TypeResource DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type -Idaws.pcaconnectorad.directory_registration +Id ## Fields - - - - + + + +
NameDatatypeDescription
directory_idstring
directory_registration_arnstring
tagsobject
regionstringAWS region.
string
string
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual directory_registration resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md index d3b37d3a1c..1bc47f8ff1 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of directory_registrations in a region or create a directory_registrations resource, use directory_registration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of directory_registrations in a region or c Namedirectory_registrations TypeResource DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type -Idaws.pcaconnectorad.directory_registrations +Id ## Fields - - + +
NameDatatypeDescription
directory_registration_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of directory_registrations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md index 3b7d576789..238eb88b03 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_principal_name resource, use service_principal_names to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual service_principal_name resource, Nameservice_principal_name TypeResource DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type -Idaws.pcaconnectorad.service_principal_name +Id ## Fields - - - + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual service_principal_name resource, Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md index ab95abe6c7..3dfcc4cdae 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_principal_names in a region or create a service_principal_names resource, use service_principal_name to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of service_principal_names in a region or c Nameservice_principal_names TypeResource DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type -Idaws.pcaconnectorad.service_principal_names +Id ## Fields - - - + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of service_principal_names in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md index d3f7ef8327..a7f9234e67 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual template resource, use templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual template resource, use temp Nametemplate TypeResource DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling -Idaws.pcaconnectorad.template +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
connector_arnstring
definitionundefined
namestring
reenroll_all_certificate_holdersboolean
tagsobject
template_arnstring
regionstringAWS region.
string
undefined
string
boolean
object
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual template resource, use temp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md index dd9aac96d3..0d15d1047e 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of template_group_access_control_entries in a region or create a template_group_access_control_entries resource, use template_group_access_control_entry to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of template_group_access_control_entries in Nametemplate_group_access_control_entries TypeResource DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type -Idaws.pcaconnectorad.template_group_access_control_entries +Id ## Fields - - - + + +
NameDatatypeDescription
group_security_identifierstring
template_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of template_group_access_control_entries in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md index c5a9fcee04..e43e9913c7 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual template_group_access_control_entry resource, use template_group_access_control_entries to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual template_group_access_control_entryNametemplate_group_access_control_entry TypeResource DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type -Idaws.pcaconnectorad.template_group_access_control_entry +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
access_rightsobject
group_display_namestring
group_security_identifierstring
template_arnstring
regionstringAWS region.
object
string
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual template_group_access_control_entryRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md index 7018120151..6edef81a03 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of templates in a region or create a templates resource, use template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of templates in a region or create a Nametemplates TypeResource DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling -Idaws.pcaconnectorad.templates +Id ## Fields - - + +
NameDatatypeDescription
template_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/personalize/dataset/index.md b/docs/aws-docs/providers/aws/personalize/dataset/index.md index 6f49ac3fa1..395825c64c 100644 --- a/docs/aws-docs/providers/aws/personalize/dataset/index.md +++ b/docs/aws-docs/providers/aws/personalize/dataset/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset resource, use datasets to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual dataset resource, use datas Namedataset TypeResource DescriptionResource schema for AWS::Personalize::Dataset. -Idaws.personalize.dataset +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name for the dataset
dataset_arnstringThe ARN of the dataset
dataset_typestringThe type of dataset
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to add the dataset to
schema_arnstringThe ARN of the schema to associate with the dataset. The schema defines the dataset fields.
dataset_import_jobobject
regionstringAWS region.
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.
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual dataset resource, use datas Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/personalize/dataset_group/index.md b/docs/aws-docs/providers/aws/personalize/dataset_group/index.md index 646642cce0..988f487399 100644 --- a/docs/aws-docs/providers/aws/personalize/dataset_group/index.md +++ b/docs/aws-docs/providers/aws/personalize/dataset_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dataset_group resource, use dataset_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual dataset_group resource, use Namedataset_group TypeResource DescriptionResource Schema for AWS::Personalize::DatasetGroup. -Idaws.personalize.dataset_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group.
namestringThe name for the new dataset group.
kms_key_arnstringThe Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.
role_arnstringThe ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
domainstringThe domain of a Domain dataset group.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual dataset_group resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md index 67bd90b902..2f67d63259 100644 --- a/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md +++ b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dataset_groups in a region or create a dataset_groups resource, use dataset_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dataset_groups in a region or create a < Namedataset_groups TypeResource DescriptionResource Schema for AWS::Personalize::DatasetGroup. -Idaws.personalize.dataset_groups +Id ## Fields - - + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the dataset group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dataset_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/personalize/datasets/index.md b/docs/aws-docs/providers/aws/personalize/datasets/index.md index 862e38c124..1049652023 100644 --- a/docs/aws-docs/providers/aws/personalize/datasets/index.md +++ b/docs/aws-docs/providers/aws/personalize/datasets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of datasets in a region or create a datasets resource, use dataset to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of datasets in a region or create a d Namedatasets TypeResource DescriptionResource schema for AWS::Personalize::Dataset. -Idaws.personalize.datasets +Id ## Fields - - + +
NameDatatypeDescription
dataset_arnstringThe ARN of the dataset
regionstringAWS region.
stringThe ARN of the dataset
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of datasets in a region or create a d Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/personalize/schema/index.md b/docs/aws-docs/providers/aws/personalize/schema/index.md index 6fc74b36f4..751b698b3b 100644 --- a/docs/aws-docs/providers/aws/personalize/schema/index.md +++ b/docs/aws-docs/providers/aws/personalize/schema/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schema resource, use schemata to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual schema resource, use schema Nameschema TypeResource DescriptionResource schema for AWS::Personalize::Schema. -Idaws.personalize.schema +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringName for the schema.
schema_arnstringArn for the schema.
schemastringA schema in Avro JSON format.
domainstringThe domain of a Domain dataset group.
regionstringAWS region.
stringName for the schema.
stringArn for the schema.
stringA schema in Avro JSON format.
stringThe domain of a Domain dataset group.
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual schema resource, use schema Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/personalize/schemata/index.md b/docs/aws-docs/providers/aws/personalize/schemata/index.md index dee2044865..5e473bdc66 100644 --- a/docs/aws-docs/providers/aws/personalize/schemata/index.md +++ b/docs/aws-docs/providers/aws/personalize/schemata/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schemata in a region or create a schemata resource, use schema to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schemata in a region or create a s Nameschemata TypeResource DescriptionResource schema for AWS::Personalize::Schema. -Idaws.personalize.schemata +Id ## Fields - - + +
NameDatatypeDescription
schema_arnstringArn for the schema.
regionstringAWS region.
stringArn for the schema.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schemata in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/personalize/solution/index.md b/docs/aws-docs/providers/aws/personalize/solution/index.md index 7b5929b98f..05561dcdb3 100644 --- a/docs/aws-docs/providers/aws/personalize/solution/index.md +++ b/docs/aws-docs/providers/aws/personalize/solution/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual solution resource, use solutions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual solution resource, use solu Namesolution TypeResource DescriptionResource schema for AWS::Personalize::Solution. -Idaws.personalize.solution +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
namestringThe name for the solution
solution_arnstring
event_typestringWhen your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
dataset_group_arnstringThe ARN of the dataset group that provides the training data.
perform_auto_mlbooleanWhether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.
perform_hpobooleanWhether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
recipe_arnstringThe ARN of the recipe to use for model training. Only specified when performAutoML is false.
solution_configobject
regionstringAWS region.
stringThe name for the solution
string
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.
object
stringAWS region.
@@ -48,14 +51,14 @@ Gets or operates on an individual solution resource, use solu Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/personalize/solutions/index.md b/docs/aws-docs/providers/aws/personalize/solutions/index.md index d22ec9a730..7fca5e1884 100644 --- a/docs/aws-docs/providers/aws/personalize/solutions/index.md +++ b/docs/aws-docs/providers/aws/personalize/solutions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of solutions in a region or create a solutions resource, use solution to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of solutions in a region or create a Namesolutions TypeResource DescriptionResource schema for AWS::Personalize::Solution. -Idaws.personalize.solutions +Id ## Fields - - + +
NameDatatypeDescription
solution_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of solutions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md index fba99cbfbb..05d35699a7 100644 --- a/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual in_app_template resource, use in_app_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual in_app_template resource, use Namein_app_template TypeResource DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate -Idaws.pinpoint.in_app_template +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
contentarray
custom_configobject
layoutstring
tagsobject
template_descriptionstring
template_namestring
regionstringAWS region.
string
array
object
string
object
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual in_app_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md index a46bc4abe3..8bbaf80a4e 100644 --- a/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of in_app_templates in a region or create a in_app_templates resource, use in_app_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of in_app_templates in a region or create a Namein_app_templates TypeResource DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate -Idaws.pinpoint.in_app_templates +Id ## Fields - - + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of in_app_templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/pipes/pipe/index.md b/docs/aws-docs/providers/aws/pipes/pipe/index.md index b14acfaed0..268d5cefec 100644 --- a/docs/aws-docs/providers/aws/pipes/pipe/index.md +++ b/docs/aws-docs/providers/aws/pipes/pipe/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pipe resource, use pipes to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual pipe resource, use pipesNamepipe TypeResource DescriptionDefinition of AWS::Pipes::Pipe Resource Type -Idaws.pipes.pipe +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
current_statestring
descriptionstring
desired_statestring
enrichmentstring
enrichment_parametersobject
last_modified_timestring
log_configurationobject
namestring
role_arnstring
sourcestring
source_parametersobject
state_reasonstring
tagsobject
targetstring
target_parametersobject
regionstringAWS region.
string
string
string
string
string
string
object
string
object
string
string
string
object
string
object
string
object
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual pipe resource, use pipesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/pipes/pipes/index.md b/docs/aws-docs/providers/aws/pipes/pipes/index.md index a39d7bc9b4..253e8287ea 100644 --- a/docs/aws-docs/providers/aws/pipes/pipes/index.md +++ b/docs/aws-docs/providers/aws/pipes/pipes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pipes in a region or create a pipes resource, use pipe to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pipes in a region or create a pipe Namepipes TypeResource DescriptionDefinition of AWS::Pipes::Pipe Resource Type -Idaws.pipes.pipes +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pipes in a region or create a pipe Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md index f87ede4a98..9ac2e8c546 100644 --- a/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment_account_connection resource, use environment_account_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual environment_account_connection re Nameenvironment_account_connection TypeResource DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources. -Idaws.proton.environment_account_connection +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the environment account connection.
codebuild_role_arnstringThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
component_role_arnstringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
environment_account_idstringThe environment account that's connected to the environment account connection.
environment_namestringThe name of the AWS Proton environment that's created in the associated management account.
idstringThe ID of the environment account connection.
management_account_idstringThe ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
role_arnstringThe Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
statusstringThe status of the environment account connection.
tagsarray<p>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
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<p>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual environment_account_connection re Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md index 8d2d996179..0ed206692d 100644 --- a/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environment_account_connections in a region or create a environment_account_connections resource, use environment_account_connection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environment_account_connections in a reg Nameenvironment_account_connections TypeResource DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources. -Idaws.proton.environment_account_connections +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the environment account connection.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environment_account_connections in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/proton/environment_template/index.md b/docs/aws-docs/providers/aws/proton/environment_template/index.md index bf147e5871..95942038c8 100644 --- a/docs/aws-docs/providers/aws/proton/environment_template/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment_template resource, use environment_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual environment_template resource, us Nameenvironment_template TypeResource DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type -Idaws.proton.environment_template +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
descriptionstring<p>A description of the environment template.</p>
display_namestring<p>The environment template name as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that Proton uses to encrypt data.</p>
namestring
provisioningstring
tagsarray<p>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the environment template.</p>
string<p>A description of the environment template.</p>
string<p>The environment template name as displayed in the developer interface.</p>
string<p>A customer provided encryption key that Proton uses to encrypt data.</p>
string
string
array<p>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual environment_template resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/proton/environment_templates/index.md b/docs/aws-docs/providers/aws/proton/environment_templates/index.md index e116a2a57f..d19e1aade6 100644 --- a/docs/aws-docs/providers/aws/proton/environment_templates/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environment_templates in a region or create a environment_templates resource, use environment_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environment_templates in a region or cre Nameenvironment_templates TypeResource DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type -Idaws.proton.environment_templates +Id ## Fields - - + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the environment template.</p>
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environment_templates in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/proton/service_template/index.md b/docs/aws-docs/providers/aws/proton/service_template/index.md index 6fc1833478..664084cb2b 100644 --- a/docs/aws-docs/providers/aws/proton/service_template/index.md +++ b/docs/aws-docs/providers/aws/proton/service_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_template resource, use service_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual service_template resource, use Nameservice_template TypeResource DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type -Idaws.proton.service_template +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
descriptionstring<p>A description of the service template.</p>
display_namestring<p>The name of the service template as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that's used to encrypt data.</p>
namestring
pipeline_provisioningstring
tagsarray<p>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the service template.</p>
string<p>A description of the service template.</p>
string<p>The name of the service template as displayed in the developer interface.</p>
string<p>A customer provided encryption key that's used to encrypt data.</p>
string
string
array<p>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual service_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/proton/service_templates/index.md b/docs/aws-docs/providers/aws/proton/service_templates/index.md index b65d56b0f1..0ede34579a 100644 --- a/docs/aws-docs/providers/aws/proton/service_templates/index.md +++ b/docs/aws-docs/providers/aws/proton/service_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_templates in a region or create a service_templates resource, use service_template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_templates in a region or create Nameservice_templates TypeResource DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type -Idaws.proton.service_templates +Id ## Fields - - + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the service template.</p>
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_templates in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md b/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md index 7bd1a22b50..11831526a6 100644 --- a/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md +++ b/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual qldb_stream resource, use qldb_streams to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual qldb_stream resource, use q Nameqldb_stream TypeResource DescriptionResource schema for AWS::QLDB::Stream. -Idaws.qldb.qldb_stream +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
ledger_namestring
stream_namestring
role_arnstring
inclusive_start_timestring
exclusive_end_timestring
kinesis_configurationobject
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
idstring
regionstringAWS region.
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual qldb_stream resource, use q Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/qldb/streams/index.md b/docs/aws-docs/providers/aws/qldb/streams/index.md index b289cbe770..6618e04ef9 100644 --- a/docs/aws-docs/providers/aws/qldb/streams/index.md +++ b/docs/aws-docs/providers/aws/qldb/streams/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of streams in a region or create a streams resource, use stream to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of streams in a region or create a st Namestreams TypeResource DescriptionResource schema for AWS::QLDB::Stream. -Idaws.qldb.streams +Id ## Fields - - - + + +
NameDatatypeDescription
ledger_namestring
idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of streams in a region or create a st Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/analyses/index.md b/docs/aws-docs/providers/aws/quicksight/analyses/index.md index b34c38e982..ca8e4b51c7 100644 --- a/docs/aws-docs/providers/aws/quicksight/analyses/index.md +++ b/docs/aws-docs/providers/aws/quicksight/analyses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of analyses in a region or create a analyses resource, use analysis to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of analyses in a region or create a a Nameanalyses TypeResource DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type. -Idaws.quicksight.analyses +Id ## Fields - - - + + +
NameDatatypeDescription
analysis_idstring
aws_account_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of analyses in a region or create a a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/analysis/index.md b/docs/aws-docs/providers/aws/quicksight/analysis/index.md index 593c564ad9..ea8b3c58a1 100644 --- a/docs/aws-docs/providers/aws/quicksight/analysis/index.md +++ b/docs/aws-docs/providers/aws/quicksight/analysis/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual analysis resource, use analyses to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual analysis resource, use anal Nameanalysis TypeResource DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type. -Idaws.quicksight.analysis +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
analysis_idstring
arnstring
aws_account_idstring
created_timestring
data_set_arnsarray
definitionobject
errorsarray
last_updated_timestring
namestring
parametersobject
permissionsarray
sheetsarray
source_entityobject
statusstring
tagsarray
theme_arnstring
validation_strategyobject
regionstringAWS region.
string
string
string
string
array
object
array
string
string
object
array
array
object
string
array
string
object
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual analysis resource, use anal Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboard/index.md b/docs/aws-docs/providers/aws/quicksight/dashboard/index.md index b3c86f9237..c9021a2ff3 100644 --- a/docs/aws-docs/providers/aws/quicksight/dashboard/index.md +++ b/docs/aws-docs/providers/aws/quicksight/dashboard/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dashboard resource, use dashboards to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual dashboard resource, use das Namedashboard TypeResource DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type. -Idaws.quicksight.dashboard +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
created_timestring
dashboard_idstring
dashboard_publish_optionsobject
definitionobject
last_published_timestring
last_updated_timestring
link_entitiesarray
link_sharing_configurationobject
namestring
parametersobject
permissionsarray
source_entityobject
tagsarray
theme_arnstring
validation_strategyobject
versionobject
version_descriptionstring
regionstringAWS region.
string
string
string
string
object
object
string
string
array
object
string
object
array
object
array
string
object
object
string
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual dashboard resource, use das Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboards/index.md b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md index 0ca9206f64..a096b85bf8 100644 --- a/docs/aws-docs/providers/aws/quicksight/dashboards/index.md +++ b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dashboards in a region or create a dashboards resource, use dashboard to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of dashboards in a region or create a Namedashboards TypeResource DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type. -Idaws.quicksight.dashboards +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
dashboard_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of dashboards in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/data_set/index.md b/docs/aws-docs/providers/aws/quicksight/data_set/index.md index 39bb921c7f..00b457ca79 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_set/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_set resource, use data_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,35 +24,35 @@ Gets or operates on an individual data_set resource, use data Namedata_set TypeResource DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type. -Idaws.quicksight.data_set +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the resource.</p>
aws_account_idstring
column_groupsarray<p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
column_level_permission_rulesarray
consumed_spice_capacity_in_bytesnumber<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't<br/> imported into SPICE.</p>
created_timestring<p>The time that this dataset was created.</p>
data_set_idstring
dataset_parametersarray<p>The parameters declared in the dataset.</p>
field_foldersobject
import_modestring
last_updated_timestring<p>The last time that this dataset was updated.</p>
logical_table_mapobject
namestring<p>The display name for the dataset.</p>
output_columnsarray<p>The list of columns after all transforms. These columns are available in templates,<br/> analyses, and dashboards.</p>
permissionsarray<p>A list of resource permissions on the dataset.</p>
physical_table_mapobject
row_level_permission_data_setobject
row_level_permission_tag_configurationobject
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
ingestion_wait_policyobject
data_set_usage_configurationobject
data_set_refresh_propertiesobject
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the resource.</p>
string
array<p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
array
number<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't<br/> imported into SPICE.</p>
string<p>The time that this dataset was created.</p>
string
array<p>The parameters declared in the dataset.</p>
object
string
string<p>The last time that this dataset was updated.</p>
object
string<p>The display name for the dataset.</p>
array<p>The list of columns after all transforms. These columns are available in templates,<br/> analyses, and dashboards.</p>
array<p>A list of resource permissions on the dataset.</p>
object
object
object
array<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
object
object
object
stringAWS region.
@@ -62,19 +65,19 @@ Gets or operates on an individual data_set resource, use data Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sets/index.md b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md index 03335343e5..591cf43e6c 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_sets/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_sets in a region or create a data_sets resource, use data_set to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of data_sets in a region or create a Namedata_sets TypeResource DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type. -Idaws.quicksight.data_sets +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
data_set_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of data_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/data_source/index.md b/docs/aws-docs/providers/aws/quicksight/data_source/index.md index 2bceaa082d..fde34aac17 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_source/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_source resource, use data_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual data_source resource, use d Namedata_source TypeResource DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type. -Idaws.quicksight.data_source +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
alternate_data_source_parametersarray<p>A set of alternate data source parameters that you want to share for the credentials<br/> stored with this data source. The credentials are applied in tandem with the data source<br/> parameters when you copy a data source by using a create or update request. The API<br/> operation compares the <code>DataSourceParameters</code> structure that's in the request<br/> with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the<br/> structures are an exact match, the request is allowed to use the credentials from this<br/> existing data source. If the <code>AlternateDataSourceParameters</code> list is null,<br/> the <code>Credentials</code> originally used with this <code>DataSourceParameters</code><br/> are automatically allowed.</p>
arnstring<p>The Amazon Resource Name (ARN) of the data source.</p>
aws_account_idstring
created_timestring<p>The time that this data source was created.</p>
credentialsobject
data_source_idstring
data_source_parametersobject
error_infoobject
last_updated_timestring<p>The last time that this data source was updated.</p>
namestring<p>A display name for the data source.</p>
permissionsarray<p>A list of resource permissions on the data source.</p>
ssl_propertiesobject
statusstring
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>
typestring
vpc_connection_propertiesobject
regionstringAWS region.
array<p>A set of alternate data source parameters that you want to share for the credentials<br/> stored with this data source. The credentials are applied in tandem with the data source<br/> parameters when you copy a data source by using a create or update request. The API<br/> operation compares the <code>DataSourceParameters</code> structure that's in the request<br/> with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the<br/> structures are an exact match, the request is allowed to use the credentials from this<br/> existing data source. If the <code>AlternateDataSourceParameters</code> list is null,<br/> the <code>Credentials</code> originally used with this <code>DataSourceParameters</code><br/> are automatically allowed.</p>
string<p>The Amazon Resource Name (ARN) of the data source.</p>
string
string<p>The time that this data source was created.</p>
object
string
object
object
string<p>The last time that this data source was updated.</p>
string<p>A display name for the data source.</p>
array<p>A list of resource permissions on the data source.</p>
object
string
array<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>
string
object
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual data_source resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sources/index.md b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md index 767e2a482d..aff3c54d26 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_sources/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_sources in a region or create a data_sources resource, use data_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of data_sources in a region or create a Namedata_sources TypeResource DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type. -Idaws.quicksight.data_sources +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
data_source_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of data_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md index 09711736c4..51ff952f7e 100644 --- a/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual refresh_schedule resource, use refresh_schedules to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual refresh_schedule resource, use Namerefresh_schedule TypeResource DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type. -Idaws.quicksight.refresh_schedule +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the data source.</p>
aws_account_idstring
data_set_idstring
scheduleobject
regionstringAWS region.
string<p>The Amazon Resource Name (ARN) of the data source.</p>
string
string
object
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual refresh_schedule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md index 57cb08f31b..069f2bc659 100644 --- a/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of refresh_schedules in a region or create a refresh_schedules resource, use refresh_schedule to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of refresh_schedules in a region or create Namerefresh_schedules TypeResource DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type. -Idaws.quicksight.refresh_schedules +Id ## Fields - - - - + + + +
NameDatatypeDescription
aws_account_idstring
data_set_idstring
schedule/schedule_idstring<p>An unique identifier for the refresh schedule.</p>
regionstringAWS region.
string
string
string<p>An unique identifier for the refresh schedule.</p>
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of refresh_schedules in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/template/index.md b/docs/aws-docs/providers/aws/quicksight/template/index.md index 0010ab146c..e5f30f321c 100644 --- a/docs/aws-docs/providers/aws/quicksight/template/index.md +++ b/docs/aws-docs/providers/aws/quicksight/template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual template resource, use templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual template resource, use temp Nametemplate TypeResource DescriptionDefinition of the AWS::QuickSight::Template Resource Type. -Idaws.quicksight.template +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
created_timestring
definitionobject
last_updated_timestring
namestring
permissionsarray
source_entityobject
tagsarray
template_idstring
validation_strategyobject
versionobject
version_descriptionstring
regionstringAWS region.
string
string
string
object
string
string
array
object
array
string
object
object
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual template resource, use temp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/templates/index.md b/docs/aws-docs/providers/aws/quicksight/templates/index.md index b8b6e8ba03..868dba3a06 100644 --- a/docs/aws-docs/providers/aws/quicksight/templates/index.md +++ b/docs/aws-docs/providers/aws/quicksight/templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of templates in a region or create a templates resource, use template to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of templates in a region or create a Nametemplates TypeResource DescriptionDefinition of the AWS::QuickSight::Template Resource Type. -Idaws.quicksight.templates +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
template_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/theme/index.md b/docs/aws-docs/providers/aws/quicksight/theme/index.md index ee1ce183c6..a50c2c7638 100644 --- a/docs/aws-docs/providers/aws/quicksight/theme/index.md +++ b/docs/aws-docs/providers/aws/quicksight/theme/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual theme resource, use themes to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual theme resource, use themes< Nametheme TypeResource DescriptionDefinition of the AWS::QuickSight::Theme Resource Type. -Idaws.quicksight.theme +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
base_theme_idstring
configurationobject
created_timestring
last_updated_timestring
namestring
permissionsarray
tagsarray
theme_idstring
typestring
versionobject
version_descriptionstring
regionstringAWS region.
string
string
string
object
string
string
string
array
array
string
string
object
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual theme resource, use themes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/themes/index.md b/docs/aws-docs/providers/aws/quicksight/themes/index.md index bad7d5f1e7..95340d447a 100644 --- a/docs/aws-docs/providers/aws/quicksight/themes/index.md +++ b/docs/aws-docs/providers/aws/quicksight/themes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of themes in a region or create a themes resource, use theme to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of themes in a region or create a the Namethemes TypeResource DescriptionDefinition of the AWS::QuickSight::Theme Resource Type. -Idaws.quicksight.themes +Id ## Fields - - - + + +
NameDatatypeDescription
theme_idstring
aws_account_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of themes in a region or create a the Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/topic/index.md b/docs/aws-docs/providers/aws/quicksight/topic/index.md index d02fb6c8e0..04759274f7 100644 --- a/docs/aws-docs/providers/aws/quicksight/topic/index.md +++ b/docs/aws-docs/providers/aws/quicksight/topic/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual topic resource, use topics to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual topic resource, use topics< Nametopic TypeResource DescriptionDefinition of the AWS::QuickSight::Topic Resource Type. -Idaws.quicksight.topic +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
data_setsarray
descriptionstring
namestring
topic_idstring
user_experience_versionstring
regionstringAWS region.
string
string
array
string
string
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual topic resource, use topics< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/topics/index.md b/docs/aws-docs/providers/aws/quicksight/topics/index.md index 4fe1cd4b0d..ca27b91de0 100644 --- a/docs/aws-docs/providers/aws/quicksight/topics/index.md +++ b/docs/aws-docs/providers/aws/quicksight/topics/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of topics in a region or create a topics resource, use topic to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of topics in a region or create a top Nametopics TypeResource DescriptionDefinition of the AWS::QuickSight::Topic Resource Type. -Idaws.quicksight.topics +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
topic_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of topics in a region or create a top Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md index 69f67448f8..82cff436ef 100644 --- a/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vpc_connection resource, use vpc_connections to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual vpc_connection resource, use Namevpc_connection TypeResource DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type. -Idaws.quicksight.vpc_connection +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
namestring
vpc_connection_idstring
vpc_idstring
security_group_idsarray
subnet_idsarray
dns_resolversarray
statusstring
availability_statusstring
network_interfacesarray
role_arnstring
created_timestring
last_updated_timestring
tagsarray
regionstringAWS region.
string
string
string
string
string
array
array
array
string
string
array
string
string
string
array
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual vpc_connection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md index 0f07f01e42..63ea34b193 100644 --- a/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of vpc_connections in a region or create a vpc_connections resource, use vpc_connection to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of vpc_connections in a region or create a Namevpc_connections TypeResource DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type. -Idaws.quicksight.vpc_connections +Id ## Fields - - - + + +
NameDatatypeDescription
aws_account_idstring
vpc_connection_idundefined
regionstringAWS region.
string
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of vpc_connections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ram/permission/index.md b/docs/aws-docs/providers/aws/ram/permission/index.md index 92561c48c5..e10efd9310 100644 --- a/docs/aws-docs/providers/aws/ram/permission/index.md +++ b/docs/aws-docs/providers/aws/ram/permission/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual permission resource, use permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual permission resource, use pe Namepermission TypeResource DescriptionResource type definition for AWS::RAM::Permission -Idaws.ram.permission +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe name of the permission.
versionstringVersion of the permission.
is_resource_type_defaultbooleanSet to true to use this as the default permission.
permission_typestring
resource_typestringThe resource type this permission can be used with.
policy_templateobjectPolicy template for the permission.
tagsarray
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual permission resource, use pe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ram/permissions/index.md b/docs/aws-docs/providers/aws/ram/permissions/index.md index 4f5c2a669f..61204debdb 100644 --- a/docs/aws-docs/providers/aws/ram/permissions/index.md +++ b/docs/aws-docs/providers/aws/ram/permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of permissions in a region or create a permissions resource, use permission to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of permissions in a region or create a Namepermissions TypeResource DescriptionResource type definition for AWS::RAM::Permission -Idaws.ram.permissions +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of permissions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md index fb903c1989..f294419501 100644 --- a/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual customdb_engine_version resource, use customdb_engine_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual customdb_engine_version resource, Namecustomdb_engine_version TypeResource DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. -Idaws.rds.customdb_engine_version +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
database_installation_files_s3_bucket_namestringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.
database_installation_files_s3_prefixstringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.
descriptionstringAn optional description of your CEV.
enginestringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
engine_versionstringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
kms_key_idstringThe AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
manifeststringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
db_engine_version_arnstringThe ARN of the custom engine version.
source_custom_db_engine_version_identifierstringThe identifier of the source custom engine version.
use_aws_provided_latest_imagebooleanA value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.
image_idstringThe identifier of Amazon Machine Image (AMI) used for CEV.
statusstringThe availability status to be assigned to the CEV.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.
stringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.
stringAn optional description of your CEV.
stringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
stringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
stringThe AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
stringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
stringThe ARN of the custom engine version.
stringThe identifier of the source custom engine version.
booleanA value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.
stringThe identifier of Amazon Machine Image (AMI) used for CEV.
stringThe availability status to be assigned to the CEV.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual customdb_engine_version resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md index 29b6c190f5..83c3d0a4f5 100644 --- a/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of customdb_engine_versions in a region or create a customdb_engine_versions resource, use customdb_engine_version to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of customdb_engine_versions in a region or Namecustomdb_engine_versions TypeResource DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. -Idaws.rds.customdb_engine_versions +Id ## Fields - - - + + +
NameDatatypeDescription
enginestringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
engine_versionstringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
regionstringAWS region.
stringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
stringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of customdb_engine_versions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster/index.md b/docs/aws-docs/providers/aws/rds/db_cluster/index.md index 076e16f317..589b02e27c 100644 --- a/docs/aws-docs/providers/aws/rds/db_cluster/index.md +++ b/docs/aws-docs/providers/aws/rds/db_cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_cluster resource, use db_clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,72 +24,72 @@ Gets or operates on an individual db_cluster resource, use db Namedb_cluster TypeResource DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. -Idaws.rds.db_cluster +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
endpointobject
read_endpointobject
allocated_storageintegerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
associated_rolesarrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
availability_zonesarrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
auto_minor_version_upgradebooleanA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
backtrack_windowintegerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
backup_retention_periodintegerThe number of days for which automated backups are retained.
copy_tags_to_snapshotbooleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
database_namestringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
db_cluster_arnstringThe Amazon Resource Name (ARN) for the DB cluster.
db_cluster_instance_classstringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
db_cluster_resource_idstringThe AWS Region-unique, immutable identifier for the DB cluster.
db_instance_parameter_group_namestringThe name of the DB parameter group to apply to all instances of the DB cluster.
db_system_idstringReserved for future use.
global_cluster_identifierstringIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.<br/><br/>If you aren't configuring a global database cluster, don't specify this property.
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
db_cluster_parameter_group_namestringThe name of the DB cluster parameter group to associate with this DB cluster.
db_subnet_group_namestringA DB subnet group that you want to associate with this DB cluster.
deletion_protectionbooleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
domainstringThe Active Directory directory ID to create the DB cluster in.
domain_iam_role_namestringSpecify the name of the IAM role to be used when making API calls to the Directory Service.
enable_cloudwatch_logs_exportsarrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enable_global_write_forwardingbooleanSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
enable_http_endpointbooleanA value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
enable_iam_database_authenticationbooleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
enginestringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
engine_modestringThe DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
engine_versionstringThe version number of the database engine to use.
manage_master_user_passwordbooleanA value that indicates whether to manage the master user password with AWS Secrets Manager.
iopsintegerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
kms_key_idstringThe Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
master_usernamestringThe name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
master_user_passwordstringThe master password for the DB instance.
master_user_secretobjectContains the secret managed by RDS in AWS Secrets Manager for the master user password.
monitoring_intervalintegerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
monitoring_role_arnstringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
network_typestringThe network type of the DB cluster.
performance_insights_enabledbooleanA value that indicates whether to turn on Performance Insights for the DB cluster.
performance_insights_kms_key_idstringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
performance_insights_retention_periodintegerThe amount of time, in days, to retain Performance Insights data.
portintegerThe port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
preferred_backup_windowstringThe daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
preferred_maintenance_windowstringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
publicly_accessiblebooleanA value that indicates whether the DB cluster is publicly accessible.
replication_source_identifierstringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
restore_to_timestringThe date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
restore_typestringThe type of restore to be performed. You can specify one of the following values:<br/>full-copy - The new DB cluster is restored as a full copy of the source DB cluster.<br/>copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
serverless_v2_scaling_configurationobjectContains the scaling configuration of an Aurora Serverless v2 DB cluster.
scaling_configurationobjectThe ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
snapshot_identifierstringThe identifier for the DB snapshot or DB cluster snapshot to restore from.<br/>You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.<br/>After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
source_db_cluster_identifierstringThe identifier of the source DB cluster from which to restore.
source_regionstringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storage_encryptedbooleanIndicates whether the DB instance is encrypted.<br/>If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
storage_throughputintegerSpecifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
storage_typestringSpecifies the storage type to be associated with the DB cluster.
tagsarrayAn array of key-value pairs to apply to this resource.
use_latest_restorable_timebooleanA value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
vpc_security_group_idsarrayA list of EC2 VPC security groups to associate with this DB cluster.
regionstringAWS region.
object
object
integerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the 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 AWS services on your behalf.
arrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
integerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
integerThe number of days for which automated backups are retained.
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.
stringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
stringThe Amazon Resource Name (ARN) for the DB cluster.
stringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
stringThe AWS Region-unique, immutable identifier for the DB cluster.
stringThe name of the DB parameter group to apply to all instances of the DB cluster.
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 resource.<br/><br/>If you aren't configuring a global database cluster, don't specify this property.
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
stringThe name of the DB cluster parameter group to associate with this DB cluster.
stringA DB subnet group that you want to associate with this DB cluster.
booleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
stringThe Active Directory directory ID to create the DB cluster in.
stringSpecify the name of the IAM role to be used when making API calls to the Directory Service.
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
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.
booleanA value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
stringThe DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
stringThe version number of the database engine to use.
booleanA value that indicates whether to manage the master user password with AWS Secrets Manager.
integerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
stringThe name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
stringThe master password for the DB instance.
objectContains the secret managed by RDS in AWS Secrets Manager for the master user password.
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
stringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
stringThe network type of the DB cluster.
booleanA value that indicates whether to turn on Performance Insights for the DB cluster.
stringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
integerThe amount of time, in days, to retain Performance Insights data.
integerThe port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
stringThe daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
booleanA value that indicates whether the DB cluster is publicly accessible.
stringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
stringThe date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
stringThe type of restore to be performed. You can specify one of the following values:<br/>full-copy - The new DB cluster is restored as a full copy of the source DB cluster.<br/>copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
objectContains the scaling configuration of an Aurora Serverless v2 DB cluster.
objectThe ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
stringThe identifier for the DB snapshot or DB cluster snapshot to restore from.<br/>You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.<br/>After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
stringThe identifier of the source DB cluster from which to restore.
stringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
booleanIndicates whether the DB instance is encrypted.<br/>If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
integerSpecifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
stringSpecifies the storage type to be associated with the DB cluster.
arrayAn array of key-value pairs to apply to this resource.
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.
arrayA list of EC2 VPC security groups to associate with this DB cluster.
stringAWS region.
@@ -99,19 +102,19 @@ Gets or operates on an individual db_cluster resource, use db Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md index 43927176cc..5c87605172 100644 --- a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_cluster_parameter_group resource, use db_cluster_parameter_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual db_cluster_parameter_group resour Namedb_cluster_parameter_group TypeResource DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide. -Idaws.rds.db_cluster_parameter_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstringA friendly description for this DB cluster parameter group.
familystringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
parametersobjectAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
db_cluster_parameter_group_namestring
tagsarrayThe list of tags for the cluster parameter group.
regionstringAWS region.
stringA friendly description for this DB cluster parameter group.
stringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
objectAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
string
arrayThe list of tags for the cluster parameter group.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual db_cluster_parameter_group resour Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md index 77a65a1bf4..d5e37f3cc4 100644 --- a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_cluster_parameter_groups in a region or create a db_cluster_parameter_groups resource, use db_cluster_parameter_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_cluster_parameter_groups in a region Namedb_cluster_parameter_groups TypeResource DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide. -Idaws.rds.db_cluster_parameter_groups +Id ## Fields - - + +
NameDatatypeDescription
db_cluster_parameter_group_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_cluster_parameter_groups in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_clusters/index.md b/docs/aws-docs/providers/aws/rds/db_clusters/index.md index 150f55f4ea..c8377e24a6 100644 --- a/docs/aws-docs/providers/aws/rds/db_clusters/index.md +++ b/docs/aws-docs/providers/aws/rds/db_clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_clusters in a region or create a db_clusters resource, use db_cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_clusters in a region or create a Namedb_clusters TypeResource DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. -Idaws.rds.db_clusters +Id ## Fields - - + +
NameDatatypeDescription
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
regionstringAWS region.
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_clusters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_instance/index.md b/docs/aws-docs/providers/aws/rds/db_instance/index.md index e251be9ecf..83f43bc2ee 100644 --- a/docs/aws-docs/providers/aws/rds/db_instance/index.md +++ b/docs/aws-docs/providers/aws/rds/db_instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_instance resource, use db_instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,92 +24,92 @@ Gets or operates on an individual db_instance resource, use d Namedb_instance TypeResource DescriptionThe ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.<br/> For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.<br/> For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.<br/> If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.<br/> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an -Idaws.rds.db_instance +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
allocated_storagestringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.<br/> If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). <br/> *Amazon Aurora* <br/> Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.<br/> *Db2* <br/> Constraints to the amount of storage for each storage type are the following:<br/> + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.<br/> + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.<br/> <br/> *MySQL* <br/> Constraints to the amount of storage for each storage type are the following: <br/> + General Purpose (SSD) storage (gp2): Must be an integer fro
allow_major_version_upgradebooleanA value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.<br/> Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
associated_rolesarrayThe IAMlong (IAM) roles associated with the DB instance. <br/> *Amazon Aurora* <br/> Not applicable. The associated roles are managed by the DB cluster.
auto_minor_version_upgradebooleanA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
automatic_backup_replication_regionstringThe destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.
availability_zonestringThe Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).<br/> For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.<br/> Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.<br/> Constraints:<br/> + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.<br/> + The specified Availability Zone must be in the same AWS-Region as the current endpoint.<br/> <br/> Example: ``us-east-1d``
backup_retention_periodintegerThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.<br/> *Amazon Aurora*<br/> Not applicable. The retention period for automated backups is managed by the DB cluster.<br/> Default: 1<br/> Constraints:<br/> + Must be a value from 0 to 35<br/> + Can't be set to 0 if the DB instance is a source to read replicas
ca_certificate_identifierstringThe identifier of the CA certificate for this DB instance.<br/> For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
certificate_detailsobjectThe details of the DB instance's server certificate.
certificate_rotation_restartbooleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.<br/> By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.<br/> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.<br/> If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:<br/> + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* <br/> + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui
character_set_namestringFor supported engines, indicates that the DB instance should be associated with the specified character set.<br/> *Amazon Aurora* <br/> Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
copy_tags_to_snapshotbooleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.<br/> This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
custom_iam_instance_profilestringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.<br/> This setting is required for RDS Custom.<br/> Constraints:<br/> + The profile must exist in your account.<br/> + The profile must have an IAM role that Amazon EC2 has permissions to assume.<br/> + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.<br/> <br/> For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
db_cluster_identifierstringThe identifier of the DB cluster that the instance will belong to.
db_cluster_snapshot_identifierstringThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.<br/> For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.<br/> Constraints:<br/> + Must match the identifier of an existing Multi-AZ DB cluster snapshot.<br/> + Can't be specified when ``DBSnapshotIdentifier`` is specified.<br/> + Must be specified when ``DBSnapshotIdentifier`` isn't specified.<br/> + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.<br/> + Can't be the identifier of an Aurora DB cluster snapshot.<br/> + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
db_instance_arnstring
db_instance_classstringThe compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines.<br/> For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/).
db_instance_identifierstringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
dbi_resource_idstring
db_namestringThe meaning of this parameter differs according to the database engine you use.<br/> If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.<br/> *Amazon Aurora* <br/> Not applicable. The database name is managed by the DB cluster.<br/> *Db2* <br/> The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).<br/> + Can't be a word reserved by the specified database engine.<br/> <br/> *MySQL* <br/> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Can't be a word reserved by the specified database engine<br/> <br/> *MariaDB* <br/> The name of the database to create when the DB instance is
db_parameter_group_namestringThe name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.<br/> To list all of the available DB parameter group names, use the following command:<br/> ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text``<br/> If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.<br/> If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
db_security_groupsarrayA list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.<br/> If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.<br/> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:<br/> + ``AllocatedStorage``<br/> + ``AutoMinorVersionUpgrade``<br/> + ``AvailabilityZone``<br/> + ``BackupRetentionPeriod``<br/> + ``CharacterSetName``<br/> + ``DBInstanceClass``<br/> + ``DBName``<br/> + ``DBParameterGroupName``<br/> + ``DBSecurityGroups``<br/> + ``DBSubnetGroupName``<br/> + ``Engine``<br/> + ``EngineVersion``<br/> + ``Iops``<br/> + ``LicenseModel``<br/> +
db_snapshot_identifierstringThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.<br/> By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.<br/> Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo
db_subnet_group_namestringA DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. <br/> If there's no DB subnet group, then the DB instance isn't a VPC DB instance.<br/> For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. <br/> *Amazon Aurora*<br/> Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
db_system_idstringThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.
dedicated_log_volumebooleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
delete_automated_backupsbooleanA value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.<br/> *Amazon Aurora*<br/> Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
deletion_protectionbooleanA value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). <br/> *Amazon Aurora* <br/> Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
domainstringThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.<br/> For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
domain_auth_secret_arnstringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.<br/> Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
domain_dns_ipsarrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.<br/> Constraints:<br/> + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.<br/> <br/> Example: ``123.124.125.126,234.235.236.237``
domain_fqdnstringThe fully qualified domain name (FQDN) of an Active Directory domain.<br/> Constraints:<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``mymanagedADtest.mymanagedAD.mydomain``
domain_iam_role_namestringThe name of the IAM role to use when making API calls to the Directory Service.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (The domain is managed by the DB cluster.)<br/> + RDS Custom
domain_oustringThe Active Directory organizational unit for your DB instance to join.<br/> Constraints:<br/> + Must be in the distinguished name format.<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``
enable_cloudwatch_logs_exportsarrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. CloudWatch Logs exports are managed by the DB cluster. <br/> *Db2* <br/> Valid values: ``diag.log``, ``notify.log`` <br/> *MariaDB* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Microsoft SQL Server* <br/> Valid values: ``agent``, ``error`` <br/> *MySQL* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Oracle* <br/> Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` <br/> *PostgreSQL* <br/> Valid values: ``postgresql``, ``upgrade``
enable_iam_database_authenticationbooleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.<br/> This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* <br/> *Amazon Aurora* <br/> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enable_performance_insightsbooleanSpecifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.<br/> This setting doesn't apply to RDS Custom DB instances.
endpointobjectThe connection endpoint for the DB instance.<br/> The endpoint might not be shown for instances with the status of ``creating``.
enginestringThe name of the database engine that you want to use for this DB instance.<br/> Not every database engine is available in every AWS Region.<br/> When you are creating a DB instance, the ``Engine`` property is required.<br/> Valid Values:<br/> + ``aurora-mysql`` (for Aurora MySQL DB instances)<br/> + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)<br/> + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)<br/> + ``db2-ae``<br/> + ``db2-se``<br/> + ``mariadb``<br/> + ``mysql``<br/> + ``oracle-ee``<br/> + ``oracle-ee-cdb``<br/> + ``oracle-se2``<br/> + ``oracle-se2-cdb``<br/> + ``postgres``<br/> + ``sqlserver-ee``<br/> + ``sqlserver-se``<br/> + ``sqlserver-ex``<br/> + ``sqlserver-web``
engine_versionstringThe version number of the database engine to use.<br/> For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.<br/> The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.<br/> *Amazon Aurora* <br/> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.<br/> *Db2* <br/> See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *MariaDB*<br/> See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *Microsoft SQL Server*<br/> See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
manage_master_user_passwordbooleanSpecifies whether to manage the master user password with AWS Secrets Manager.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* <br/> Constraints:<br/> + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
iopsintegerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. <br/> If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.<br/> If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.<br/> Constraints:<br/> + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.<br/> + For RDS for SQL Server - Must be a multip
kms_key_idstringThe ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. <br/> If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region.<br/> If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.<br/> If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us
license_modelstringLicense model information for this DB instance.<br/> Valid Values:<br/> + Aurora MySQL - ``general-public-license``<br/> + Aurora PostgreSQL - ``postgresql-license``<br/> + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*<br/> + RDS for MariaDB - ``general-public-license``<br/> + RDS for Microsoft SQL Server - ``license-included``<br/> + RDS for MySQL - ``general-public-license``<br/> + RDS for Oracle - ``bring-your-own-license`` or ``license-included``<br/> + RDS for PostgreSQL - ``postgresql-license``<br/> <br/> If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
master_usernamestringThe master user name for the DB instance.<br/> If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.<br/> When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.<br/> *Amazon Aurora* <br/> Not applicable. The name for the master user is managed by the DB cluster. <br/> *RDS for Db2* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MariaDB* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for Microsoft SQL Server* <br/> Constraints:<br/> + Must be 1 to 128 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MySQL* <br/> Constrain
master_user_passwordstringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".<br/> *Amazon Aurora* <br/> Not applicable. The password for the master user is managed by the DB cluster.<br/> *RDS for Db2* <br/> Must contain from 8 to 255 characters.<br/> *RDS for MariaDB* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Microsoft SQL Server* <br/> Constraints: Must contain from 8 to 128 characters.<br/> *RDS for MySQL* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Oracle* <br/> Constraints: Must contain from 8 to 30 characters.<br/> *RDS for PostgreSQL* <br/> Constraints: Must contain from 8 to 128 characters.
master_user_secretobjectThe secret managed by RDS in AWS Secrets Manager for the master user password.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
max_allocated_storageintegerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.<br/> For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (Storage is managed by the DB cluster.)<br/> + RDS Custom
monitoring_intervalintegerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.<br/> If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.<br/> This setting doesn't apply to RDS Custom.<br/> Valid Values: ``0, 1, 5, 10, 15, 30, 60``
monitoring_role_arnstringThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.<br/> If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.<br/> This setting doesn't apply to RDS Custom DB instances.
multi_azbooleanSpecifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. <br/> For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.
nchar_character_set_namestringThe name of the NCHAR character set for the Oracle DB instance.<br/> This setting doesn't apply to RDS Custom DB instances.
network_typestringThe network type of the DB instance.<br/> Valid values:<br/> + ``IPV4`` <br/> + ``DUAL`` <br/> <br/> The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).<br/> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
option_group_namestringIndicates that the DB instance should be associated with the specified option group.<br/> Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
performance_insights_kms_key_idstringThe AWS KMS key identifier for encryption of Performance Insights data.<br/> The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.<br/> If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.<br/> For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
performance_insights_retention_periodintegerThe number of days to retain Performance Insights data.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Valid Values:<br/> + ``7`` <br/> + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)<br/> + ``731`` <br/> <br/> Default: ``7`` days<br/> If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.
portstringThe port number on which the database accepts connections.<br/> *Amazon Aurora* <br/> Not applicable. The port number is managed by the DB cluster.<br/> *Db2* <br/> Default value: ``50000``
preferred_backup_windowstringThe daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* <br/> Constraints:<br/> + Must be in the format ``hh24:mi-hh24:mi``.<br/> + Must be in Universal Coordinated Time (UTC).<br/> + Must not conflict with the preferred maintenance window.<br/> + Must be at least 30 minutes.<br/> <br/> *Amazon Aurora* <br/> Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
preferred_maintenance_windowstringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).<br/> Format: ``ddd:hh24:mi-ddd:hh24:mi`` <br/> The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* <br/> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.<br/> Constraints: Minimum 30-minute window.
processor_featuresarrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.<br/> This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
promotion_tierintegerThe order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Default: ``1`` <br/> Valid Values: ``0 - 15``
publicly_accessiblebooleanIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. <br/> The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
replica_modestringThe open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.<br/> This setting is only supported in RDS for Oracle.<br/> Default: ``open-read-only``<br/> Valid Values: ``open-read-only`` or ``mounted``
restore_timestringThe date and time to restore from.<br/> Constraints:<br/> + Must be a time in Universal Coordinated Time (UTC) format.<br/> + Must be before the latest restorable time for the DB instance.<br/> + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.<br/> <br/> Example: ``2009-09-07T23:45:00Z``
source_db_cluster_identifierstringThe identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.<br/> Constraints:<br/> + Must be the identifier of an existing Multi-AZ DB cluster.<br/> + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.<br/> + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.<br/> + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
source_dbi_resource_idstringThe resource ID of the source DB instance from which to restore.
source_db_instance_automated_backups_arnstringThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.<br/> This setting doesn't apply to RDS Custom.
source_db_instance_identifierstringIf you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.<br/> + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the
source_regionstringThe ID of the region that contains the source DB instance for the read replica.
storage_encryptedbooleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.<br/> If you specify the ``KmsKeyId`` property, then you must enable encryption.<br/> If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``.<br/> *Amazon Aurora*<br/> Not applicable. The encrypt
storage_typestringSpecifies the storage type to be associated with the DB instance.<br/> Valid values: ``gp2 | gp3 | io1 | standard`` <br/> The ``standard`` value is also known as magnetic.<br/> If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. <br/> Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` <br/> For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
storage_throughputintegerSpecifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. <br/> This setting doesn't apply to RDS Custom or Amazon Aurora.
tagsarrayAn optional array of key-value pairs to apply to this DB instance.
tde_credential_arnstring
tde_credential_passwordstring
timezonestringThe time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
use_default_processor_featuresbooleanSpecifies whether the DB instance class of the DB instance uses its default processor features.<br/> This setting doesn't apply to RDS Custom DB instances.
use_latest_restorable_timebooleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.<br/> Constraints:<br/> + Can't be specified if the ``RestoreTime`` parameter is provided.
vpc_security_groupsarrayA list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.<br/> If you plan to update the resource, don't specify VPC security groups in a shared VPC.<br/> If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.<br/> You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:<br/> + You can't revert to using an RDS security group after you establish a VPC security group membership.<br/> + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
regionstringAWS region.
stringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.<br/> If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). <br/> *Amazon Aurora* <br/> Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.<br/> *Db2* <br/> Constraints to the amount of storage for each storage type are the following:<br/> + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.<br/> + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.<br/> <br/> *MySQL* <br/> Constraints to the amount of storage for each storage type are the following: <br/> + General Purpose (SSD) storage (gp2): Must be an integer fro
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.<br/> Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
arrayThe IAMlong (IAM) roles associated with the DB instance. <br/> *Amazon Aurora* <br/> 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 destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.
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).<br/> For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.<br/> Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.<br/> Constraints:<br/> + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.<br/> + The specified Availability Zone must be in the same AWS-Region as the current endpoint.<br/> <br/> Example: ``us-east-1d``
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.<br/> *Amazon Aurora*<br/> Not applicable. The retention period for automated backups is managed by the DB cluster.<br/> Default: 1<br/> Constraints:<br/> + Must be a value from 0 to 35<br/> + Can't be set to 0 if the DB instance is a source to read replicas
stringThe identifier of the CA certificate for this DB instance.<br/> For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
objectThe details of the DB instance's server certificate.
booleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.<br/> By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.<br/> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.<br/> If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:<br/> + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* <br/> + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui
stringFor supported engines, indicates that the DB instance should be associated with the specified character set.<br/> *Amazon Aurora* <br/> Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
booleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.<br/> This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
stringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.<br/> This setting is required for RDS Custom.<br/> Constraints:<br/> + The profile must exist in your account.<br/> + The profile must have an IAM role that Amazon EC2 has permissions to assume.<br/> + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.<br/> <br/> For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
stringThe identifier of the DB cluster that the instance will belong to.
stringThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.<br/> For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.<br/> Constraints:<br/> + Must match the identifier of an existing Multi-AZ DB cluster snapshot.<br/> + Can't be specified when ``DBSnapshotIdentifier`` is specified.<br/> + Must be specified when ``DBSnapshotIdentifier`` isn't specified.<br/> + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.<br/> + Can't be the identifier of an Aurora DB cluster snapshot.<br/> + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
string
stringThe compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines.<br/> For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/).
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).<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe meaning of this parameter differs according to the database engine you use.<br/> If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.<br/> *Amazon Aurora* <br/> Not applicable. The database name is managed by the DB cluster.<br/> *Db2* <br/> The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).<br/> + Can't be a word reserved by the specified database engine.<br/> <br/> *MySQL* <br/> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Can't be a word reserved by the specified database engine<br/> <br/> *MariaDB* <br/> The name of the database to create when the DB instance is
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.<br/> To list all of the available DB parameter group names, use the following command:<br/> ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text``<br/> If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.<br/> If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
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.<br/> If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.<br/> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:<br/> + ``AllocatedStorage``<br/> + ``AutoMinorVersionUpgrade``<br/> + ``AvailabilityZone``<br/> + ``BackupRetentionPeriod``<br/> + ``CharacterSetName``<br/> + ``DBInstanceClass``<br/> + ``DBName``<br/> + ``DBParameterGroupName``<br/> + ``DBSecurityGroups``<br/> + ``DBSubnetGroupName``<br/> + ``Engine``<br/> + ``EngineVersion``<br/> + ``Iops``<br/> + ``LicenseModel``<br/> +
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.<br/> By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.<br/> Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo
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. <br/> If there's no DB subnet group, then the DB instance isn't a VPC DB instance.<br/> For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. <br/> *Amazon Aurora*<br/> Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
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.<br/> *Amazon Aurora*<br/> Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
booleanA value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). <br/> *Amazon Aurora* <br/> Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
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.<br/> 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.<br/> Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
arrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.<br/> Constraints:<br/> + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.<br/> <br/> Example: ``123.124.125.126,234.235.236.237``
stringThe fully qualified domain name (FQDN) of an Active Directory domain.<br/> Constraints:<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``mymanagedADtest.mymanagedAD.mydomain``
stringThe name of the IAM role to use when making API calls to the Directory Service.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (The domain is managed by the DB cluster.)<br/> + RDS Custom
stringThe Active Directory organizational unit for your DB instance to join.<br/> Constraints:<br/> + Must be in the distinguished name format.<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``
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*.<br/> *Amazon Aurora* <br/> Not applicable. CloudWatch Logs exports are managed by the DB cluster. <br/> *Db2* <br/> Valid values: ``diag.log``, ``notify.log`` <br/> *MariaDB* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Microsoft SQL Server* <br/> Valid values: ``agent``, ``error`` <br/> *MySQL* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Oracle* <br/> Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` <br/> *PostgreSQL* <br/> Valid values: ``postgresql``, ``upgrade``
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.<br/> This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* <br/> *Amazon Aurora* <br/> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
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*.<br/> This setting doesn't apply to RDS Custom DB instances.
objectThe connection endpoint for the DB instance.<br/> The endpoint might not be shown for instances with the status of ``creating``.
stringThe name of the database engine that you want to use for this DB instance.<br/> Not every database engine is available in every AWS Region.<br/> When you are creating a DB instance, the ``Engine`` property is required.<br/> Valid Values:<br/> + ``aurora-mysql`` (for Aurora MySQL DB instances)<br/> + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)<br/> + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)<br/> + ``db2-ae``<br/> + ``db2-se``<br/> + ``mariadb``<br/> + ``mysql``<br/> + ``oracle-ee``<br/> + ``oracle-ee-cdb``<br/> + ``oracle-se2``<br/> + ``oracle-se2-cdb``<br/> + ``postgres``<br/> + ``sqlserver-ee``<br/> + ``sqlserver-se``<br/> + ``sqlserver-ex``<br/> + ``sqlserver-web``
stringThe version number of the database engine to use.<br/> For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.<br/> The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.<br/> *Amazon Aurora* <br/> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.<br/> *Db2* <br/> See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *MariaDB*<br/> See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *Microsoft SQL Server*<br/> See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* <br/> Constraints:<br/> + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
integerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. <br/> If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.<br/> If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.<br/> Constraints:<br/> + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.<br/> + For RDS for SQL Server - Must be a multip
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. <br/> If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region.<br/> If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.<br/> If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us
stringLicense model information for this DB instance.<br/> Valid Values:<br/> + Aurora MySQL - ``general-public-license``<br/> + Aurora PostgreSQL - ``postgresql-license``<br/> + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*<br/> + RDS for MariaDB - ``general-public-license``<br/> + RDS for Microsoft SQL Server - ``license-included``<br/> + RDS for MySQL - ``general-public-license``<br/> + RDS for Oracle - ``bring-your-own-license`` or ``license-included``<br/> + RDS for PostgreSQL - ``postgresql-license``<br/> <br/> If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
stringThe master user name for the DB instance.<br/> If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.<br/> When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.<br/> *Amazon Aurora* <br/> Not applicable. The name for the master user is managed by the DB cluster. <br/> *RDS for Db2* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MariaDB* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for Microsoft SQL Server* <br/> Constraints:<br/> + Must be 1 to 128 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MySQL* <br/> Constrain
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".<br/> *Amazon Aurora* <br/> Not applicable. The password for the master user is managed by the DB cluster.<br/> *RDS for Db2* <br/> Must contain from 8 to 255 characters.<br/> *RDS for MariaDB* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Microsoft SQL Server* <br/> Constraints: Must contain from 8 to 128 characters.<br/> *RDS for MySQL* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Oracle* <br/> Constraints: Must contain from 8 to 30 characters.<br/> *RDS for PostgreSQL* <br/> Constraints: Must contain from 8 to 128 characters.
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
integerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.<br/> For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (Storage is managed by the DB cluster.)<br/> + RDS Custom
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.<br/> If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.<br/> This setting doesn't apply to RDS Custom.<br/> Valid Values: ``0, 1, 5, 10, 15, 30, 60``
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*.<br/> If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.<br/> This setting doesn't apply to RDS Custom DB instances.
booleanSpecifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. <br/> For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.
stringThe name of the NCHAR character set for the Oracle DB instance.<br/> This setting doesn't apply to RDS Custom DB instances.
stringThe network type of the DB instance.<br/> Valid values:<br/> + ``IPV4`` <br/> + ``DUAL`` <br/> <br/> The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).<br/> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
stringIndicates that the DB instance should be associated with the specified option group.<br/> Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
stringThe AWS KMS key identifier for encryption of Performance Insights data.<br/> The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.<br/> If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.<br/> For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
integerThe number of days to retain Performance Insights data.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Valid Values:<br/> + ``7`` <br/> + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)<br/> + ``731`` <br/> <br/> Default: ``7`` days<br/> If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.
stringThe port number on which the database accepts connections.<br/> *Amazon Aurora* <br/> Not applicable. The port number is managed by the DB cluster.<br/> *Db2* <br/> Default value: ``50000``
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.* <br/> Constraints:<br/> + Must be in the format ``hh24:mi-hh24:mi``.<br/> + Must be in Universal Coordinated Time (UTC).<br/> + Must not conflict with the preferred maintenance window.<br/> + Must be at least 30 minutes.<br/> <br/> *Amazon Aurora* <br/> Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).<br/> Format: ``ddd:hh24:mi-ddd:hh24:mi`` <br/> The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* <br/> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.<br/> Constraints: Minimum 30-minute window.
arrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.<br/> This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
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*.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Default: ``1`` <br/> 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. <br/> The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
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*.<br/> This setting is only supported in RDS for Oracle.<br/> Default: ``open-read-only``<br/> Valid Values: ``open-read-only`` or ``mounted``
stringThe date and time to restore from.<br/> Constraints:<br/> + Must be a time in Universal Coordinated Time (UTC) format.<br/> + Must be before the latest restorable time for the DB instance.<br/> + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.<br/> <br/> Example: ``2009-09-07T23:45:00Z``
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.<br/> Constraints:<br/> + Must be the identifier of an existing Multi-AZ DB cluster.<br/> + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.<br/> + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.<br/> + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
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``.<br/> 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*.<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.<br/> + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the
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.<br/> If you specify the ``KmsKeyId`` property, then you must enable encryption.<br/> If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``.<br/> *Amazon Aurora*<br/> Not applicable. The encrypt
stringSpecifies the storage type to be associated with the DB instance.<br/> Valid values: ``gp2 | gp3 | io1 | standard`` <br/> The ``standard`` value is also known as magnetic.<br/> If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. <br/> Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` <br/> For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
integerSpecifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. <br/> This setting doesn't apply to RDS Custom or Amazon Aurora.
arrayAn optional array of key-value pairs to apply to this DB instance.
string
string
stringThe time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
booleanSpecifies whether the DB instance class of the DB instance uses its default processor features.<br/> This setting doesn't apply to RDS Custom DB instances.
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.<br/> Constraints:<br/> + 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.<br/> If you plan to update the resource, don't specify VPC security groups in a shared VPC.<br/> If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.<br/> You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:<br/> + You can't revert to using an RDS security group after you establish a VPC security group membership.<br/> + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
stringAWS region.
@@ -119,19 +122,19 @@ Gets or operates on an individual db_instance resource, use d Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_instances/index.md b/docs/aws-docs/providers/aws/rds/db_instances/index.md index 861294657a..700ec40784 100644 --- a/docs/aws-docs/providers/aws/rds/db_instances/index.md +++ b/docs/aws-docs/providers/aws/rds/db_instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_instances in a region or create a db_instances resource, use db_instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_instances in a region or create a Namedb_instances TypeResource DescriptionThe ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.<br/> For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.<br/> For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.<br/> If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.<br/> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an -Idaws.rds.db_instances +Id ## Fields - - + +
NameDatatypeDescription
db_instance_identifierstringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
regionstringAWS region.
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).<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_instances in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md index 95367a234f..d519bf1bb5 100644 --- a/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md +++ b/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_parameter_group resource, use db_parameter_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual db_parameter_group resource, use Namedb_parameter_group TypeResource DescriptionThe ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.<br/> This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.<br/> For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot. -Idaws.rds.db_parameter_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
db_parameter_group_namestringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
descriptionstringProvides the customer-specified description for this DB parameter group.
familystringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.<br/> The DB parameter group family can't be changed when updating a DB parameter group.<br/> To list all of the available parameter group families, use the following command:<br/> ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``<br/> The output contains duplicates.<br/> For more information, see ``CreateDBParameterGroup``.
parametersobjectAn array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.<br/> RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.<br/> For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> AWS CloudFormation doesn't support specifying an apply method for each individual
tagsarrayAn optional array of key-value pairs to apply to this DB parameter group.<br/> Currently, this is the only property that supports drift detection.
regionstringAWS region.
stringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
stringProvides the customer-specified description for this DB parameter group.
stringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.<br/> The DB parameter group family can't be changed when updating a DB parameter group.<br/> To list all of the available parameter group families, use the following command:<br/> ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``<br/> The output contains duplicates.<br/> For more information, see ``CreateDBParameterGroup``.
objectAn array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.<br/> RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.<br/> For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> AWS CloudFormation doesn't support specifying an apply method for each individual
arrayAn optional array of key-value pairs to apply to this DB parameter group.<br/> Currently, this is the only property that supports drift detection.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual db_parameter_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md index 1010201d3a..34f40d54a8 100644 --- a/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_parameter_groups in a region or create a db_parameter_groups resource, use db_parameter_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_parameter_groups in a region or creat Namedb_parameter_groups TypeResource DescriptionThe ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.<br/> This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.<br/> For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot. -Idaws.rds.db_parameter_groups +Id ## Fields - - + +
NameDatatypeDescription
db_parameter_group_namestringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
regionstringAWS region.
stringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_parameter_groups in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxies/index.md b/docs/aws-docs/providers/aws/rds/db_proxies/index.md index 34b7aef54d..6fd8bcec55 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxies/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_proxies in a region or create a db_proxies resource, use db_proxy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_proxies in a region or create a Namedb_proxies TypeResource DescriptionResource schema for AWS::RDS::DBProxy -Idaws.rds.db_proxies +Id ## Fields - - + +
NameDatatypeDescription
db_proxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_proxies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy/index.md b/docs/aws-docs/providers/aws/rds/db_proxy/index.md index 87fdbf1430..fcb31305e0 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_proxy resource, use db_proxies to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual db_proxy resource, use db_p Namedb_proxy TypeResource DescriptionResource schema for AWS::RDS::DBProxy -Idaws.rds.db_proxy +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
autharrayThe authorization mechanism that the proxy uses.
db_proxy_arnstringThe Amazon Resource Name (ARN) for the proxy.
db_proxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debug_loggingbooleanWhether the proxy includes detailed information about SQL statements in its logs.
endpointstringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
engine_familystringThe kinds of databases that the proxy can connect to.
idle_client_timeoutintegerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
require_tlsbooleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpc_idstringVPC ID to associate with the new DB proxy.
vpc_security_group_idsarrayVPC security group IDs to associate with the new proxy.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new proxy.
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual db_proxy resource, use db_p Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md index 9068bdab40..34a3826163 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_proxy_endpoint resource, use db_proxy_endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual db_proxy_endpoint resource, use < Namedb_proxy_endpoint TypeResource DescriptionResource schema for AWS::RDS::DBProxyEndpoint. -Idaws.rds.db_proxy_endpoint +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
db_proxy_endpoint_namestringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
db_proxy_endpoint_arnstringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
db_proxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
vpc_idstringVPC ID to associate with the new DB proxy endpoint.
vpc_security_group_idsarrayVPC security group IDs to associate with the new DB proxy endpoint.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new DB proxy endpoint.
endpointstringThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
target_rolestringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
is_defaultbooleanA value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual db_proxy_endpoint resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md index 054947a96b..2309f69f1e 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_proxy_endpoints in a region or create a db_proxy_endpoints resource, use db_proxy_endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_proxy_endpoints in a region or create Namedb_proxy_endpoints TypeResource DescriptionResource schema for AWS::RDS::DBProxyEndpoint. -Idaws.rds.db_proxy_endpoints +Id ## Fields - - + +
NameDatatypeDescription
db_proxy_endpoint_namestringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
regionstringAWS region.
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.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_proxy_endpoints in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md index eac0238218..5ba728d1bc 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_proxy_target_group resource, use db_proxy_target_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual db_proxy_target_group resource, u Namedb_proxy_target_group TypeResource DescriptionResource schema for AWS::RDS::DBProxyTargetGroup -Idaws.rds.db_proxy_target_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
db_proxy_namestringThe identifier for the proxy.
target_group_arnstringThe Amazon Resource Name (ARN) representing the target group.
target_group_namestringThe identifier for the DBProxyTargetGroup
connection_pool_configuration_infoobject
db_instance_identifiersarray
db_cluster_identifiersarray
regionstringAWS region.
stringThe identifier for the proxy.
stringThe Amazon Resource Name (ARN) representing the target group.
stringThe identifier for the DBProxyTargetGroup
object
array
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual db_proxy_target_group resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md index a143597d0b..064dc54ed8 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_proxy_target_groups in a region or create a db_proxy_target_groups resource, use db_proxy_target_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_proxy_target_groups in a region or cr Namedb_proxy_target_groups TypeResource DescriptionResource schema for AWS::RDS::DBProxyTargetGroup -Idaws.rds.db_proxy_target_groups +Id ## Fields - - + +
NameDatatypeDescription
target_group_arnstringThe Amazon Resource Name (ARN) representing the target group.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) representing the target group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_proxy_target_groups in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md index def37d49e4..8b55e161b4 100644 --- a/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md +++ b/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual db_subnet_group resource, use db_subnet_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual db_subnet_group resource, use Namedb_subnet_group TypeResource DescriptionThe ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. <br/> For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*. -Idaws.rds.db_subnet_group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
db_subnet_group_descriptionstringThe description for the DB subnet group.
db_subnet_group_namestringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
subnet_idsarrayThe EC2 Subnet IDs for the DB subnet group.
tagsarrayAn optional array of key-value pairs to apply to this DB subnet group.
regionstringAWS region.
stringThe description for the DB subnet group.
stringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
arrayThe EC2 Subnet IDs for the DB subnet group.
arrayAn optional array of key-value pairs to apply to this DB subnet group.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual db_subnet_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md index 425e610641..c1011e13b2 100644 --- a/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of db_subnet_groups in a region or create a db_subnet_groups resource, use db_subnet_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of db_subnet_groups in a region or create a Namedb_subnet_groups TypeResource DescriptionThe ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. <br/> For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*. -Idaws.rds.db_subnet_groups +Id ## Fields - - + +
NameDatatypeDescription
db_subnet_group_namestringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
regionstringAWS region.
stringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of db_subnet_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/event_subscription/index.md b/docs/aws-docs/providers/aws/rds/event_subscription/index.md index 7b8c03b5ba..9e98d0b440 100644 --- a/docs/aws-docs/providers/aws/rds/event_subscription/index.md +++ b/docs/aws-docs/providers/aws/rds/event_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_subscription resource, use event_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual event_subscription resource, use Nameevent_subscription TypeResource DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide. -Idaws.rds.event_subscription +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
subscription_namestringThe name of the subscription.
enabledbooleanA Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
event_categoriesarrayA list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
sns_topic_arnstringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
source_idsarrayThe list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
source_typestringThe type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
regionstringAWS region.
arrayAn array of key-value pairs to apply to this resource.
stringThe name of the subscription.
booleanA Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
arrayA list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
stringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
arrayThe list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
stringThe type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual event_subscription resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md index 5eda5a43b6..030d8d0861 100644 --- a/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_subscriptions in a region or create a event_subscriptions resource, use event_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_subscriptions in a region or creat Nameevent_subscriptions TypeResource DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide. -Idaws.rds.event_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
subscription_namestringThe name of the subscription.
regionstringAWS region.
stringThe name of the subscription.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_subscriptions in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/global_cluster/index.md b/docs/aws-docs/providers/aws/rds/global_cluster/index.md index 1c517a93d6..1cc0379b30 100644 --- a/docs/aws-docs/providers/aws/rds/global_cluster/index.md +++ b/docs/aws-docs/providers/aws/rds/global_cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual global_cluster resource, use global_clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual global_cluster resource, use Nameglobal_cluster TypeResource DescriptionResource Type definition for AWS::RDS::GlobalCluster -Idaws.rds.global_cluster +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
enginestringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
engine_versionstringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
deletion_protectionbooleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
global_cluster_identifierstringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
source_db_cluster_identifierstringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
storage_encryptedboolean The storage encryption setting for the new global database cluster.<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
regionstringAWS region.
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).<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
stringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
booleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
boolean The storage encryption setting for the new global database cluster.<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual global_cluster resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/global_clusters/index.md b/docs/aws-docs/providers/aws/rds/global_clusters/index.md index 1a6b7c7ee4..d91c4cf507 100644 --- a/docs/aws-docs/providers/aws/rds/global_clusters/index.md +++ b/docs/aws-docs/providers/aws/rds/global_clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of global_clusters in a region or create a global_clusters resource, use global_cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of global_clusters in a region or create a Nameglobal_clusters TypeResource DescriptionResource Type definition for AWS::RDS::GlobalCluster -Idaws.rds.global_clusters +Id ## Fields - - + +
NameDatatypeDescription
global_cluster_identifierstringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
regionstringAWS region.
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of global_clusters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/integration/index.md b/docs/aws-docs/providers/aws/rds/integration/index.md index aee67f28a1..0bed1504e6 100644 --- a/docs/aws-docs/providers/aws/rds/integration/index.md +++ b/docs/aws-docs/providers/aws/rds/integration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual integration resource, use integrations to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual integration resource, use i Nameintegration TypeResource DescriptionCreates a zero-ETL integration with Amazon Redshift. -Idaws.rds.integration +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
integration_namestringThe name of the integration.
descriptionstringThe description of the integration.
tagsarrayAn array of key-value pairs to apply to this resource.
data_filterstringThe data filter for the integration.
source_arnstringThe Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
target_arnstringThe ARN of the Redshift data warehouse to use as the target for replication.
integration_arnstringThe ARN of the integration.
kms_key_idstringAn optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
additional_encryption_contextobject
create_timestring
regionstringAWS region.
stringThe name of the integration.
stringThe description of the integration.
arrayAn array of key-value pairs to apply to this resource.
stringThe data filter for the integration.
stringThe Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
stringThe ARN of the Redshift data warehouse to use as the target for replication.
stringThe ARN of the integration.
stringAn optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
object
string
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual integration resource, use i Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/integrations/index.md b/docs/aws-docs/providers/aws/rds/integrations/index.md index 0d8bf3e6ac..331a022774 100644 --- a/docs/aws-docs/providers/aws/rds/integrations/index.md +++ b/docs/aws-docs/providers/aws/rds/integrations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of integrations in a region or create a integrations resource, use integration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of integrations in a region or create a Nameintegrations TypeResource DescriptionCreates a zero-ETL integration with Amazon Redshift. -Idaws.rds.integrations +Id ## Fields - - + +
NameDatatypeDescription
integration_arnstringThe ARN of the integration.
regionstringAWS region.
stringThe ARN of the integration.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of integrations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rds/option_group/index.md b/docs/aws-docs/providers/aws/rds/option_group/index.md index 5208323fc4..1ff7d9d6dc 100644 --- a/docs/aws-docs/providers/aws/rds/option_group/index.md +++ b/docs/aws-docs/providers/aws/rds/option_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual option_group resource, use option_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual option_group resource, use Nameoption_group TypeResource DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine. -Idaws.rds.option_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
option_group_namestringSpecifies the name of the option group.
option_group_descriptionstringProvides a description of the option group.
engine_namestringIndicates the name of the engine that this option group can be applied to.
major_engine_versionstringIndicates the major engine version associated with this option group.
option_configurationsarrayIndicates what options are available in the option group.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringSpecifies the name of the option group.
stringProvides a description of the option group.
stringIndicates the name of the engine that this option group can be applied to.
stringIndicates the major engine version associated with this option group.
arrayIndicates what options are available in the option group.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual option_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rds/option_groups/index.md b/docs/aws-docs/providers/aws/rds/option_groups/index.md index a6a98eb38a..519bd5d425 100644 --- a/docs/aws-docs/providers/aws/rds/option_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/option_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of option_groups in a region or create a option_groups resource, use option_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of option_groups in a region or create a Nameoption_groups TypeResource DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine. -Idaws.rds.option_groups +Id ## Fields - - + +
NameDatatypeDescription
option_group_namestringSpecifies the name of the option group.
regionstringAWS region.
stringSpecifies the name of the option group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of option_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/cluster/index.md b/docs/aws-docs/providers/aws/redshift/cluster/index.md index 963dd1f051..b3e8b62a2b 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,68 +24,68 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.redshift.cluster +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_identifierstringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
cluster_namespace_arnstringThe Amazon Resource Name (ARN) of the cluster namespace.
master_usernamestringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
master_user_passwordstringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
node_typestringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
allow_version_upgradebooleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
automated_snapshot_retention_periodintegerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
availability_zonestringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
cluster_parameter_group_namestringThe name of the parameter group to be associated with this cluster.
cluster_typestringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
cluster_versionstringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
cluster_subnet_group_namestringThe name of a cluster subnet group to be associated with this cluster.
db_namestringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
elastic_ipstringThe Elastic IP (EIP) address for the cluster.
encryptedbooleanIf true, the data in the cluster is encrypted at rest.
hsm_client_certificate_identifierstringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
hsm_configuration_identifierstringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
kms_key_idstringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
number_of_nodesintegerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
portintegerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
preferred_maintenance_windowstringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
publicly_accessiblebooleanIf true, the cluster can be accessed from a public network.
cluster_security_groupsarrayA list of security groups to be associated with this cluster.
iam_rolesarrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
tagsarrayThe list of tags for the cluster parameter group.
vpc_security_group_idsarrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
snapshot_cluster_identifierstringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
snapshot_identifierstringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
owner_accountstring
logging_propertiesobject
endpointobject
destination_regionstringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
snapshot_copy_retention_periodintegerThe number of days to retain automated snapshots in the destination region after they are copied from the source region. <br/><br/> Default is 7. <br/><br/> Constraints: Must be at least 1 and no more than 35.
snapshot_copy_grant_namestringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
manual_snapshot_retention_periodintegerThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.<br/><br/>The value must be either -1 or an integer between 1 and 3,653.
snapshot_copy_manualbooleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
availability_zone_relocationbooleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
availability_zone_relocation_statusstringThe availability zone relocation status of the cluster
aqua_configuration_statusstringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.<br/><br/>enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.<br/>disabled - Don't use AQUA.<br/>auto - Amazon Redshift determines whether to use AQUA.<br/>
classicbooleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
enhanced_vpc_routingbooleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.<br/><br/>If this option is true , enhanced VPC routing is enabled.<br/><br/>Default: false
maintenance_track_namestringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
defer_maintenancebooleanA boolean indicating whether to enable the deferred maintenance window.
defer_maintenance_identifierstringA unique identifier for the deferred maintenance window.
defer_maintenance_start_timestringA timestamp indicating the start time for the deferred maintenance window.
defer_maintenance_end_timestringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
defer_maintenance_durationintegerAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
revision_targetstringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
resource_actionstringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
rotate_encryption_keybooleanA boolean indicating if we want to rotate Encryption Keys.
multi_azbooleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
namespace_resource_policyobjectThe namespace resource policy document that will be attached to a Redshift cluster.
manage_master_passwordbooleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
master_password_secret_kms_key_idstringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
master_password_secret_arnstringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
regionstringAWS region.
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 Amazon Resource Name (ARN) of the cluster namespace.
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.
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 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
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
integerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
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
stringThe name of the parameter group to be associated with this cluster.
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
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.
stringThe name of a cluster subnet group to be associated with this cluster.
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.
stringThe Elastic IP (EIP) address for the cluster.
booleanIf true, the data in the cluster is encrypted at rest.
stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
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 AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
integerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
integerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
booleanIf true, the cluster can be accessed from a public network.
arrayA list of security groups to be associated with this cluster.
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
arrayThe list of tags for the cluster parameter group.
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
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.
stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
string
object
object
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
integerThe number of days to retain automated snapshots in the destination region after they are copied from the source region. <br/><br/> Default is 7. <br/><br/> Constraints: Must be at least 1 and no more than 35.
stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
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.<br/><br/>The value must be either -1 or an integer between 1 and 3,653.
booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
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.<br/><br/>enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.<br/>disabled - Don't use AQUA.<br/>auto - Amazon Redshift determines whether to use AQUA.<br/>
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.
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.<br/><br/>If this option is true , enhanced VPC routing is enabled.<br/><br/>Default: false
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.
booleanA boolean indicating whether to enable the deferred maintenance window.
stringA unique identifier for the deferred maintenance window.
stringA timestamp indicating the start time for the deferred maintenance window.
stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
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 identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
booleanA boolean indicating if we want to rotate Encryption Keys.
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.
objectThe namespace resource policy document that will be attached to a Redshift cluster.
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 ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
stringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
stringAWS region.
@@ -95,19 +98,19 @@ Gets or operates on an individual cluster resource, use clust Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md index 66fbe6a186..4b03c7fab2 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster_parameter_group resource, use cluster_parameter_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual cluster_parameter_group resource, Namecluster_parameter_group TypeResource DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup -Idaws.redshift.cluster_parameter_group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the cluster parameter group.
descriptionstringA description of the parameter group.
parameter_group_familystringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
parametersarrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual cluster_parameter_group resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md index 5da62077b1..e2241ed6a1 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cluster_parameter_groups in a region or create a cluster_parameter_groups resource, use cluster_parameter_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cluster_parameter_groups in a region or Namecluster_parameter_groups TypeResource DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup -Idaws.redshift.cluster_parameter_groups +Id ## Fields - - + +
NameDatatypeDescription
parameter_group_namestringThe name of the cluster parameter group.
regionstringAWS region.
stringThe name of the cluster parameter group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cluster_parameter_groups in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md index e791bc03a0..8113b2d1ff 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster_subnet_group resource, use cluster_subnet_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual cluster_subnet_group resource, us Namecluster_subnet_group TypeResource DescriptionSpecifies an Amazon Redshift subnet group. -Idaws.redshift.cluster_subnet_group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstringThe description of the parameter group.
subnet_idsarrayThe list of VPC subnet IDs
tagsarrayThe list of tags for the cluster parameter group.
cluster_subnet_group_namestringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual cluster_subnet_group resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md index b21d6e85b5..ae59908db9 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cluster_subnet_groups in a region or create a cluster_subnet_groups resource, use cluster_subnet_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cluster_subnet_groups in a region or cre Namecluster_subnet_groups TypeResource DescriptionSpecifies an Amazon Redshift subnet group. -Idaws.redshift.cluster_subnet_groups +Id ## Fields - - + +
NameDatatypeDescription
cluster_subnet_group_namestringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of cluster_subnet_groups in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/clusters/index.md b/docs/aws-docs/providers/aws/redshift/clusters/index.md index 3ee742e71e..d91c7fc2e4 100644 --- a/docs/aws-docs/providers/aws/redshift/clusters/index.md +++ b/docs/aws-docs/providers/aws/redshift/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.redshift.clusters +Id ## Fields - - + +
NameDatatypeDescription
cluster_identifierstringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md index 6959635aaf..6f2f733bfe 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual endpoint_access resource, use endpoint_accesses to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual endpoint_access resource, use Nameendpoint_access TypeResource DescriptionResource schema for a Redshift-managed VPC endpoint. -Idaws.redshift.endpoint_access +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
addressstringThe DNS address of the endpoint.
cluster_identifierstringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
vpc_security_groupsarrayA list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.
resource_ownerstringThe AWS account ID of the owner of the cluster.
endpoint_statusstringThe status of the endpoint.
endpoint_namestringThe name of the endpoint.
endpoint_create_timestringThe time (UTC) that the endpoint was created.
subnet_group_namestringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
portintegerThe port number on which the cluster accepts incoming connections.
vpc_security_group_idsarrayA list of vpc security group ids to apply to the created endpoint access.
vpc_endpointobjectThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
regionstringAWS region.
stringThe DNS address of the endpoint.
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.
stringThe AWS account ID of the owner of the cluster.
stringThe status of the endpoint.
stringThe name of the endpoint.
stringThe time (UTC) that the endpoint was created.
stringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
integerThe port number on which the cluster accepts incoming connections.
arrayA list of vpc security group ids to apply to the created endpoint access.
objectThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual endpoint_access resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md index 9085c77f8e..a38874640e 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of endpoint_accesses in a region or create a endpoint_accesses resource, use endpoint_access to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of endpoint_accesses in a region or create Nameendpoint_accesses TypeResource DescriptionResource schema for a Redshift-managed VPC endpoint. -Idaws.redshift.endpoint_accesses +Id ## Fields - - + +
NameDatatypeDescription
endpoint_namestringThe name of the endpoint.
regionstringAWS region.
stringThe name of the endpoint.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of endpoint_accesses in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md index 719d5a8581..f2b9efab4b 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual endpoint_authorization resource, use endpoint_authorizations to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual endpoint_authorization resource, Nameendpoint_authorization TypeResource DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts. -Idaws.redshift.endpoint_authorization +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
grantorstringThe AWS account ID of the cluster owner.
granteestringThe AWS account ID of the grantee of the cluster.
cluster_identifierstringThe cluster identifier.
authorize_timestringThe time (UTC) when the authorization was created.
cluster_statusstringThe status of the cluster.
statusstringThe status of the authorization action.
allowed_all_vpcsbooleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
allowed_vpcsarrayThe VPCs allowed access to the cluster.
endpoint_countintegerThe number of Redshift-managed VPC endpoints created for the authorization.
accountstringThe target AWS account ID to grant or revoke access for.
vpc_idsarrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
forceboolean Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
regionstringAWS region.
stringThe AWS account ID of the cluster owner.
stringThe AWS account ID of the grantee of the cluster.
stringThe cluster identifier.
stringThe time (UTC) when the authorization was created.
stringThe status of the cluster.
stringThe status of the authorization action.
booleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
arrayThe VPCs allowed access to the cluster.
integerThe number of Redshift-managed VPC endpoints created for the authorization.
stringThe target AWS account ID to grant or revoke access for.
arrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
boolean Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual endpoint_authorization resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md index a464caa2f5..8ad1e8a562 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of endpoint_authorizations in a region or create a endpoint_authorizations resource, use endpoint_authorization to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of endpoint_authorizations in a region or c Nameendpoint_authorizations TypeResource DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts. -Idaws.redshift.endpoint_authorizations +Id ## Fields - - - + + +
NameDatatypeDescription
cluster_identifierstringThe cluster identifier.
accountundefinedThe target AWS account ID to grant or revoke access for.
regionstringAWS region.
stringThe cluster identifier.
undefinedThe target AWS account ID to grant or revoke access for.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of endpoint_authorizations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscription/index.md b/docs/aws-docs/providers/aws/redshift/event_subscription/index.md index 398b9297c7..254a02de8a 100644 --- a/docs/aws-docs/providers/aws/redshift/event_subscription/index.md +++ b/docs/aws-docs/providers/aws/redshift/event_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual event_subscription resource, use event_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual event_subscription resource, use Nameevent_subscription TypeResource DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription. -Idaws.redshift.event_subscription +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the Amazon Redshift event notification subscription
sns_topic_arnstringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
source_typestringThe type of source that will be generating the events.
source_idsarrayA list of one or more identifiers of Amazon Redshift source objects.
event_categoriesarraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
severitystringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
enabledbooleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
tagsarrayAn array of key-value pairs to apply to this resource.
customer_aws_idstringThe AWS account associated with the Amazon Redshift event notification subscription.
cust_subscription_idstringThe name of the Amazon Redshift event notification subscription.
statusstringThe status of the Amazon Redshift event notification subscription.
subscription_creation_timestringThe date and time the Amazon Redshift event notification subscription was created.
source_ids_listarrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
event_categories_listarrayThe list of Amazon Redshift event categories specified in the event notification subscription.
regionstringAWS region.
stringThe name of the Amazon Redshift event notification subscription
stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
stringThe type of source that will be generating the events.
arrayA list of one or more identifiers of Amazon Redshift source objects.
arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
stringSpecifies the Amazon Redshift event severity 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.
arrayAn array of key-value pairs to apply to this resource.
stringThe AWS account associated with the Amazon Redshift event notification subscription.
stringThe name of the Amazon Redshift event notification subscription.
stringThe status of the Amazon Redshift event notification subscription.
stringThe date and time the Amazon Redshift event notification subscription was created.
arrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
arrayThe list of Amazon Redshift event categories specified in the event notification subscription.
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual event_subscription resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md index 87356080fb..2ae56374c6 100644 --- a/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of event_subscriptions in a region or create a event_subscriptions resource, use event_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of event_subscriptions in a region or creat Nameevent_subscriptions TypeResource DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription. -Idaws.redshift.event_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
subscription_namestringThe name of the Amazon Redshift event notification subscription
regionstringAWS region.
stringThe name of the Amazon Redshift event notification subscription
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of event_subscriptions in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md index 5fc92ca055..a40ddf07e8 100644 --- a/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md +++ b/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scheduled_action resource, use scheduled_actions to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual scheduled_action resource, use Namescheduled_action TypeResource DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action. -Idaws.redshift.scheduled_action +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
scheduled_action_namestringThe name of the scheduled action. The name must be unique within an account.
target_actionobjectA JSON format string of the Amazon Redshift API operation with input parameters.
schedulestringThe schedule in `at( )` or `cron( )` format.
iam_rolestringThe IAM role to assume to run the target action.
scheduled_action_descriptionstringThe description of the scheduled action.
start_timestringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
end_timestringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
enablebooleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
statestringThe state of the scheduled action.
next_invocationsarrayList of times when the scheduled action will run.
regionstringAWS region.
stringThe name of the scheduled action. The name must be unique within an account.
objectA JSON format string of the Amazon Redshift API operation with input parameters.
stringThe schedule in `at( )` or `cron( )` format.
stringThe IAM role to assume to run the target action.
stringThe description of the scheduled action.
stringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
stringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
booleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
stringThe state of the scheduled action.
arrayList of times when the scheduled action will run.
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual scheduled_action resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md index 4e8e3949da..876f5b7d48 100644 --- a/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md +++ b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scheduled_actions in a region or create a scheduled_actions resource, use scheduled_action to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scheduled_actions in a region or create Namescheduled_actions TypeResource DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action. -Idaws.redshift.scheduled_actions +Id ## Fields - - + +
NameDatatypeDescription
scheduled_action_namestringThe name of the scheduled action. The name must be unique within an account.
regionstringAWS region.
stringThe name of the scheduled action. The name must be unique within an account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scheduled_actions in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md index 891de7f63f..d345f99ac1 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual namespace resource, use namespaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual namespace resource, use nam Namenamespace TypeResource DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type -Idaws.redshiftserverless.namespace +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
admin_password_secret_kms_key_idstringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
admin_user_passwordstringThe password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.
admin_usernamestringThe user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
db_namestringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
default_iam_role_arnstringThe default IAM role ARN for the namespace that is being created.
iam_rolesarrayA list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.
kms_key_idstringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
log_exportsarrayThe collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog
manage_admin_passwordbooleanIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
namespaceobjectDefinition of Namespace resource.
namespace_namestringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
tagsarrayThe list of tags for the namespace.
final_snapshot_namestringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
final_snapshot_retention_periodintegerThe number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
namespace_resource_policyobjectThe resource policy document that will be attached to the namespace.
redshift_idc_application_arnstringThe ARN for the Redshift application that integrates with IAM Identity Center.
snapshot_copy_configurationsarrayThe snapshot copy configurations for the namespace.
regionstringAWS region.
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.
@@ -57,19 +60,19 @@ Gets or operates on an individual namespace resource, use nam Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md index a893919543..e35db39a0f 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of namespaces in a region or create a namespaces resource, use namespace to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of namespaces in a region or create a Namenamespaces TypeResource DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type -Idaws.redshiftserverless.namespaces +Id ## Fields - - + +
NameDatatypeDescription
namespace_namestringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of namespaces in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md index 0c06e29b69..7260de9ab4 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workgroup resource, use workgroups to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual workgroup resource, use wor Nameworkgroup TypeResource DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type -Idaws.redshiftserverless.workgroup +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
workgroup_namestringThe name of the workgroup.
namespace_namestringThe namespace the workgroup is associated with.
base_capacityintegerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
max_capacityintegerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
enhanced_vpc_routingbooleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
config_parametersarrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
security_group_idsarrayA list of security group IDs to associate with the workgroup.
subnet_idsarrayA list of subnet IDs the workgroup is associated with.
publicly_accessiblebooleanA value that specifies whether the workgroup can be accessible from a public network.
portintegerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
tagsarrayThe map of the key-value pairs used to tag the workgroup.
workgroupobjectDefinition for workgroup resource
regionstringAWS region.
stringThe name of the workgroup.
stringThe namespace the workgroup is associated with.
integerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
integerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
booleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
arrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
arrayA list of security group IDs to associate with the workgroup.
arrayA list of subnet IDs the workgroup is associated with.
booleanA value that specifies whether the workgroup can be accessible from a public network.
integerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
arrayThe map of the key-value pairs used to tag the workgroup.
objectDefinition for workgroup resource
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual workgroup resource, use wor Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md index 94da3a9619..30981aa0c6 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workgroups in a region or create a workgroups resource, use workgroup to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workgroups in a region or create a Nameworkgroups TypeResource DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type -Idaws.redshiftserverless.workgroups +Id ## Fields - - + +
NameDatatypeDescription
workgroup_namestringThe name of the workgroup.
regionstringAWS region.
stringThe name of the workgroup.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workgroups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/application/index.md b/docs/aws-docs/providers/aws/refactorspaces/application/index.md index eb428be084..70fdde7930 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/application/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type -Idaws.refactorspaces.application +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
api_gateway_proxyobject
arnstring
api_gateway_idstring
vpc_link_idstring
nlb_arnstring
nlb_namestring
application_identifierstring
environment_identifierstring
namestring
proxy_typestring
vpc_idstring
stage_namestring
proxy_urlstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
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.
@@ -54,14 +57,14 @@ Gets or operates on an individual application resource, use a Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/applications/index.md b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md index 0ff695b23e..e5eca97694 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/applications/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type -Idaws.refactorspaces.applications +Id ## Fields - - - + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environment/index.md b/docs/aws-docs/providers/aws/refactorspaces/environment/index.md index e28fd47d86..7cf9cd017a 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/environment/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type -Idaws.refactorspaces.environment +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
descriptionstring
environment_identifierstring
namestring
network_fabric_typestring
arnstring
transit_gateway_idstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual environment resource, use e Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environments/index.md b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md index e8d9af0191..e295a3c255 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/environments/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type -Idaws.refactorspaces.environments +Id ## Fields - - + +
NameDatatypeDescription
environment_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/route/index.md b/docs/aws-docs/providers/aws/refactorspaces/route/index.md index 56d112e981..75ca0d1add 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/route/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/route/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual route resource, use routes to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual route resource, use routes< Nameroute TypeResource DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type -Idaws.refactorspaces.route +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
path_resource_to_idstring
arnstring
application_identifierstring
environment_identifierstring
route_identifierstring
route_typestring
service_identifierstring
default_routeobject
uri_path_routeobject
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual route resource, use routes< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/routes/index.md b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md index a7057e6a86..7916d6afe9 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/routes/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of routes in a region or create a routes resource, use route to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of routes in a region or create a rou Nameroutes TypeResource DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type -Idaws.refactorspaces.routes +Id ## Fields - - - - + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
route_identifierstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of routes in a region or create a rou Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/service/index.md b/docs/aws-docs/providers/aws/refactorspaces/service/index.md index 8d55da0517..e16107af84 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/service/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/service/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service resource, use services to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual service resource, use servi Nameservice TypeResource DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type -Idaws.refactorspaces.service +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstring
application_identifierstring
descriptionstring
endpoint_typestring
environment_identifierstring
lambda_endpointobject
namestring
service_identifierstring
url_endpointobject
vpc_idstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
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.
@@ -51,14 +54,14 @@ Gets or operates on an individual service resource, use servi Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/refactorspaces/services/index.md b/docs/aws-docs/providers/aws/refactorspaces/services/index.md index 91a6e0f666..c6f3add258 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/services/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/services/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of services in a region or create a services resource, use service to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of services in a region or create a s Nameservices TypeResource DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type -Idaws.refactorspaces.services +Id ## Fields - - - - + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
service_identifierstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of services in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rekognition/collection/index.md b/docs/aws-docs/providers/aws/rekognition/collection/index.md index 5befe430e4..c54286ae76 100644 --- a/docs/aws-docs/providers/aws/rekognition/collection/index.md +++ b/docs/aws-docs/providers/aws/rekognition/collection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual collection resource, use collections to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual collection resource, use co Namecollection TypeResource DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group -Idaws.rekognition.collection +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstring
collection_idstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual collection resource, use co Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rekognition/collections/index.md b/docs/aws-docs/providers/aws/rekognition/collections/index.md index 87b08ac7d0..0dbcc09be1 100644 --- a/docs/aws-docs/providers/aws/rekognition/collections/index.md +++ b/docs/aws-docs/providers/aws/rekognition/collections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of collections in a region or create a collections resource, use collection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of collections in a region or create a Namecollections TypeResource DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group -Idaws.rekognition.collections +Id ## Fields - - + +
NameDatatypeDescription
collection_idundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of collections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rekognition/project/index.md b/docs/aws-docs/providers/aws/rekognition/project/index.md index 22470b85d2..3c061e0d5d 100644 --- a/docs/aws-docs/providers/aws/rekognition/project/index.md +++ b/docs/aws-docs/providers/aws/rekognition/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions. -Idaws.rekognition.project +Id ## Fields - - - + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rekognition/projects/index.md b/docs/aws-docs/providers/aws/rekognition/projects/index.md index 62e047525b..0b3b505dc0 100644 --- a/docs/aws-docs/providers/aws/rekognition/projects/index.md +++ b/docs/aws-docs/providers/aws/rekognition/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions. -Idaws.rekognition.projects +Id ## Fields - - + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md index bd94c97312..06d93266d3 100644 --- a/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md +++ b/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual stream_processor resource, use stream_processors to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual stream_processor resource, use Namestream_processor TypeResource DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.<br/><br/> -Idaws.rekognition.stream_processor +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
kms_key_idstringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
role_arnstringARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
kinesis_video_streamobject
face_search_settingsobject
connected_home_settingsobject
kinesis_data_streamobject
s3_destinationobject
notification_channelobject
data_sharing_preferenceobject
polygon_regions_of_interestarrayThe PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
bounding_box_regions_of_interestarrayThe BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
statusstringCurrent status of the stream processor.
status_messagestringDetailed status message about the stream processor.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
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.
object
object
object
object
object
object
object
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.
@@ -56,19 +59,19 @@ Gets or operates on an individual stream_processor resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md index 9ea98cabcb..a7ddf694c8 100644 --- a/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md +++ b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of stream_processors in a region or create a stream_processors resource, use stream_processor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of stream_processors in a region or create Namestream_processors TypeResource DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.<br/><br/> -Idaws.rekognition.stream_processors +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of stream_processors in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resiliencehub/app/index.md b/docs/aws-docs/providers/aws/resiliencehub/app/index.md index 1da71232d6..e68f75479d 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/app/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/app/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app resource, use apps to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual app resource, use appsNameapp TypeResource DescriptionResource Type Definition for AWS::ResilienceHub::App. -Idaws.resiliencehub.app +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the app.
descriptionstringApp description.
app_arnstringAmazon Resource Name (ARN) of the App.
resiliency_policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
tagsobject
app_template_bodystringA string containing full ResilienceHub app template body.
resource_mappingsarrayAn array of ResourceMapping objects.
app_assessment_schedulestringAssessment execution schedule.
permission_modelobject
event_subscriptionsarrayThe list of events you would like to subscribe and get notification for.
drift_statusstringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
regionstringAWS region.
stringName of the app.
stringApp description.
stringAmazon Resource Name (ARN) of the App.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
object
stringA string containing full ResilienceHub app template body.
arrayAn array of ResourceMapping objects.
stringAssessment execution schedule.
object
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual app resource, use appsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resiliencehub/apps/index.md b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md index 926a6fee09..9209046b7c 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/apps/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of apps in a region or create a apps resource, use app to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of apps in a region or create a apps< Nameapps TypeResource DescriptionResource Type Definition for AWS::ResilienceHub::App. -Idaws.resiliencehub.apps +Id ## Fields - - + +
NameDatatypeDescription
app_arnstringAmazon Resource Name (ARN) of the App.
regionstringAWS region.
stringAmazon Resource Name (ARN) of the App.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of apps in a region or create a apps< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md index 2d0073e814..c810bf29b8 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resiliency_policies in a region or create a resiliency_policies resource, use resiliency_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resiliency_policies in a region or creat Nameresiliency_policies TypeResource DescriptionResource Type Definition for Resiliency Policy. -Idaws.resiliencehub.resiliency_policies +Id ## Fields - - + +
NameDatatypeDescription
policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
regionstringAWS region.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resiliency_policies in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md index 231f1f32ca..e6274174d3 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resiliency_policy resource, use resiliency_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual resiliency_policy resource, use < Nameresiliency_policy TypeResource DescriptionResource Type Definition for Resiliency Policy. -Idaws.resiliencehub.resiliency_policy +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
policy_namestringName of Resiliency Policy.
policy_descriptionstringDescription of Resiliency Policy.
data_location_constraintstringData Location Constraint of the Policy.
tierstringResiliency Policy Tier.
policyobject
policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
tagsobject
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual resiliency_policy resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md index 8e5dbf0e23..22d1bb08e3 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual default_view_association resource, use default_view_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual default_view_association resource Namedefault_view_association TypeResource DescriptionDefinition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type -Idaws.resourceexplorer2.default_view_association +Id ## Fields - - - + + +
NameDatatypeDescription
view_arnstring
associated_aws_principalstringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
regionstringAWS region.
string
stringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual default_view_association resource Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md index 30f748114b..bb2d4891fa 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of default_view_associations in a region or create a default_view_associations resource, use default_view_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of default_view_associations in a region or Namedefault_view_associations TypeResource DescriptionDefinition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type -Idaws.resourceexplorer2.default_view_associations +Id ## Fields - - + +
NameDatatypeDescription
associated_aws_principalstringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
regionstringAWS region.
stringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of default_view_associations in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md index 9e113dff3a..89618a643c 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual index resource, use indices to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual index resource, use indices Nameindex TypeResource DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type -Idaws.resourceexplorer2.index +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstring
tagsobject
typestring
index_statestring
regionstringAWS region.
string
object
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual index resource, use indices Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md index 85ae8bbb02..d21bfc7dac 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of indices in a region or create a indices resource, use index to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of indices in a region or create a in Nameindices TypeResource DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type -Idaws.resourceexplorer2.indices +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of indices in a region or create a in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md index 53c791e464..bf05a38426 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual view resource, use views to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual view resource, use viewsNameview TypeResource DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type -Idaws.resourceexplorer2.view +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
filtersobject
included_propertiesarray
scopestring
tagsobject
view_arnstring
view_namestring
regionstringAWS region.
object
array
string
object
string
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual view resource, use viewsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md index bb069ea988..ff82131703 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of views in a region or create a views resource, use view to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of views in a region or create a view Nameviews TypeResource DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type -Idaws.resourceexplorer2.views +Id ## Fields - - + +
NameDatatypeDescription
view_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of views in a region or create a view Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/resourcegroups/group/index.md b/docs/aws-docs/providers/aws/resourcegroups/group/index.md index 98dcf33394..35069faffc 100644 --- a/docs/aws-docs/providers/aws/resourcegroups/group/index.md +++ b/docs/aws-docs/providers/aws/resourcegroups/group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group resource, use groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual group resource, use groups< Namegroup TypeResource DescriptionSchema for ResourceGroups::Group -Idaws.resourcegroups.group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringThe name of the resource group
descriptionstringThe description of the resource group
resource_queryobject
tagsarray
arnstringThe Resource Group ARN.
configurationarray
resourcesarray
regionstringAWS region.
stringThe name of the resource group
stringThe description of the resource group
object
array
stringThe Resource Group ARN.
array
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual group resource, use groups< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/resourcegroups/groups/index.md b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md index 96b8b4d0b2..cd26a45a78 100644 --- a/docs/aws-docs/providers/aws/resourcegroups/groups/index.md +++ b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of groups in a region or create a gro Namegroups TypeResource DescriptionSchema for ResourceGroups::Group -Idaws.resourcegroups.groups +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the resource group
regionstringAWS region.
stringThe name of the resource group
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of groups in a region or create a gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/fleet/index.md b/docs/aws-docs/providers/aws/robomaker/fleet/index.md index 0748911017..e094ec0080 100644 --- a/docs/aws-docs/providers/aws/robomaker/fleet/index.md +++ b/docs/aws-docs/providers/aws/robomaker/fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual fleet resource, use fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual fleet resource, use fleets< Namefleet TypeResource DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. -Idaws.robomaker.fleet +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstring
tagsobject
namestringThe name of the fleet.
regionstringAWS region.
string
object
stringThe name of the fleet.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual fleet resource, use fleets< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/fleets/index.md b/docs/aws-docs/providers/aws/robomaker/fleets/index.md index 4f7ca9887b..4cd6a9262e 100644 --- a/docs/aws-docs/providers/aws/robomaker/fleets/index.md +++ b/docs/aws-docs/providers/aws/robomaker/fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of fleets in a region or create a fleets resource, use fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of fleets in a region or create a fle Namefleets TypeResource DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. -Idaws.robomaker.fleets +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of fleets in a region or create a fle Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/robot/index.md b/docs/aws-docs/providers/aws/robomaker/robot/index.md index 0f6c72328d..9b7c0f2b0b 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual robot resource, use robots to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual robot resource, use robots< Namerobot TypeResource DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot. -Idaws.robomaker.robot +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstring
fleetstringThe Amazon Resource Name (ARN) of the fleet.
architecturestringThe target architecture of the robot.
greengrass_group_idstringThe Greengrass group id.
tagsobject
namestringThe name for the robot.
regionstringAWS region.
string
stringThe Amazon Resource Name (ARN) of the fleet.
stringThe target architecture of the robot.
stringThe Greengrass group id.
object
stringThe name for the robot.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual robot resource, use robots< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application/index.md index 0d4d3f52ed..9e86a19271 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_application/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual robot_application resource, use robot_applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual robot_application resource, use < Namerobot_application TypeResource DescriptionThis schema is for testing purpose only. -Idaws.robomaker.robot_application +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringThe name of the robot application.
sourcesarrayThe sources of the robot application.
environmentstringThe URI of the Docker image for the robot application.
robot_software_suiteobject
current_revision_idstringThe revision ID of robot application.
arnstring
tagsobject
regionstringAWS region.
stringThe name of the robot application.
arrayThe sources of the robot application.
stringThe URI of the Docker image for the robot application.
object
stringThe revision ID of robot application.
string
object
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual robot_application resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md index 5963ca3a64..4a0d2c4499 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual robot_application_version resource, use robot_application_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual robot_application_version resourc Namerobot_application_version TypeResource DescriptionAWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses. -Idaws.robomaker.robot_application_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
string
stringThe revision ID of robot application.
string
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual robot_application_version resourc Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md index a450c8664a..87adcb2636 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of robot_application_versions in a region or create a robot_application_versions resource, use robot_application_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of robot_application_versions in a region o Namerobot_application_versions TypeResource DescriptionAWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses. -Idaws.robomaker.robot_application_versions +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of robot_application_versions in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md index 4b66afaf3d..4f2505a402 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of robot_applications in a region or create a robot_applications resource, use robot_application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of robot_applications in a region or create Namerobot_applications TypeResource DescriptionThis schema is for testing purpose only. -Idaws.robomaker.robot_applications +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of robot_applications in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/robots/index.md b/docs/aws-docs/providers/aws/robomaker/robots/index.md index cd99477615..1a14434388 100644 --- a/docs/aws-docs/providers/aws/robomaker/robots/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robots/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of robots in a region or create a robots resource, use robot to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of robots in a region or create a rob Namerobots TypeResource DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot. -Idaws.robomaker.robots +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of robots in a region or create a rob Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md index 87cb2cca68..0325466bb9 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual simulation_application resource, use simulation_applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual simulation_application resource, Namesimulation_application TypeResource DescriptionThis schema is for testing purpose only. -Idaws.robomaker.simulation_application +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe name of the simulation application.
current_revision_idstringThe current revision id.
rendering_engineobjectThe rendering engine for the simulation application.
robot_software_suiteobjectThe robot software suite used by the simulation application.
simulation_software_suiteobjectThe simulation software suite used by the simulation application.
sourcesarrayThe sources of the simulation application.
environmentstringThe URI of the Docker image for the robot application.
tagsobject
regionstringAWS region.
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.
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual simulation_application resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md index 5f002f9af8..67f20a22d0 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual simulation_application_version resource, use simulation_application_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual simulation_application_version re Namesimulation_application_version TypeResource DescriptionAWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses. -Idaws.robomaker.simulation_application_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
string
stringThe revision ID of robot application.
string
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual simulation_application_version re Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md index cbd408c7ac..992ba4f8e0 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of simulation_application_versions in a region or create a simulation_application_versions resource, use simulation_application_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of simulation_application_versions in a reg Namesimulation_application_versions TypeResource DescriptionAWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses. -Idaws.robomaker.simulation_application_versions +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of simulation_application_versions in a reg Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md index b10aec5b55..02d3bca123 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of simulation_applications in a region or create a simulation_applications resource, use simulation_application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of simulation_applications in a region or c Namesimulation_applications TypeResource DescriptionThis schema is for testing purpose only. -Idaws.robomaker.simulation_applications +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of simulation_applications in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md index c17c33e05a..a7cb4c7df7 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual crl resource, use crls to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual crl resource, use crlsNamecrl TypeResource DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type -Idaws.rolesanywhere.crl +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
crl_datastring
crl_idstring
enabledboolean
namestring
trust_anchor_arnstring
tagsarray
regionstringAWS region.
string
string
boolean
string
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual crl resource, use crlsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md index 7b32622031..cc1def287e 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of crls in a region or create a crls resource, use crl to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of crls in a region or create a crls< Namecrls TypeResource DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type -Idaws.rolesanywhere.crls +Id ## Fields - - + +
NameDatatypeDescription
crl_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of crls in a region or create a crls< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md index 946e88aebd..62fda66d97 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual profile resource, use profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual profile resource, use profi Nameprofile TypeResource DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type -Idaws.rolesanywhere.profile +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
duration_secondsnumber
enabledboolean
managed_policy_arnsarray
namestring
profile_arnstring
profile_idstring
require_instance_propertiesboolean
role_arnsarray
session_policystring
tagsarray
regionstringAWS region.
number
boolean
array
string
string
string
boolean
array
string
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual profile resource, use profi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md index 25b567c194..713c8e0427 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of profiles in a region or create a profiles resource, use profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of profiles in a region or create a p Nameprofiles TypeResource DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type -Idaws.rolesanywhere.profiles +Id ## Fields - - + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of profiles in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md index 9124230853..3f7fdb9052 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual trust_anchor resource, use trust_anchors to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual trust_anchor resource, use Nametrust_anchor TypeResource DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type. -Idaws.rolesanywhere.trust_anchor +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
enabledboolean
namestring
notification_settingsarray
sourceobject
tagsarray
trust_anchor_idstring
trust_anchor_arnstring
regionstringAWS region.
boolean
string
array
object
array
string
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual trust_anchor resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md index 615297331f..cdf9a88080 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trust_anchors in a region or create a trust_anchors resource, use trust_anchor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of trust_anchors in a region or create a Nametrust_anchors TypeResource DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type. -Idaws.rolesanywhere.trust_anchors +Id ## Fields - - + +
NameDatatypeDescription
trust_anchor_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of trust_anchors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53/cidr_collection/index.md b/docs/aws-docs/providers/aws/route53/cidr_collection/index.md index 17403857d1..b1c720c46b 100644 --- a/docs/aws-docs/providers/aws/route53/cidr_collection/index.md +++ b/docs/aws-docs/providers/aws/route53/cidr_collection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cidr_collection resource, use cidr_collections to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual cidr_collection resource, use Namecidr_collection TypeResource DescriptionResource schema for AWS::Route53::CidrCollection. -Idaws.route53.cidr_collection +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstringUUID of the CIDR collection.
namestringA unique name for the CIDR collection.
arnstringThe Amazon resource name (ARN) to uniquely identify the AWS resource.
locationsarrayA complex type that contains information about the list of CIDR locations.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual cidr_collection resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53/cidr_collections/index.md b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md index 6aab647717..ad70140f63 100644 --- a/docs/aws-docs/providers/aws/route53/cidr_collections/index.md +++ b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cidr_collections in a region or create a cidr_collections resource, use cidr_collection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cidr_collections in a region or create a Namecidr_collections TypeResource DescriptionResource schema for AWS::Route53::CidrCollection. -Idaws.route53.cidr_collections +Id ## Fields - - + +
NameDatatypeDescription
idstringUUID of the CIDR collection.
regionstringAWS region.
stringUUID of the CIDR collection.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cidr_collections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53/dnssec/index.md b/docs/aws-docs/providers/aws/route53/dnssec/index.md index 23e6c05da4..d914b0bee0 100644 --- a/docs/aws-docs/providers/aws/route53/dnssec/index.md +++ b/docs/aws-docs/providers/aws/route53/dnssec/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dnssec resource, use dnssecs to retrieve a list of resources or to create a resource. ## Overview @@ -21,14 +24,14 @@ Gets or operates on an individual dnssec resource, use dnssec Namednssec TypeResource DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone. -Idaws.route53.dnssec +Id ## Fields - - + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
stringThe unique string (ID) used to identify a hosted zone.
stringAWS region.
@@ -41,14 +44,14 @@ Gets or operates on an individual dnssec resource, use dnssec Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53/dnssecs/index.md b/docs/aws-docs/providers/aws/route53/dnssecs/index.md index 4f1a16ab7c..7e9f61d527 100644 --- a/docs/aws-docs/providers/aws/route53/dnssecs/index.md +++ b/docs/aws-docs/providers/aws/route53/dnssecs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dnssecs in a region or create a dnssecs resource, use dnssec to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dnssecs in a region or create a dn Namednssecs TypeResource DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone. -Idaws.route53.dnssecs +Id ## Fields - - + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
stringThe unique string (ID) used to identify a hosted zone.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dnssecs in a region or create a dn Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53/health_check/index.md b/docs/aws-docs/providers/aws/route53/health_check/index.md index b74f938535..2ba018df46 100644 --- a/docs/aws-docs/providers/aws/route53/health_check/index.md +++ b/docs/aws-docs/providers/aws/route53/health_check/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual health_check resource, use health_checks to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual health_check resource, use Namehealth_check TypeResource DescriptionResource schema for AWS::Route53::HealthCheck. -Idaws.route53.health_check +Id ## Fields - - - - + + + +
NameDatatypeDescription
health_check_idstring
health_check_configobjectA complex type that contains information about the health check.
health_check_tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
objectA complex type that contains information about the health check.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual health_check resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53/health_checks/index.md b/docs/aws-docs/providers/aws/route53/health_checks/index.md index 938a5af658..9532125d97 100644 --- a/docs/aws-docs/providers/aws/route53/health_checks/index.md +++ b/docs/aws-docs/providers/aws/route53/health_checks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of health_checks in a region or create a health_checks resource, use health_check to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of health_checks in a region or create a Namehealth_checks TypeResource DescriptionResource schema for AWS::Route53::HealthCheck. -Idaws.route53.health_checks +Id ## Fields - - + +
NameDatatypeDescription
health_check_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of health_checks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53/hosted_zone/index.md b/docs/aws-docs/providers/aws/route53/hosted_zone/index.md index 09799567a7..730ba1276c 100644 --- a/docs/aws-docs/providers/aws/route53/hosted_zone/index.md +++ b/docs/aws-docs/providers/aws/route53/hosted_zone/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hosted_zone resource, use hosted_zones to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual hosted_zone resource, use h Namehosted_zone TypeResource DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). <br/> You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.<br/> For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).<br/> Note the following:<br/> + You can't create a hosted zone for a top-level domain (TLD) such as .com.<br/> + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. <br/> <br/> When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.<br/> The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.<br/> When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.<br/> The following are the supported partitions:<br/> + ``aws`` - AWS-Regions <br/> + ``aws-cn`` - China Regions<br/> + ``aws-us-gov`` - govcloud-us-region <br/> <br/> For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. -Idaws.route53.hosted_zone +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstring
hosted_zone_configobjectA complex type that contains an optional comment.<br/> If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements.
hosted_zone_tagsarrayAdds, edits, or deletes tags for a health check or a hosted zone.<br/> For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.
namestringThe name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.<br/> If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.
query_logging_configobjectCreates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.<br/> DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:<br/> + Route 53 edge location that responded to the DNS query<br/> + Domain or subdomain that was requested<br/> + DNS record type, such as A or AAAA<br/> + DNS response code, such as ``NoError`` or ``ServFail`` <br/> <br/> + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
vpcsarray*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.<br/> For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
name_serversarray
regionstringAWS region.
string
objectA complex type that contains an optional comment.<br/> 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.<br/> For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.
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.<br/> If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.
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.<br/> DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:<br/> + Route 53 edge location that responded to the DNS query<br/> + Domain or subdomain that was requested<br/> + DNS record type, such as A or AAAA<br/> + DNS response code, such as ``NoError`` or ``ServFail`` <br/> <br/> + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
array*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.<br/> For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual hosted_zone resource, use h Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53/hosted_zones/index.md b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md index a988369a14..4bbbed3799 100644 --- a/docs/aws-docs/providers/aws/route53/hosted_zones/index.md +++ b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hosted_zones in a region or create a hosted_zones resource, use hosted_zone to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hosted_zones in a region or create a Namehosted_zones TypeResource DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). <br/> You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.<br/> For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).<br/> Note the following:<br/> + You can't create a hosted zone for a top-level domain (TLD) such as .com.<br/> + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. <br/> <br/> When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.<br/> The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.<br/> When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.<br/> The following are the supported partitions:<br/> + ``aws`` - AWS-Regions <br/> + ``aws-cn`` - China Regions<br/> + ``aws-us-gov`` - govcloud-us-region <br/> <br/> For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. -Idaws.route53.hosted_zones +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hosted_zones in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53/key_signing_key/index.md b/docs/aws-docs/providers/aws/route53/key_signing_key/index.md index 908302195e..a86cad2851 100644 --- a/docs/aws-docs/providers/aws/route53/key_signing_key/index.md +++ b/docs/aws-docs/providers/aws/route53/key_signing_key/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual key_signing_key resource, use key_signing_keys to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual key_signing_key resource, use Namekey_signing_key TypeResource DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. -Idaws.route53.key_signing_key +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
statusstringA string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.
namestringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
key_management_service_arnstringThe Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual key_signing_key resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md index 945c231325..ebf0f669db 100644 --- a/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md +++ b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of key_signing_keys in a region or create a key_signing_keys resource, use key_signing_key to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of key_signing_keys in a region or create a Namekey_signing_keys TypeResource DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. -Idaws.route53.key_signing_keys +Id ## Fields - - - + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
namestringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of key_signing_keys in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md index a9596842d0..9829ef4c33 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cluster resource, use clusters to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual cluster resource, use clust Namecluster TypeResource DescriptionAWS Route53 Recovery Control Cluster resource schema -Idaws.route53recoverycontrol.cluster +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringName of a Cluster. You can use any non-white space character in the name
cluster_arnstringThe Amazon Resource Name (ARN) of the cluster.
statusstringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_endpointsarrayEndpoints for the cluster.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual cluster resource, use clust Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md index ca50686c94..8f5a4fcb37 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of clusters in a region or create a clusters resource, use cluster to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of clusters in a region or create a c Nameclusters TypeResource DescriptionAWS Route53 Recovery Control Cluster resource schema -Idaws.route53recoverycontrol.clusters +Id ## Fields - - + +
NameDatatypeDescription
cluster_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the cluster.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of clusters in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md index 888c146841..e12218b7e5 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual control_panel resource, use control_panels to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual control_panel resource, use Namecontrol_panel TypeResource DescriptionAWS Route53 Recovery Control Control Panel resource schema . -Idaws.route53recoverycontrol.control_panel +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
cluster_arnstringCluster to associate with the Control Panel
control_panel_arnstringThe Amazon Resource Name (ARN) of the cluster.
namestringThe name of the control panel. You can use any non-white space character in the name.
statusstringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
default_control_panelbooleanA flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
routing_control_countintegerCount of associated routing controls
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual control_panel resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md index 392ac08f36..4bc781ec27 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of control_panels in a region or create a control_panels resource, use control_panel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of control_panels in a region or create a < Namecontrol_panels TypeResource DescriptionAWS Route53 Recovery Control Control Panel resource schema . -Idaws.route53recoverycontrol.control_panels +Id ## Fields - - + +
NameDatatypeDescription
control_panel_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the cluster.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of control_panels in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md index c3383d76e5..290787fa57 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual routing_control resource, use routing_controls to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual routing_control resource, use Namerouting_control TypeResource DescriptionAWS Route53 Recovery Control Routing Control resource schema . -Idaws.route53recoverycontrol.routing_control +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
routing_control_arnstringThe Amazon Resource Name (ARN) of the routing control.
control_panel_arnstringThe Amazon Resource Name (ARN) of the control panel.
namestringThe name of the routing control. You can use any non-white space character in the name.
statusstringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_arnstringArn associated with Control Panel
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual routing_control resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md index 8a10959589..633c90f0f5 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of routing_controls in a region or create a routing_controls resource, use routing_control to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of routing_controls in a region or create a Namerouting_controls TypeResource DescriptionAWS Route53 Recovery Control Routing Control resource schema . -Idaws.route53recoverycontrol.routing_controls +Id ## Fields - - + +
NameDatatypeDescription
routing_control_arnstringThe Amazon Resource Name (ARN) of the routing control.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the routing control.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of routing_controls in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md index 9156a1057e..a84c0940b2 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual safety_rule resource, use safety_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual safety_rule resource, use s Namesafety_rule TypeResource DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules. -Idaws.route53recoverycontrol.safety_rule +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
assertion_ruleobject
gating_ruleobject
namestring
safety_rule_arnstringThe Amazon Resource Name (ARN) of the safety rule.
control_panel_arnstringThe Amazon Resource Name (ARN) of the control panel.
statusstringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
rule_configobject
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
object
object
string
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.
object
arrayA collection of tags associated with a resource
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual safety_rule resource, use s Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md index c7b3e22d0f..3217800a59 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of safety_rules in a region or create a safety_rules resource, use safety_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of safety_rules in a region or create a Namesafety_rules TypeResource DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules. -Idaws.route53recoverycontrol.safety_rules +Id ## Fields - - + +
NameDatatypeDescription
safety_rule_arnstringThe Amazon Resource Name (ARN) of the safety rule.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the safety rule.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of safety_rules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md index b52ed02ff2..4e8969a232 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cell resource, use cells to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual cell resource, use cellsNamecell TypeResource DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells. -Idaws.route53recoveryreadiness.cell +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
cell_namestringThe name of the cell to create.
cell_arnstringThe Amazon Resource Name (ARN) of the cell.
cellsarrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
parent_readiness_scopesarrayThe readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual cell resource, use cellsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md index 67f454f945..f8266a44fc 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cells in a region or create a cells resource, use cell to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cells in a region or create a cell Namecells TypeResource DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells. -Idaws.route53recoveryreadiness.cells +Id ## Fields - - + +
NameDatatypeDescription
cell_namestringThe name of the cell to create.
regionstringAWS region.
stringThe name of the cell to create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cells in a region or create a cell Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md index 13a776b832..ec7cfd368e 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual readiness_check resource, use readiness_checks to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual readiness_check resource, use Namereadiness_check TypeResource DescriptionAws Route53 Recovery Readiness Check Schema and API specification. -Idaws.route53recoveryreadiness.readiness_check +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to check.
readiness_check_namestringName of the ReadinessCheck to create.
readiness_check_arnstringThe Amazon Resource Name (ARN) of the readiness check.
tagsarrayA collection of tags associated with a resource.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual readiness_check resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md index c6e21cf995..31df0e5234 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of readiness_checks in a region or create a readiness_checks resource, use readiness_check to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of readiness_checks in a region or create a Namereadiness_checks TypeResource DescriptionAws Route53 Recovery Readiness Check Schema and API specification. -Idaws.route53recoveryreadiness.readiness_checks +Id ## Fields - - + +
NameDatatypeDescription
readiness_check_namestringName of the ReadinessCheck to create.
regionstringAWS region.
stringName of the ReadinessCheck to create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of readiness_checks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md index d5180d090b..361a9f1e0e 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual recovery_group resource, use recovery_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual recovery_group resource, use Namerecovery_group TypeResource DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications. -Idaws.route53recoveryreadiness.recovery_group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
recovery_group_namestringThe name of the recovery group to create.
cellsarrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
recovery_group_arnstringA collection of tags associated with a resource.
tagsarrayA collection of tags associated with a resource.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual recovery_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md index 5f009fe079..d8146174f5 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of recovery_groups in a region or create a recovery_groups resource, use recovery_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of recovery_groups in a region or create a Namerecovery_groups TypeResource DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications. -Idaws.route53recoveryreadiness.recovery_groups +Id ## Fields - - + +
NameDatatypeDescription
recovery_group_namestringThe name of the recovery group to create.
regionstringAWS region.
stringThe name of the recovery group to create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of recovery_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md index 6735c71fc6..daa5f332e1 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_set resource, use resource_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual resource_set resource, use Nameresource_set TypeResource DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API. -Idaws.route53recoveryreadiness.resource_set +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to create.
resourcesarrayA list of resource objects in the resource set.
resource_set_arnstringThe Amazon Resource Name (ARN) of the resource set.
resource_set_typestringThe resource type of the resources in the resource set. Enter one of the following values for resource type: <br/><br/>AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
tagsarrayA tag to associate with the parameters for a resource set.
regionstringAWS region.
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: <br/><br/>AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
arrayA tag to associate with the parameters for a resource set.
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual resource_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md index 0fa304d623..0b43fa4d2c 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_sets in a region or create a resource_sets resource, use resource_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_sets in a region or create a Nameresource_sets TypeResource DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API. -Idaws.route53recoveryreadiness.resource_sets +Id ## Fields - - + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to create.
regionstringAWS region.
stringThe name of the resource set to create.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md index 49d9d0208a..dd576df330 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual firewall_domain_list resource, use firewall_domain_lists to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual firewall_domain_list resource, us Namefirewall_domain_list TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList. -Idaws.route53resolver.firewall_domain_list +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
arnstringArn
namestringFirewallDomainListName
domain_countintegerCount
statusstringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallDomainListAssociationStatus
managed_owner_namestringServicePrincipal
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
domainsarray
domain_file_urlstringS3 URL to import domains from.
tagsarrayTags
regionstringAWS region.
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
array
stringS3 URL to import domains from.
arrayTags
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual firewall_domain_list resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md index c99f22ba19..ea8304b011 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of firewall_domain_lists in a region or create a firewall_domain_lists resource, use firewall_domain_list to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of firewall_domain_lists in a region or cre Namefirewall_domain_lists TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList. -Idaws.route53resolver.firewall_domain_lists +Id ## Fields - - + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
stringResourceId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of firewall_domain_lists in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md index e44c7b86ed..b1dc0c0bf6 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual firewall_rule_group resource, use firewall_rule_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual firewall_rule_group resource, use Namefirewall_rule_group TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup. -Idaws.route53resolver.firewall_rule_group +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
arnstringArn
namestringFirewallRuleGroupName
rule_countintegerCount
statusstringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallRuleGroupStatus
owner_idstringAccountId
share_statusstringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
firewall_rulesarrayFirewallRules
tagsarrayTags
regionstringAWS region.
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.
@@ -53,19 +56,19 @@ Gets or operates on an individual firewall_rule_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md index ca399b2458..991f71aee1 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual firewall_rule_group_association resource, use firewall_rule_group_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual firewall_rule_group_association r Namefirewall_rule_group_association TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation. -Idaws.route53resolver.firewall_rule_group_association +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringId
arnstringArn
firewall_rule_group_idstringFirewallRuleGroupId
vpc_idstringVpcId
namestringFirewallRuleGroupAssociationName
priorityintegerPriority
mutation_protectionstringMutationProtectionStatus
managed_owner_namestringServicePrincipal
statusstringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallDomainListAssociationStatus
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
tagsarrayTags
regionstringAWS region.
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.
@@ -54,19 +57,19 @@ Gets or operates on an individual firewall_rule_group_association r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md index 985fea9e4f..81631dcdfc 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of firewall_rule_group_associations in a region or create a firewall_rule_group_associations resource, use firewall_rule_group_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of firewall_rule_group_associations in a re Namefirewall_rule_group_associations TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation. -Idaws.route53resolver.firewall_rule_group_associations +Id ## Fields - - + +
NameDatatypeDescription
idstringId
regionstringAWS region.
stringId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of firewall_rule_group_associations in a re Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md index 86e3b0127c..c34c27ad94 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of firewall_rule_groups in a region or create a firewall_rule_groups resource, use firewall_rule_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of firewall_rule_groups in a region or crea Namefirewall_rule_groups TypeResource DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup. -Idaws.route53resolver.firewall_rule_groups +Id ## Fields - - + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
stringResourceId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of firewall_rule_groups in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md index 2571c3fa52..84fafacbe0 100644 --- a/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual outpost_resolver resource, use outpost_resolvers to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual outpost_resolver resource, use Nameoutpost_resolver TypeResource DescriptionResource schema for AWS::Route53Resolver::OutpostResolver. -Idaws.route53resolver.outpost_resolver +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
idstringId
creator_request_idstringThe id of the creator request.
namestringThe OutpostResolver name.
arnstringThe OutpostResolver ARN.
outpost_arnstringThe Outpost ARN.
preferred_instance_typestringThe OutpostResolver instance type.
statusstringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
status_messagestringThe OutpostResolver status message.
instance_countintegerThe number of OutpostResolvers.
creation_timestringThe OutpostResolver creation time
modification_timestringThe OutpostResolver last modified time
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual outpost_resolver resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md index a80941f26a..91b14ec3f9 100644 --- a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of outpost_resolvers in a region or create a outpost_resolvers resource, use outpost_resolver to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of outpost_resolvers in a region or create Nameoutpost_resolvers TypeResource DescriptionResource schema for AWS::Route53Resolver::OutpostResolver. -Idaws.route53resolver.outpost_resolvers +Id ## Fields - - + +
NameDatatypeDescription
idstringId
regionstringAWS region.
stringId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of outpost_resolvers in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md index 6424e88a96..84668423b0 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver_config resource, use resolver_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual resolver_config resource, use Nameresolver_config TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverConfig. -Idaws.route53resolver.resolver_config +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
idstringId
owner_idstringAccountId
resource_idstringResourceId
autodefined_reversestringResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
autodefined_reverse_flagstringRepresents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual resolver_config resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md index 26e26bbd18..ab674939d7 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolver_configs in a region or create a resolver_configs resource, use resolver_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolver_configs in a region or create a Nameresolver_configs TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverConfig. -Idaws.route53resolver.resolver_configs +Id ## Fields - - + +
NameDatatypeDescription
resource_idstringResourceId
regionstringAWS region.
stringResourceId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolver_configs in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md index 0c1cb14570..d44a5b58eb 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver_query_logging_config resource, use resolver_query_logging_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual resolver_query_logging_config res Nameresolver_query_logging_config TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig. -Idaws.route53resolver.resolver_query_logging_config +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
owner_idstringAccountId
statusstringResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.
share_statusstringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
association_countintegerCount
arnstringArn
namestringResolverQueryLogConfigName
creator_request_idstringThe id of the creator request.
destination_arnstringdestination arn
creation_timestringRfc3339TimeString
regionstringAWS region.
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.
@@ -50,14 +53,14 @@ Gets or operates on an individual resolver_query_logging_config res Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md index becf0ff5ee..1fc0ec7ae5 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver_query_logging_config_association resource, use resolver_query_logging_config_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual resolver_query_logging_config_associatio Nameresolver_query_logging_config_association TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation. -Idaws.route53resolver.resolver_query_logging_config_association +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstringId
resolver_query_log_config_idstringResolverQueryLogConfigId
resource_idstringResourceId
statusstringResolverQueryLogConfigAssociationStatus
errorstringResolverQueryLogConfigAssociationError
error_messagestringResolverQueryLogConfigAssociationErrorMessage
creation_timestringRfc3339TimeString
regionstringAWS region.
stringId
stringResolverQueryLogConfigId
stringResourceId
stringResolverQueryLogConfigAssociationStatus
stringResolverQueryLogConfigAssociationError
stringResolverQueryLogConfigAssociationErrorMessage
stringRfc3339TimeString
stringAWS region.
@@ -47,14 +50,14 @@ Gets or operates on an individual resolver_query_logging_config_associatio Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md index af364a74c9..ae41d1c029 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolver_query_logging_config_associations in a region or create a resolver_query_logging_config_associations resource, use resolver_query_logging_config_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolver_query_logging_config_associationsNameresolver_query_logging_config_associations TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation. -Idaws.route53resolver.resolver_query_logging_config_associations +Id ## Fields - - + +
NameDatatypeDescription
idstringId
regionstringAWS region.
stringId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolver_query_logging_config_associationsRequired Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md index b34f23d295..0071d1a1bc 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolver_query_logging_configs in a region or create a resolver_query_logging_configs resource, use resolver_query_logging_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolver_query_logging_configs in a regi Nameresolver_query_logging_configs TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig. -Idaws.route53resolver.resolver_query_logging_configs +Id ## Fields - - + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
stringResourceId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolver_query_logging_configs in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md index a11def7f29..32f56c555a 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver_rule resource, use resolver_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual resolver_rule resource, use Nameresolver_rule TypeResource DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule -Idaws.route53resolver.resolver_rule +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
resolver_endpoint_idstringThe ID of the endpoint that the rule is associated with.
domain_namestringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
namestringThe name for the Resolver rule
rule_typestringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
tagsarrayAn array of key-value pairs to apply to this resource.
target_ipsarrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
arnstringThe Amazon Resource Name (ARN) of the resolver rule.
resolver_rule_idstringThe ID of the endpoint that the rule is associated with.
regionstringAWS region.
stringThe ID of the endpoint that the rule is associated with.
stringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
stringThe name for the Resolver rule
stringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
arrayAn array of key-value pairs to apply to this resource.
arrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
stringThe Amazon Resource Name (ARN) of the resolver rule.
stringThe ID of the endpoint that the rule is associated with.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual resolver_rule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md index 4f01e847cc..0828406adc 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolver_rule_association resource, use resolver_rule_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resolver_rule_association resourc Nameresolver_rule_association TypeResource DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. -Idaws.route53resolver.resolver_rule_association +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
vpc_idstringThe ID of the VPC that you associated the Resolver rule with.
resolver_rule_idstringThe ID of the Resolver rule that you associated with the VPC that is specified by ``VPCId``.
resolver_rule_association_idstring
namestringThe name of an association between a Resolver rule and a VPC.
regionstringAWS region.
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.
@@ -44,14 +47,14 @@ Gets or operates on an individual resolver_rule_association resourc Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md index 9b9c4fbb5b..0be2b2258c 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolver_rule_associations in a region or create a resolver_rule_associations resource, use resolver_rule_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolver_rule_associations in a region o Nameresolver_rule_associations TypeResource DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. -Idaws.route53resolver.resolver_rule_associations +Id ## Fields - - + +
NameDatatypeDescription
resolver_rule_association_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolver_rule_associations in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md index ccfb67b58d..797008b284 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolver_rules in a region or create a resolver_rules resource, use resolver_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolver_rules in a region or create a < Nameresolver_rules TypeResource DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule -Idaws.route53resolver.resolver_rules +Id ## Fields - - + +
NameDatatypeDescription
resolver_rule_idstringThe ID of the endpoint that the rule is associated with.
regionstringAWS region.
stringThe ID of the endpoint that the rule is associated with.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolver_rules in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md index edcf1dd449..20a6f37b3f 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resolverdnssec_config resource, use resolverdnssec_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resolverdnssec_config resource, u Nameresolverdnssec_config TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig. -Idaws.route53resolver.resolverdnssec_config +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
idstringId
owner_idstringAccountId
resource_idstringResourceId
validation_statusstringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
regionstringAWS region.
stringId
stringAccountId
stringResourceId
stringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual resolverdnssec_config resource, u Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md index d6b11a1451..a4632061d5 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resolverdnssec_configs in a region or create a resolverdnssec_configs resource, use resolverdnssec_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resolverdnssec_configs in a region or cr Nameresolverdnssec_configs TypeResource DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig. -Idaws.route53resolver.resolverdnssec_configs +Id ## Fields - - + +
NameDatatypeDescription
idstringId
regionstringAWS region.
stringId
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resolverdnssec_configs in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/rum/app_monitor/index.md b/docs/aws-docs/providers/aws/rum/app_monitor/index.md index ab6a11b492..7ddaaef8f1 100644 --- a/docs/aws-docs/providers/aws/rum/app_monitor/index.md +++ b/docs/aws-docs/providers/aws/rum/app_monitor/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app_monitor resource, use app_monitors to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual app_monitor resource, use a Nameapp_monitor TypeResource DescriptionResource Type definition for AWS::RUM::AppMonitor -Idaws.rum.app_monitor +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
idstringThe unique ID of the new app monitor.
namestringA name for the app monitor
domainstringThe top-level internet domain name for which your application has administrative authority.
cw_log_enabledbooleanData collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
tagsarray
app_monitor_configurationobject
custom_eventsobject
regionstringAWS region.
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
array
object
object
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual app_monitor resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/rum/app_monitors/index.md b/docs/aws-docs/providers/aws/rum/app_monitors/index.md index bf6f5815df..002fd946ce 100644 --- a/docs/aws-docs/providers/aws/rum/app_monitors/index.md +++ b/docs/aws-docs/providers/aws/rum/app_monitors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of app_monitors in a region or create a app_monitors resource, use app_monitor to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of app_monitors in a region or create a Nameapp_monitors TypeResource DescriptionResource Type definition for AWS::RUM::AppMonitor -Idaws.rum.app_monitors +Id ## Fields - - + +
NameDatatypeDescription
namestringA name for the app monitor
regionstringAWS region.
stringA name for the app monitor
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of app_monitors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/access_grant/index.md b/docs/aws-docs/providers/aws/s3/access_grant/index.md index 51de03860b..ffe73a9ae1 100644 --- a/docs/aws-docs/providers/aws/s3/access_grant/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grant/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_grant resource, use access_grants to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual access_grant resource, use Nameaccess_grant TypeResource DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance. -Idaws.s3.access_grant +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
access_grant_idstringThe ID assigned to this access grant.
access_grants_location_idstringThe custom S3 location to be accessed by the grantee
tagsarray
permissionstringThe level of access to be afforded to the grantee
application_arnstringThe ARN of the application grantees will use to access the location
s3_prefix_typestringThe type of S3SubPrefix.
grant_scopestringThe S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
access_grant_arnstringThe Amazon Resource Name (ARN) of the specified access grant.
granteeobjectThe principal who will be granted permission to access S3.
access_grants_location_configurationobjectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual access_grant resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/access_grants/index.md b/docs/aws-docs/providers/aws/s3/access_grants/index.md index daddf16547..0470a024e0 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_grants in a region or create a access_grants resource, use access_grant to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_grants in a region or create a Nameaccess_grants TypeResource DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance. -Idaws.s3.access_grants +Id ## Fields - - + +
NameDatatypeDescription
access_grant_idstringThe ID assigned to this access grant.
regionstringAWS region.
stringThe ID assigned to this access grant.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_grants in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md index 751cf3658c..d3e6ed6f91 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_grants_instance resource, use access_grants_instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual access_grants_instance resource, Nameaccess_grants_instance TypeResource DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations -Idaws.s3.access_grants_instance +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
access_grants_instance_arnstringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
identity_center_arnstringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
access_grants_instance_idstringA unique identifier for the specified access grants instance.
tagsarray
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual access_grants_instance resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md index 7b279a9cda..ee5abfb4ab 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_grants_instances in a region or create a access_grants_instances resource, use access_grants_instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_grants_instances in a region or c Nameaccess_grants_instances TypeResource DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations -Idaws.s3.access_grants_instances +Id ## Fields - - + +
NameDatatypeDescription
access_grants_instance_arnundefinedThe Amazon Resource Name (ARN) of the specified Access Grants instance.
regionstringAWS region.
undefinedThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_grants_instances in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_location/index.md b/docs/aws-docs/providers/aws/s3/access_grants_location/index.md index 61f2999037..e832128be3 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_location/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_location/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_grants_location resource, use access_grants_locations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual access_grants_location resource, Nameaccess_grants_location TypeResource DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants. -Idaws.s3.access_grants_location +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
access_grants_location_arnstringThe Amazon Resource Name (ARN) of the specified Access Grants location.
access_grants_location_idstringThe unique identifier for the specified Access Grants location.
iam_role_arnstringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
location_scopestringDescriptor for where the location actually points
tagsarray
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual access_grants_location resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md index bbdb35f09e..925c7302e4 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_grants_locations in a region or create a access_grants_locations resource, use access_grants_location to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_grants_locations in a region or c Nameaccess_grants_locations TypeResource DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants. -Idaws.s3.access_grants_locations +Id ## Fields - - + +
NameDatatypeDescription
access_grants_location_idstringThe unique identifier for the specified Access Grants location.
regionstringAWS region.
stringThe unique identifier for the specified Access Grants location.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_grants_locations in a region or c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/access_point/index.md b/docs/aws-docs/providers/aws/s3/access_point/index.md index a1b2b7ec31..fbae55838d 100644 --- a/docs/aws-docs/providers/aws/s3/access_point/index.md +++ b/docs/aws-docs/providers/aws/s3/access_point/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_point resource, use access_points to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual access_point resource, use Nameaccess_point TypeResource DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. -Idaws.s3.access_point +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
aliasstringThe alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.
bucketstringThe name of the bucket that you want to associate this Access Point with.
bucket_account_idstringThe AWS account ID associated with the S3 bucket associated with this access point.
vpc_configurationobjectIf you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).
public_access_block_configurationobjectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
policyobjectThe Access Point Policy you want to apply to this access point.
network_originstringIndicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.
arnstringThe Amazon Resource Name (ARN) of the specified accesspoint.
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual access_point resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/access_points/index.md b/docs/aws-docs/providers/aws/s3/access_points/index.md index d89d1b113c..03e8fb1e2f 100644 --- a/docs/aws-docs/providers/aws/s3/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3/access_points/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_points in a region or create a access_points resource, use access_point to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_points in a region or create a Nameaccess_points TypeResource DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. -Idaws.s3.access_points +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_points in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/bucket/index.md b/docs/aws-docs/providers/aws/s3/bucket/index.md index ee10ff3898..7005a78e56 100644 --- a/docs/aws-docs/providers/aws/s3/bucket/index.md +++ b/docs/aws-docs/providers/aws/s3/bucket/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket resource, use buckets to retrieve a list of resources or to create a resource. ## Overview @@ -21,38 +24,38 @@ Gets or operates on an individual bucket resource, use bucket Namebucket TypeResource DescriptionThe ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.<br/> To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).<br/> You can only delete empty buckets. Deletion fails for buckets that have contents. -Idaws.s3.bucket +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
accelerate_configurationobjectConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
access_controlstringThis is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.<br/> A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.<br/> S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.<br/> The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
analytics_configurationsarraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
bucket_encryptionobjectSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
bucket_namestringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
cors_configurationobjectDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
intelligent_tiering_configurationsarrayDefines how Amazon S3 handles Intelligent-Tiering storage.
inventory_configurationsarraySpecifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
lifecycle_configurationobjectSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
logging_configurationobjectSettings that define where logs are stored.
metrics_configurationsarraySpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
notification_configurationobjectConfiguration that defines how Amazon S3 handles bucket notifications.
object_lock_configurationobjectThis operation is not supported by directory buckets.<br/> Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). <br/> + The ``DefaultRetention`` settings require both a mode and a period.<br/> + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.<br/> + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
object_lock_enabledbooleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.
ownership_controlsobjectConfiguration that defines how Amazon S3 handles Object Ownership rules.
public_access_block_configurationobjectConfiguration that defines how Amazon S3 handles public access.
replication_configurationobjectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.<br/> Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
tagsarrayAn arbitrary set of tags (key-value pairs) for this S3 bucket.
versioning_configurationobjectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
website_configurationobjectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
arnstring
domain_namestring
dual_stack_domain_namestring
regional_domain_namestring
website_urlstring
regionstringAWS region.
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*.<br/> A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.<br/> S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.<br/> The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
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*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
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.<br/> Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). <br/> + The ``DefaultRetention`` settings require both a mode and a period.<br/> + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.<br/> + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
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.<br/> Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
arrayAn arbitrary set of tags (key-value pairs) for this S3 bucket.
objectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
objectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
string
string
string
string
string
stringAWS region.
@@ -65,19 +68,19 @@ Gets or operates on an individual bucket resource, use bucket Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md index 4e98a0c9a2..192ae791ab 100644 --- a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bucket_policies in a region or create a bucket_policies resource, use bucket_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of bucket_policies in a region or create a Namebucket_policies TypeResource DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.<br/> If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.<br/> As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. <br/> For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).<br/> The following operations are related to ``PutBucketPolicy``:<br/> + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) <br/> + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) -Idaws.s3.bucket_policies +Id ## Fields - - + +
NameDatatypeDescription
bucketstringThe name of the Amazon S3 bucket to which the policy applies.
regionstringAWS region.
stringThe name of the Amazon S3 bucket to which the policy applies.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of bucket_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3/bucket_policy/index.md index dd19d421d0..583cbc4e08 100644 --- a/docs/aws-docs/providers/aws/s3/bucket_policy/index.md +++ b/docs/aws-docs/providers/aws/s3/bucket_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket_policy resource, use bucket_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual bucket_policy resource, use Namebucket_policy TypeResource DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.<br/> If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.<br/> As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. <br/> For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).<br/> The following operations are related to ``PutBucketPolicy``:<br/> + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) <br/> + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) -Idaws.s3.bucket_policy +Id ## Fields - - - + + +
NameDatatypeDescription
bucketstringThe name of the Amazon S3 bucket to which the policy applies.
policy_documentobjectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual bucket_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/buckets/index.md b/docs/aws-docs/providers/aws/s3/buckets/index.md index 35221499ac..a8b1704f27 100644 --- a/docs/aws-docs/providers/aws/s3/buckets/index.md +++ b/docs/aws-docs/providers/aws/s3/buckets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of buckets in a region or create a buckets resource, use bucket to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of buckets in a region or create a bu Namebuckets TypeResource DescriptionThe ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.<br/> To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).<br/> You can only delete empty buckets. Deletion fails for buckets that have contents. -Idaws.s3.buckets +Id ## Fields - - + +
NameDatatypeDescription
bucket_namestringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
regionstringAWS region.
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*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of buckets in a region or create a bu Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md index f77be5bb67..f4613e9a98 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual multi_region_access_point resource, use multi_region_access_points to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual multi_region_access_point resourc Namemulti_region_access_point TypeResource DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies. -Idaws.s3.multi_region_access_point +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Multi Region Access Point.
aliasstringThe alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point
created_atstringThe timestamp of the when the Multi Region Access Point is created
public_access_block_configurationobjectThe PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
regionsarrayThe list of buckets that you want to associate this Multi Region Access Point with.
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual multi_region_access_point resourc Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md index 5b6e34ea68..c0d5d02347 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of multi_region_access_point_policies in a region or create a multi_region_access_point_policies resource, use multi_region_access_point_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of multi_region_access_point_policies in a Namemulti_region_access_point_policies TypeResource DescriptionThe policy to be attached to a Multi Region Access Point -Idaws.s3.multi_region_access_point_policies +Id ## Fields - - + +
NameDatatypeDescription
mrap_namestringThe name of the Multi Region Access Point to apply policy
regionstringAWS region.
stringThe name of the Multi Region Access Point to apply policy
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of multi_region_access_point_policies in a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md index 26364e08c0..1a388b889c 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual multi_region_access_point_policy resource, use multi_region_access_point_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual multi_region_access_point_policy Namemulti_region_access_point_policy TypeResource DescriptionThe policy to be attached to a Multi Region Access Point -Idaws.s3.multi_region_access_point_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
mrap_namestringThe name of the Multi Region Access Point to apply policy
policyobjectPolicy document to apply to a Multi Region Access Point
policy_statusobjectThe Policy Status associated with this Multi Region Access Point
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual multi_region_access_point_policy Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md index 2c40e02e9b..6bfff94673 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of multi_region_access_points in a region or create a multi_region_access_points resource, use multi_region_access_point to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of multi_region_access_points in a region o Namemulti_region_access_points TypeResource DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies. -Idaws.s3.multi_region_access_points +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name you want to assign to this Multi Region Access Point.
regionstringAWS region.
stringThe name you want to assign to this Multi Region Access Point.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of multi_region_access_points in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens/index.md b/docs/aws-docs/providers/aws/s3/storage_lens/index.md index 531859b8e8..38bdd22ad7 100644 --- a/docs/aws-docs/providers/aws/s3/storage_lens/index.md +++ b/docs/aws-docs/providers/aws/s3/storage_lens/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual storage_lens resource, use storage_lens to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual storage_lens resource, use Namestorage_lens TypeResource DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations. -Idaws.s3.storage_lens +Id ## Fields - - - + + +
NameDatatypeDescription
storage_lens_configurationobject
tagsarrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
regionstringAWS region.
object
arrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual storage_lens resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md index 24bf3c1727..a3a213a602 100644 --- a/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md +++ b/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual storage_lens_group resource, use storage_lens_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual storage_lens_group resource, use Namestorage_lens_group TypeResource DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group. -Idaws.s3.storage_lens_group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestring
filterobject
storage_lens_group_arnstringThe ARN for the Amazon S3 Storage Lens Group.
tagsarrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.
regionstringAWS region.
string
object
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual storage_lens_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md index 6c9da1d4c2..4f3550f2c3 100644 --- a/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md +++ b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of storage_lens_groups in a region or create a storage_lens_groups resource, use storage_lens_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of storage_lens_groups in a region or creat Namestorage_lens_groups TypeResource DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group. -Idaws.s3.storage_lens_groups +Id ## Fields - - + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of storage_lens_groups in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md index 4407d37f26..1b039f0b1e 100644 --- a/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bucket_policies in a region or create a bucket_policies resource, use bucket_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of bucket_policies in a region or create a Namebucket_policies TypeResource DescriptionResource Type definition for AWS::S3Express::BucketPolicy. -Idaws.s3express.bucket_policies +Id ## Fields - - + +
NameDatatypeDescription
bucketstringThe name of the S3 directory bucket to which the policy applies.
regionstringAWS region.
stringThe name of the S3 directory bucket to which the policy applies.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of bucket_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md index 897cd3b1e1..81909b8ff7 100644 --- a/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md +++ b/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket_policy resource, use bucket_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual bucket_policy resource, use Namebucket_policy TypeResource DescriptionResource Type definition for AWS::S3Express::BucketPolicy. -Idaws.s3express.bucket_policy +Id ## Fields - - - + + +
NameDatatypeDescription
bucketstringThe name of the S3 directory bucket to which the policy applies.
policy_documentobjectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual bucket_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md b/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md index d55004cfb6..5c2152c9db 100644 --- a/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md +++ b/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual directory_bucket resource, use directory_buckets to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual directory_bucket resource, use Namedirectory_bucket TypeResource DescriptionResource Type definition for AWS::S3Express::DirectoryBucket. -Idaws.s3express.directory_bucket +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
bucket_namestringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
location_namestringSpecifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
data_redundancystringSpecifies the number of Availability Zone that's used for redundancy for the bucket.
arnstringReturns the Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
stringSpecifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
stringSpecifies the number of Availability Zone that's used for redundancy for the bucket.
stringReturns the Amazon Resource Name (ARN) of the specified bucket.
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual directory_bucket resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md index 9ac1cab3a6..87ef1af676 100644 --- a/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md +++ b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of directory_buckets in a region or create a directory_buckets resource, use directory_bucket to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of directory_buckets in a region or create Namedirectory_buckets TypeResource DescriptionResource Type definition for AWS::S3Express::DirectoryBucket. -Idaws.s3express.directory_buckets +Id ## Fields - - + +
NameDatatypeDescription
bucket_namestringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
regionstringAWS region.
stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of directory_buckets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md index 57d121adda..882e968466 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_point resource, use access_points to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual access_point resource, use Nameaccess_point TypeResource DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions -Idaws.s3objectlambda.access_point +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Object lambda Access Point.
aliasobject
arnstring
creation_datestringThe date and time when the Object lambda Access Point was created.
public_access_block_configurationobjectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
policy_statusobject
object_lambda_configurationobjectThe Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual access_point resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md index 8d6d977fed..e5e4530f77 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_point_policies in a region or create a access_point_policies resource, use access_point_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_point_policies in a region or cre Nameaccess_point_policies TypeResource DescriptionAWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda -Idaws.s3objectlambda.access_point_policies +Id ## Fields - - + +
NameDatatypeDescription
object_lambda_access_pointstringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
regionstringAWS region.
stringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_point_policies in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md index 8680eead27..8ca7288393 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_point_policy resource, use access_point_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual access_point_policy resource, use Nameaccess_point_policy TypeResource DescriptionAWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda -Idaws.s3objectlambda.access_point_policy +Id ## Fields - - - + + +
NameDatatypeDescription
object_lambda_access_pointstringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
policy_documentobjectA policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual access_point_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md index 2bc36d5d09..5725d86e22 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_points in a region or create a access_points resource, use access_point to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_points in a region or create a Nameaccess_points TypeResource DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions -Idaws.s3objectlambda.access_points +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name you want to assign to this Object lambda Access Point.
regionstringAWS region.
stringThe name you want to assign to this Object lambda Access Point.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_points in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3outposts/access_point/index.md b/docs/aws-docs/providers/aws/s3outposts/access_point/index.md index 4d2cb84a85..a538920001 100644 --- a/docs/aws-docs/providers/aws/s3outposts/access_point/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/access_point/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_point resource, use access_points to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual access_point resource, use Nameaccess_point TypeResource DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint -Idaws.s3outposts.access_point +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified AccessPoint.
bucketstringThe Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.
namestringA name for the AccessPoint.
vpc_configurationobjectVirtual Private Cloud (VPC) from which requests can be made to the AccessPoint.
policyobjectThe access point policy associated with this access point.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual access_point resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3outposts/access_points/index.md b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md index 9fbf368ee8..e6d6b4c53a 100644 --- a/docs/aws-docs/providers/aws/s3outposts/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_points in a region or create a access_points resource, use access_point to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_points in a region or create a Nameaccess_points TypeResource DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint -Idaws.s3outposts.access_points +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified AccessPoint.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the specified AccessPoint.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_points in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket/index.md index 5e8744df1a..f3014938cc 100644 --- a/docs/aws-docs/providers/aws/s3outposts/bucket/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/bucket/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket resource, use buckets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual bucket resource, use bucket Namebucket TypeResource DescriptionResource Type Definition for AWS::S3Outposts::Bucket -Idaws.s3outposts.bucket +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
bucket_namestringA name for the bucket.
outpost_idstringThe id of the customer outpost on which the bucket resides.
tagsarrayAn arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
lifecycle_configurationobjectRules that define how Amazon S3Outposts manages objects during their lifetime.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual bucket resource, use bucket Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md index f43ea1b137..162d216e1c 100644 --- a/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of bucket_policies in a region or create a bucket_policies resource, use bucket_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of bucket_policies in a region or create a Namebucket_policies TypeResource DescriptionResource Type Definition for AWS::S3Outposts::BucketPolicy -Idaws.s3outposts.bucket_policies +Id ## Fields - - + +
NameDatatypeDescription
bucketstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of bucket_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md index 55c89f7557..507686fa58 100644 --- a/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual bucket_policy resource, use bucket_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual bucket_policy resource, use Namebucket_policy TypeResource DescriptionResource Type Definition for AWS::S3Outposts::BucketPolicy -Idaws.s3outposts.bucket_policy +Id ## Fields - - - + + +
NameDatatypeDescription
bucketstringThe Amazon Resource Name (ARN) of the specified bucket.
policy_documentobjectA policy document containing permissions to add to the specified bucket.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the specified bucket.
objectA policy document containing permissions to add to the specified bucket.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual bucket_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3outposts/buckets/index.md b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md index eb8c7c5c2d..ee99ee7dd4 100644 --- a/docs/aws-docs/providers/aws/s3outposts/buckets/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of buckets in a region or create a buckets resource, use bucket to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of buckets in a region or create a bu Namebuckets TypeResource DescriptionResource Type Definition for AWS::S3Outposts::Bucket -Idaws.s3outposts.buckets +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of buckets in a region or create a bu Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md index 45b1ab145c..bd93c1ee11 100644 --- a/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual endpoint resource, use endpoints to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual endpoint resource, use endp Nameendpoint TypeResource DescriptionResource Type Definition for AWS::S3Outposts::Endpoint -Idaws.s3outposts.endpoint +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the endpoint.
cidr_blockstringThe VPC CIDR committed by this endpoint.
creation_timestringThe time the endpoint was created.
idstringThe ID of the endpoint.
network_interfacesarrayThe network interfaces of the endpoint.
outpost_idstringThe id of the customer outpost on which the bucket resides.
security_group_idstringThe ID of the security group to use with the endpoint.
statusstring
subnet_idstringThe ID of the subnet in the selected VPC. The subnet must belong to the Outpost.
access_typestringThe type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.
customer_owned_ipv4_poolstringThe ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.
failed_reasonobjectThe failure reason, if any, for a create or delete endpoint operation.
regionstringAWS region.
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.
@@ -52,14 +55,14 @@ Gets or operates on an individual endpoint resource, use endp Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md index 9c5ca6fcbc..94254adadd 100644 --- a/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of endpoints in a region or create a endpoints resource, use endpoint to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of endpoints in a region or create a Nameendpoints TypeResource DescriptionResource Type Definition for AWS::S3Outposts::Endpoint -Idaws.s3outposts.endpoints +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the endpoint.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the endpoint.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of endpoints in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/app/index.md b/docs/aws-docs/providers/aws/sagemaker/app/index.md index f2a683fd2c..7c6f5a574f 100644 --- a/docs/aws-docs/providers/aws/sagemaker/app/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/app/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app resource, use apps to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual app resource, use appsNameapp TypeResource DescriptionResource Type definition for AWS::SageMaker::App -Idaws.sagemaker.app +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
app_arnstringThe Amazon Resource Name (ARN) of the app.
app_namestringThe name of the app.
app_typestringThe type of app.
domain_idstringThe domain ID.
resource_specobjectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
tagsarrayA list of tags to apply to the app.
user_profile_namestringThe user profile name.
regionstringAWS region.
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.
@@ -47,14 +50,14 @@ Gets or operates on an individual app resource, use appsRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md index 098c1649eb..a6143119dd 100644 --- a/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual app_image_config resource, use app_image_configs to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual app_image_config resource, use Nameapp_image_config TypeResource DescriptionResource Type definition for AWS::SageMaker::AppImageConfig -Idaws.sagemaker.app_image_config +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
app_image_config_arnstringThe Amazon Resource Name (ARN) of the AppImageConfig.
app_image_config_namestringThe Name of the AppImageConfig.
kernel_gateway_image_configobjectThe KernelGatewayImageConfig.
jupyter_lab_app_image_configobjectThe JupyterLabAppImageConfig.
code_editor_app_image_configobjectThe CodeEditorAppImageConfig.
tagsarrayA list of tags to apply to the AppImageConfig.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual app_image_config resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md index 7c6bd93f25..7a562922f9 100644 --- a/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of app_image_configs in a region or create a app_image_configs resource, use app_image_config to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of app_image_configs in a region or create Nameapp_image_configs TypeResource DescriptionResource Type definition for AWS::SageMaker::AppImageConfig -Idaws.sagemaker.app_image_configs +Id ## Fields - - + +
NameDatatypeDescription
app_image_config_namestringThe Name of the AppImageConfig.
regionstringAWS region.
stringThe Name of the AppImageConfig.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of app_image_configs in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/apps/index.md b/docs/aws-docs/providers/aws/sagemaker/apps/index.md index 0f0093439e..2a7f34080e 100644 --- a/docs/aws-docs/providers/aws/sagemaker/apps/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/apps/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of apps in a region or create a apps resource, use app to operate on an individual resource. ## Overview @@ -21,17 +24,17 @@ Used to retrieve a list of apps in a region or create a apps< Nameapps TypeResource DescriptionResource Type definition for AWS::SageMaker::App -Idaws.sagemaker.apps +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
app_namestringThe name of the app.
app_typestringThe type of app.
domain_idstringThe domain ID.
user_profile_namestringThe user profile name.
regionstringAWS region.
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
stringThe user profile name.
stringAWS region.
@@ -44,14 +47,14 @@ Used to retrieve a list of apps in a region or create a apps< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md index 2c3ca74494..981fd11cc9 100644 --- a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_quality_job_definition resource, use data_quality_job_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual data_quality_job_definition resou Namedata_quality_job_definition TypeResource DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition -Idaws.sagemaker.data_quality_job_definition +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
data_quality_baseline_configobject
data_quality_app_specificationobject
data_quality_job_inputobject
data_quality_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
string
object
object
object
object
object
object
string
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
object
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
@@ -53,14 +56,14 @@ Gets or operates on an individual data_quality_job_definition resou Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md index 784180f77a..058d2920b8 100644 --- a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_quality_job_definitions in a region or create a data_quality_job_definitions resource, use data_quality_job_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_quality_job_definitions in a region Namedata_quality_job_definitions TypeResource DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition -Idaws.sagemaker.data_quality_job_definitions +Id ## Fields - - + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_quality_job_definitions in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/device/index.md b/docs/aws-docs/providers/aws/sagemaker/device/index.md index 9da6144a9b..1ad2c7f6c2 100644 --- a/docs/aws-docs/providers/aws/sagemaker/device/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/device/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual device resource, use devices to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual device resource, use device Namedevice TypeResource DescriptionResource schema for AWS::SageMaker::Device -Idaws.sagemaker.device +Id ## Fields - - - - + + + +
NameDatatypeDescription
device_fleet_namestringThe name of the edge device fleet
deviceobjectThe Edge Device you want to register against a device fleet
tagsarrayAssociate tags with the resource
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual device resource, use device Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md b/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md index fa704630a2..afcff80ebb 100644 --- a/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual device_fleet resource, use device_fleets to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual device_fleet resource, use Namedevice_fleet TypeResource DescriptionResource schema for AWS::SageMaker::DeviceFleet -Idaws.sagemaker.device_fleet +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstringDescription for the edge device fleet
device_fleet_namestringThe name of the edge device fleet
output_configobjectS3 bucket and an ecryption key id (if available) to store outputs for the fleet
role_arnstringRole associated with the device fleet
tagsarrayAssociate tags with the resource
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual device_fleet resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md index 2dbbae85ce..fff422f204 100644 --- a/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of device_fleets in a region or create a device_fleets resource, use device_fleet to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of device_fleets in a region or create a Namedevice_fleets TypeResource DescriptionResource schema for AWS::SageMaker::DeviceFleet -Idaws.sagemaker.device_fleets +Id ## Fields - - + +
NameDatatypeDescription
device_fleet_namestringThe name of the edge device fleet
regionstringAWS region.
stringThe name of the edge device fleet
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of device_fleets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/devices/index.md b/docs/aws-docs/providers/aws/sagemaker/devices/index.md index 423fd30753..6d2fd60353 100644 --- a/docs/aws-docs/providers/aws/sagemaker/devices/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/devices/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of devices in a region or create a devices resource, use device to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of devices in a region or create a de Namedevices TypeResource DescriptionResource schema for AWS::SageMaker::Device -Idaws.sagemaker.devices +Id ## Fields - - + +
NameDatatypeDescription
device/device_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of devices in a region or create a de Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md index 9551d1934c..af6ab69d7d 100644 --- a/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual feature_group resource, use feature_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual feature_group resource, use Namefeature_group TypeResource DescriptionResource Type definition for AWS::SageMaker::FeatureGroup -Idaws.sagemaker.feature_group +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
feature_group_namestringThe Name of the FeatureGroup.
record_identifier_feature_namestringThe Record Identifier Feature Name.
event_time_feature_namestringThe Event Time Feature Name.
feature_definitionsarrayAn Array of Feature Definition
online_store_configobject
offline_store_configobject
throughput_configobject
role_arnstringRole Arn
descriptionstringDescription about the FeatureGroup.
creation_timestringA timestamp of FeatureGroup creation time.
feature_group_statusstringThe status of the feature group.
tagsarrayAn array of key-value pair to apply to this resource.
regionstringAWS region.
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual feature_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md index 29c62fba46..4cfcaa2661 100644 --- a/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of feature_groups in a region or create a feature_groups resource, use feature_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of feature_groups in a region or create a < Namefeature_groups TypeResource DescriptionResource Type definition for AWS::SageMaker::FeatureGroup -Idaws.sagemaker.feature_groups +Id ## Fields - - + +
NameDatatypeDescription
feature_group_namestringThe Name of the FeatureGroup.
regionstringAWS region.
stringThe Name of the FeatureGroup.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of feature_groups in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/image/index.md b/docs/aws-docs/providers/aws/sagemaker/image/index.md index dd0bafe62f..e5a4e2213d 100644 --- a/docs/aws-docs/providers/aws/sagemaker/image/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/image/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image resource, use images to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual image resource, use images< Nameimage TypeResource DescriptionResource Type definition for AWS::SageMaker::Image -Idaws.sagemaker.image +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
image_namestring
image_arnstring
image_role_arnstring
image_display_namestring
image_descriptionstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual image resource, use images< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_version/index.md b/docs/aws-docs/providers/aws/sagemaker/image_version/index.md index 847bb06b2b..cef68c4363 100644 --- a/docs/aws-docs/providers/aws/sagemaker/image_version/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/image_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual image_version resource, use image_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual image_version resource, use Nameimage_version TypeResource DescriptionResource Type definition for AWS::SageMaker::ImageVersion -Idaws.sagemaker.image_version +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
image_namestring
image_arnstring
image_version_arnstring
base_imagestring
container_imagestring
versioninteger
aliasstring
aliasesarray
vendor_guidancestring
job_typestring
ml_frameworkstring
programming_langstring
processorstring
horovodboolean
release_notesstring
regionstringAWS region.
string
string
string
string
string
integer
string
array
string
string
string
string
string
boolean
string
stringAWS region.
@@ -55,19 +58,19 @@ Gets or operates on an individual image_version resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md index 4d63a0062c..2399a11229 100644 --- a/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of image_versions in a region or create a image_versions resource, use image_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of image_versions in a region or create a < Nameimage_versions TypeResource DescriptionResource Type definition for AWS::SageMaker::ImageVersion -Idaws.sagemaker.image_versions +Id ## Fields - - + +
NameDatatypeDescription
image_version_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of image_versions in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/images/index.md b/docs/aws-docs/providers/aws/sagemaker/images/index.md index 7a0d6b03a3..51b35ed504 100644 --- a/docs/aws-docs/providers/aws/sagemaker/images/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/images/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of images in a region or create a images resource, use image to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of images in a region or create a ima Nameimages TypeResource DescriptionResource Type definition for AWS::SageMaker::Image -Idaws.sagemaker.images +Id ## Fields - - + +
NameDatatypeDescription
image_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of images in a region or create a ima Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md index 4fda7374be..6e5b069762 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual inference_component resource, use inference_components to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual inference_component resource, use Nameinference_component TypeResource DescriptionResource Type definition for AWS::SageMaker::InferenceComponent -Idaws.sagemaker.inference_component +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
inference_component_arnstring
inference_component_namestring
endpoint_arnstring
endpoint_namestring
variant_namestring
failure_reasonstring
specificationobject
runtime_configobject
inference_component_statusstring
creation_timestring
last_modified_timestring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
object
object
string
string
string
array
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual inference_component resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md index c7bc6c9d92..244bdbe59f 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of inference_components in a region or create a inference_components resource, use inference_component to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of inference_components in a region or crea Nameinference_components TypeResource DescriptionResource Type definition for AWS::SageMaker::InferenceComponent -Idaws.sagemaker.inference_components +Id ## Fields - - + +
NameDatatypeDescription
inference_component_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of inference_components in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md index 7502cf004b..89d55fc5fc 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual inference_experiment resource, use inference_experiments to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual inference_experiment resource, us Nameinference_experiment TypeResource DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment -Idaws.sagemaker.inference_experiment +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the inference experiment.
namestringThe name for the inference experiment.
typestringThe type of the inference experiment that you want to run.
descriptionstringThe description of the inference experiment.
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
endpoint_namestring
endpoint_metadataobject
scheduleobject
kms_keystringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
data_storage_configobject
model_variantsarrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
shadow_mode_configobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe timestamp at which you created the inference experiment.
last_modified_timestringThe timestamp at which you last modified the inference experiment.
statusstringThe status of the inference experiment.
status_reasonstringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
desired_statestringThe desired state of the experiment after starting or stopping operation.
regionstringAWS region.
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.
string
object
object
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.
object
arrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
object
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.
@@ -58,19 +61,19 @@ Gets or operates on an individual inference_experiment resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md index eb2c755fac..1a9047d6d0 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of inference_experiments in a region or create a inference_experiments resource, use inference_experiment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of inference_experiments in a region or cre Nameinference_experiments TypeResource DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment -Idaws.sagemaker.inference_experiments +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name for the inference experiment.
regionstringAWS region.
stringThe name for the inference experiment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of inference_experiments in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md index 072d96e636..9775340aee 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_bias_job_definition resource, use model_bias_job_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual model_bias_job_definition resourc Namemodel_bias_job_definition TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition -Idaws.sagemaker.model_bias_job_definition +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_bias_baseline_configobject
model_bias_app_specificationobject
model_bias_job_inputobject
model_bias_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
string
object
object
object
object
object
object
string
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
object
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
@@ -53,14 +56,14 @@ Gets or operates on an individual model_bias_job_definition resourc Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md index 0cf13db3f4..26dc7c159a 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_bias_job_definitions in a region or create a model_bias_job_definitions resource, use model_bias_job_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_bias_job_definitions in a region o Namemodel_bias_job_definitions TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition -Idaws.sagemaker.model_bias_job_definitions +Id ## Fields - - + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_bias_job_definitions in a region o Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_card/index.md b/docs/aws-docs/providers/aws/sagemaker/model_card/index.md index 92c95981fc..d79f41db64 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_card/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_card/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_card resource, use model_cards to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual model_card resource, use mo Namemodel_card TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelCard. -Idaws.sagemaker.model_card +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
model_card_arnstringThe Amazon Resource Name (ARN) of the successfully created model card.
model_card_versionintegerA version of the model card.
model_card_namestringThe unique name of the model card.
security_configobject
model_card_statusstringThe approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
contentobject
creation_timestringThe date and time the model card was created.
created_byobjectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
last_modified_timestringThe date and time the model card was last modified.
last_modified_byobjectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
model_card_processing_statusstringThe processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
tagsarrayKey-value pairs used to manage metadata for model cards.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the successfully created model card.
integerA version of the model card.
stringThe unique name of the model card.
object
stringThe approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
object
stringThe date and time the model card was created.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe date and time the model card was last modified.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
arrayKey-value pairs used to manage metadata for model cards.
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual model_card resource, use mo Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md index cb5b38b2e4..9bf00584e5 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_cards in a region or create a model_cards resource, use model_card to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_cards in a region or create a Namemodel_cards TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelCard. -Idaws.sagemaker.model_cards +Id ## Fields - - + +
NameDatatypeDescription
model_card_namestringThe unique name of the model card.
regionstringAWS region.
stringThe unique name of the model card.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_cards in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md index 63e1e479dd..9043d86941 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_explainability_job_definition resource, use model_explainability_job_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual model_explainability_job_definitionNamemodel_explainability_job_definition TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition -Idaws.sagemaker.model_explainability_job_definition +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_explainability_baseline_configobject
model_explainability_app_specificationobject
model_explainability_job_inputobject
model_explainability_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
string
object
object
object
object
object
object
string
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
object
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
@@ -53,14 +56,14 @@ Gets or operates on an individual model_explainability_job_definitionRequired Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md index 79a92dd606..b0c0bc2b45 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_explainability_job_definitions in a region or create a model_explainability_job_definitions resource, use model_explainability_job_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_explainability_job_definitions in Namemodel_explainability_job_definitions TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition -Idaws.sagemaker.model_explainability_job_definitions +Id ## Fields - - + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_explainability_job_definitions in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package/index.md index 8dd0b053dc..4d23d7cf20 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_package/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_package/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_package resource, use model_packages to retrieve a list of resources or to create a resource. ## Overview @@ -21,40 +24,40 @@ Gets or operates on an individual model_package resource, use Namemodel_package TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelPackage -Idaws.sagemaker.model_package +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
additional_inference_specificationsarray
certify_for_marketplaceboolean
client_tokenstring
customer_metadata_propertiesobject
domainstring
drift_check_baselinesobject
inference_specificationobject
metadata_propertiesobject
model_approval_statusstring
model_metricsobject
model_package_descriptionstring
model_package_group_namestring
model_package_namestring
sample_payload_urlstring
skip_model_validationstring
source_algorithm_specificationobject
taskstring
validation_specificationobject
model_package_arnstring
approval_descriptionstring
creation_timestring
last_modified_timestring
model_package_statusstring
model_package_versioninteger
additional_inference_specifications_to_addarray
model_package_status_detailsobject
regionstringAWS region.
arrayAn array of key-value pairs to apply to this resource.
array
boolean
string
object
string
object
object
object
string
object
string
string
string
string
string
object
string
object
string
string
string
string
string
integer
array
object
stringAWS region.
@@ -67,19 +70,19 @@ Gets or operates on an individual model_package resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md index 9842085e4b..b10de137ae 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_package_group resource, use model_package_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual model_package_group resource, use Namemodel_package_group TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup -Idaws.sagemaker.model_package_group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
model_package_group_arnstring
model_package_group_namestring
model_package_group_descriptionstring
model_package_group_policyobject
creation_timestringThe time at which the model package group was created.
model_package_group_statusstringThe status of a modelpackage group job.
regionstringAWS region.
arrayAn array of key-value pairs to apply to this resource.
string
string
string
object
stringThe time at which the model package group was created.
stringThe status of a modelpackage group job.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual model_package_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md index d51c37a0d4..ebdaab9424 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_package_groups in a region or create a model_package_groups resource, use model_package_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_package_groups in a region or crea Namemodel_package_groups TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup -Idaws.sagemaker.model_package_groups +Id ## Fields - - + +
NameDatatypeDescription
model_package_group_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_package_groups in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md index 0ab17cda71..061eac3dc9 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_packages in a region or create a model_packages resource, use model_package to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_packages in a region or create a < Namemodel_packages TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelPackage -Idaws.sagemaker.model_packages +Id ## Fields - - + +
NameDatatypeDescription
model_package_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_packages in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md index 97dc29d4e4..5905bcd88b 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual model_quality_job_definition resource, use model_quality_job_definitions to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual model_quality_job_definition reso Namemodel_quality_job_definition TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition -Idaws.sagemaker.model_quality_job_definition +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_quality_baseline_configobject
model_quality_app_specificationobject
model_quality_job_inputobject
model_quality_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
string
object
object
object
object
object
object
string
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
object
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
@@ -53,14 +56,14 @@ Gets or operates on an individual model_quality_job_definition reso Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md index 574a7a703e..033a39ffa6 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of model_quality_job_definitions in a region or create a model_quality_job_definitions resource, use model_quality_job_definition to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of model_quality_job_definitions in a regio Namemodel_quality_job_definitions TypeResource DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition -Idaws.sagemaker.model_quality_job_definitions +Id ## Fields - - + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of model_quality_job_definitions in a regio Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md index d4b322e15b..121c09805c 100644 --- a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual monitoring_schedule resource, use monitoring_schedules to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual monitoring_schedule resource, use Namemonitoring_schedule TypeResource DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule -Idaws.sagemaker.monitoring_schedule +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
monitoring_schedule_arnstringThe Amazon Resource Name (ARN) of the monitoring schedule.
monitoring_schedule_namestring
monitoring_schedule_configobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the schedule was created.
endpoint_namestring
failure_reasonstringContains the reason a monitoring job failed, if it failed.
last_modified_timestringA timestamp that indicates the last time the monitoring job was modified.
last_monitoring_execution_summaryobjectDescribes metadata on the last execution to run, if there was one.
monitoring_schedule_statusstringThe status of a schedule job.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
string
object
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the schedule was created.
string
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual monitoring_schedule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md index 7d98ae940a..0ea7ec44bd 100644 --- a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of monitoring_schedules in a region or create a monitoring_schedules resource, use monitoring_schedule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of monitoring_schedules in a region or crea Namemonitoring_schedules TypeResource DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule -Idaws.sagemaker.monitoring_schedules +Id ## Fields - - + +
NameDatatypeDescription
monitoring_schedule_arnstringThe Amazon Resource Name (ARN) of the monitoring schedule.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of monitoring_schedules in a region or crea Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md b/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md index dcb266be81..c5ff5a39cb 100644 --- a/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual pipeline resource, use pipelines to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual pipeline resource, use pipe Namepipeline TypeResource DescriptionResource Type definition for AWS::SageMaker::Pipeline -Idaws.sagemaker.pipeline +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
pipeline_namestringThe name of the Pipeline.
pipeline_display_namestringThe display name of the Pipeline.
pipeline_descriptionstringThe description of the Pipeline.
pipeline_definitionobject
role_arnstringRole Arn
tagsarray
parallelism_configurationobject
regionstringAWS region.
stringThe name of the Pipeline.
stringThe display name of the Pipeline.
stringThe description of the Pipeline.
object
stringRole Arn
array
object
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual pipeline resource, use pipe Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md index e16f695602..3483dce245 100644 --- a/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of pipelines in a region or create a pipelines resource, use pipeline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of pipelines in a region or create a Namepipelines TypeResource DescriptionResource Type definition for AWS::SageMaker::Pipeline -Idaws.sagemaker.pipelines +Id ## Fields - - + +
NameDatatypeDescription
pipeline_namestringThe name of the Pipeline.
regionstringAWS region.
stringThe name of the Pipeline.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of pipelines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/project/index.md b/docs/aws-docs/providers/aws/sagemaker/project/index.md index 79ce36d49d..a787257453 100644 --- a/docs/aws-docs/providers/aws/sagemaker/project/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/project/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual project resource, use projects to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual project resource, use proje Nameproject TypeResource DescriptionResource Type definition for AWS::SageMaker::Project -Idaws.sagemaker.project +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
project_arnstring
project_idstring
project_namestring
project_descriptionstring
creation_timestringThe time at which the project was created.
service_catalog_provisioning_detailsobjectInput ServiceCatalog Provisioning Details
service_catalog_provisioned_product_detailsobjectProvisioned ServiceCatalog Details
project_statusstringThe status of a project.
regionstringAWS region.
arrayAn array of key-value pairs to apply to this resource.
string
string
string
string
stringThe time at which the project was created.
objectInput ServiceCatalog Provisioning Details
objectProvisioned ServiceCatalog Details
stringThe status of a project.
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual project resource, use proje Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/projects/index.md b/docs/aws-docs/providers/aws/sagemaker/projects/index.md index c39db34b56..98a1bf0ab0 100644 --- a/docs/aws-docs/providers/aws/sagemaker/projects/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/projects/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of projects in a region or create a projects resource, use project to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of projects in a region or create a p Nameprojects TypeResource DescriptionResource Type definition for AWS::SageMaker::Project -Idaws.sagemaker.projects +Id ## Fields - - + +
NameDatatypeDescription
project_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of projects in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/space/index.md b/docs/aws-docs/providers/aws/sagemaker/space/index.md index 4b02d281e7..a487a9f375 100644 --- a/docs/aws-docs/providers/aws/sagemaker/space/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/space/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual space resource, use spaces to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual space resource, use spaces< Namespace TypeResource DescriptionResource Type definition for AWS::SageMaker::Space -Idaws.sagemaker.space +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
space_arnstringThe space Amazon Resource Name (ARN).
domain_idstringThe ID of the associated Domain.
space_namestringA name for the Space.
space_settingsobjectA collection of settings.
tagsarrayA list of tags to apply to the space.
ownership_settingsobject
space_sharing_settingsobject
space_display_namestring
urlstring
regionstringAWS region.
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.
@@ -49,19 +52,19 @@ Gets or operates on an individual space resource, use spaces< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/spaces/index.md b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md index 2c409798b6..712aa2cb38 100644 --- a/docs/aws-docs/providers/aws/sagemaker/spaces/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of spaces in a region or create a spaces resource, use space to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of spaces in a region or create a spa Namespaces TypeResource DescriptionResource Type definition for AWS::SageMaker::Space -Idaws.sagemaker.spaces +Id ## Fields - - - + + +
NameDatatypeDescription
domain_idstringThe ID of the associated Domain.
space_namestringA name for the Space.
regionstringAWS region.
stringThe ID of the associated Domain.
stringA name for the Space.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of spaces in a region or create a spa Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md index 22b54e92df..b7b97b61b0 100644 --- a/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_profile resource, use user_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual user_profile resource, use Nameuser_profile TypeResource DescriptionResource Type definition for AWS::SageMaker::UserProfile -Idaws.sagemaker.user_profile +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
user_profile_arnstringThe user profile Amazon Resource Name (ARN).
domain_idstringThe ID of the associated Domain.
single_sign_on_user_identifierstringA specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
single_sign_on_user_valuestringThe username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
user_profile_namestringA name for the UserProfile.
user_settingsobjectA collection of settings.
tagsarrayA list of tags to apply to the user profile.
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual user_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md index 8a047a6685..d3217d14d7 100644 --- a/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of user_profiles in a region or create a user_profiles resource, use user_profile to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of user_profiles in a region or create a Nameuser_profiles TypeResource DescriptionResource Type definition for AWS::SageMaker::UserProfile -Idaws.sagemaker.user_profiles +Id ## Fields - - - + + +
NameDatatypeDescription
user_profile_namestringA name for the UserProfile.
domain_idstringThe ID of the associated Domain.
regionstringAWS region.
stringA name for the UserProfile.
stringThe ID of the associated Domain.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of user_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule/index.md b/docs/aws-docs/providers/aws/scheduler/schedule/index.md index 6ee2a28276..5755e4df4b 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedule/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schedule resource, use schedules to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual schedule resource, use sche Nameschedule TypeResource DescriptionDefinition of AWS::Scheduler::Schedule Resource Type -Idaws.scheduler.schedule +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the schedule.
descriptionstringThe description of the schedule.
end_datestringThe date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
flexible_time_windowobject
group_namestringThe name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kms_key_arnstringThe ARN for a KMS Key that will be used to encrypt customer data.
namestring
schedule_expressionstringThe scheduling expression.
schedule_expression_timezonestringThe timezone in which the scheduling expression is evaluated.
start_datestringThe date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify.
statestring
targetobject
regionstringAWS region.
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.
object
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.
string
object
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual schedule resource, use sche Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md index 8dd244a86b..0832fab946 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual schedule_group resource, use schedule_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual schedule_group resource, use Nameschedule_group TypeResource DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type -Idaws.scheduler.schedule_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the schedule group.
creation_datestringThe time at which the schedule group was created.
last_modification_datestringThe time at which the schedule group was last modified.
namestring
statestring
tagsarrayThe list of tags to associate with the schedule group.
regionstringAWS region.
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
string
arrayThe list of tags to associate with the schedule group.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual schedule_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md index ce46c7b25e..9b9d3da577 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schedule_groups in a region or create a schedule_groups resource, use schedule_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schedule_groups in a region or create a Nameschedule_groups TypeResource DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type -Idaws.scheduler.schedule_groups +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schedule_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/scheduler/schedules/index.md b/docs/aws-docs/providers/aws/scheduler/schedules/index.md index 264d3f7932..2cee3baf8d 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedules/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of schedules in a region or create a schedules resource, use schedule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of schedules in a region or create a Nameschedules TypeResource DescriptionDefinition of AWS::Scheduler::Schedule Resource Type -Idaws.scheduler.schedules +Id ## Fields - - + +
NameDatatypeDescription
namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of schedules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/secretsmanager/secret/index.md b/docs/aws-docs/providers/aws/secretsmanager/secret/index.md index 03ce8fd164..8ebea77058 100644 --- a/docs/aws-docs/providers/aws/secretsmanager/secret/index.md +++ b/docs/aws-docs/providers/aws/secretsmanager/secret/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual secret resource, use secrets to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual secret resource, use secret Namesecret TypeResource DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.<br/> For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).<br/> To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).<br/> A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.<br/> For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).<br/> For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html). -Idaws.secretsmanager.secret +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the secret.
kms_key_idstringThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).<br/> To use a KMS key in a different account, use the key ARN or the alias ARN.<br/> If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.<br/> If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.
secret_stringstringThe text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
generate_secret_stringobjectA structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.<br/> We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
replica_regionsarrayA custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
idstring
tagsarrayA list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:<br/> ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` <br/> Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".<br/> Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. <br/> If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).<br/> For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.<br/> The following restrictions apply to tags:<br/> + Maximum number of tags per secret: 50<br/> + Maximum key length: 127 Unicode characters in UTF-8<br/> + Maximum value length: 255 Unicode characters in UTF-8<br/> + Tag keys and values are case sensitive.<br/> + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.<br/> + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
namestringThe name of the new secret.<br/> The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-<br/> Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
regionstringAWS region.
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).<br/> To use a KMS key in a different account, use the key ARN or the alias ARN.<br/> If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.<br/> If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.
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.<br/> We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
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:<br/> ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` <br/> Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".<br/> Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. <br/> If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).<br/> For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.<br/> The following restrictions apply to tags:<br/> + Maximum number of tags per secret: 50<br/> + Maximum key length: 127 Unicode characters in UTF-8<br/> + Maximum value length: 255 Unicode characters in UTF-8<br/> + Tag keys and values are case sensitive.<br/> + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.<br/> + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
stringThe name of the new secret.<br/> The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-<br/> Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual secret resource, use secret Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md index 4f11320356..8d5a405c33 100644 --- a/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md +++ b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of secrets in a region or create a secrets resource, use secret to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of secrets in a region or create a se Namesecrets TypeResource DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.<br/> For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).<br/> To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).<br/> A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.<br/> For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).<br/> For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html). -Idaws.secretsmanager.secrets +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of secrets in a region or create a se Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md index 73a1bf865d..a21e0ad593 100644 --- a/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md +++ b/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual automation_rule resource, use automation_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual automation_rule resource, use Nameautomation_rule TypeResource DescriptionThe ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*. -Idaws.securityhub.automation_rule +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
rule_arnstring
rule_statusstringWhether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.
rule_orderinteger
descriptionstring
rule_namestring
created_atstring
updated_atstring
created_bystring
is_terminalboolean
actionsarray
criteriaobjectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
tagsobject
regionstringAWS region.
string
stringWhether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.
integer
string
string
string
string
string
boolean
array
objectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
object
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual automation_rule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md index 546557d81c..b73f2b632c 100644 --- a/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md +++ b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of automation_rules in a region or create a automation_rules resource, use automation_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of automation_rules in a region or create a Nameautomation_rules TypeResource DescriptionThe ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*. -Idaws.securityhub.automation_rules +Id ## Fields - - + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of automation_rules in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md index e1c4aee7d3..a8cc61856f 100644 --- a/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual delegated_admin resource, use delegated_admins to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual delegated_admin resource, use Namedelegated_admin TypeResource DescriptionThe AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId. -Idaws.securityhub.delegated_admin +Id ## Fields - - - - + + + +
NameDatatypeDescription
delegated_admin_identifierstringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
admin_account_idstringThe Amazon Web Services account identifier of the account to designate as the Security Hub administrator account
statusstringThe current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator
regionstringAWS region.
stringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
stringThe Amazon Web Services account identifier of the account to designate as the Security Hub administrator account
stringThe current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual delegated_admin resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md index ae4c9de240..a82ace37e2 100644 --- a/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of delegated_admins in a region or create a delegated_admins resource, use delegated_admin to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of delegated_admins in a region or create a Namedelegated_admins TypeResource DescriptionThe AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId. -Idaws.securityhub.delegated_admins +Id ## Fields - - + +
NameDatatypeDescription
delegated_admin_identifierstringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
regionstringAWS region.
stringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of delegated_admins in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/hub/index.md b/docs/aws-docs/providers/aws/securityhub/hub/index.md index 1043813420..cc4d4d3de2 100644 --- a/docs/aws-docs/providers/aws/securityhub/hub/index.md +++ b/docs/aws-docs/providers/aws/securityhub/hub/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual hub resource, use hubs to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual hub resource, use hubsNamehub TypeResource DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.<br/><br/> -Idaws.securityhub.hub +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
arnstringAn ARN is automatically created for the customer.
enable_default_standardsbooleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
control_finding_generatorstringThis field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
auto_enable_controlsbooleanWhether to automatically enable new controls when they are added to standards that are enabled
tagsobject
subscribed_atstringThe date and time when Security Hub was enabled in the account.
regionstringAWS region.
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
object
stringThe date and time when Security Hub was enabled in the account.
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual hub resource, use hubsRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/hubs/index.md b/docs/aws-docs/providers/aws/securityhub/hubs/index.md index ac7d080aaa..8600267d03 100644 --- a/docs/aws-docs/providers/aws/securityhub/hubs/index.md +++ b/docs/aws-docs/providers/aws/securityhub/hubs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of hubs in a region or create a hubs resource, use hub to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of hubs in a region or create a hubs< Namehubs TypeResource DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.<br/><br/> -Idaws.securityhub.hubs +Id ## Fields - - + +
NameDatatypeDescription
arnstringAn ARN is automatically created for the customer.
regionstringAWS region.
stringAn ARN is automatically created for the customer.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of hubs in a region or create a hubs< Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/insight/index.md b/docs/aws-docs/providers/aws/securityhub/insight/index.md index 8e7c19d30a..e807181a0a 100644 --- a/docs/aws-docs/providers/aws/securityhub/insight/index.md +++ b/docs/aws-docs/providers/aws/securityhub/insight/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual insight resource, use insights to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual insight resource, use insig Nameinsight TypeResource DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings. -Idaws.securityhub.insight +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
insight_arnstringThe ARN of a Security Hub insight
namestringThe name of a Security Hub insight
filtersobjectOne or more attributes used to filter the findings included in the insight
group_by_attributestringThe grouping attribute for the insight's findings
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual insight resource, use insig Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/insights/index.md b/docs/aws-docs/providers/aws/securityhub/insights/index.md index cce63a495a..3ed3ec900e 100644 --- a/docs/aws-docs/providers/aws/securityhub/insights/index.md +++ b/docs/aws-docs/providers/aws/securityhub/insights/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of insights in a region or create a insights resource, use insight to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of insights in a region or create a i Nameinsights TypeResource DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings. -Idaws.securityhub.insights +Id ## Fields - - + +
NameDatatypeDescription
insight_arnstringThe ARN of a Security Hub insight
regionstringAWS region.
stringThe ARN of a Security Hub insight
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of insights in a region or create a i Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md index e1bc90e69d..c871fa8ee8 100644 --- a/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md +++ b/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual product_subscription resource, use product_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual product_subscription resource, us Nameproduct_subscription TypeResource DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled. -Idaws.securityhub.product_subscription +Id ## Fields - - - + + +
NameDatatypeDescription
product_arnstringThe generic ARN of the product being subscribed to
product_subscription_arnstringThe ARN of the product subscription for the account
regionstringAWS region.
stringThe generic ARN of the product being subscribed to
stringThe ARN of the product subscription for the account
stringAWS region.
@@ -42,14 +45,14 @@ Gets or operates on an individual product_subscription resource, us Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md index ebaf009c32..1ed5ec4fbb 100644 --- a/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of product_subscriptions in a region or create a product_subscriptions resource, use product_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of product_subscriptions in a region or cre Nameproduct_subscriptions TypeResource DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled. -Idaws.securityhub.product_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
product_subscription_arnstringThe ARN of the product subscription for the account
regionstringAWS region.
stringThe ARN of the product subscription for the account
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of product_subscriptions in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securityhub/standard/index.md b/docs/aws-docs/providers/aws/securityhub/standard/index.md index 35b26107cd..6d0e9e8a28 100644 --- a/docs/aws-docs/providers/aws/securityhub/standard/index.md +++ b/docs/aws-docs/providers/aws/securityhub/standard/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual standard resource, use standards to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual standard resource, use stan Namestandard TypeResource DescriptionThe ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.<br/> You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.<br/> For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*. -Idaws.securityhub.standard +Id ## Fields - - - - + + + +
NameDatatypeDescription
standards_subscription_arnstring
standards_arnstringThe ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
disabled_standards_controlsarraySpecifies which controls are to be disabled in a standard. <br/> *Maximum*: ``100``
regionstringAWS region.
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. <br/> *Maximum*: ``100``
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual standard resource, use stan Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securityhub/standards/index.md b/docs/aws-docs/providers/aws/securityhub/standards/index.md index 210f274290..4166660eaa 100644 --- a/docs/aws-docs/providers/aws/securityhub/standards/index.md +++ b/docs/aws-docs/providers/aws/securityhub/standards/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of standards in a region or create a standards resource, use standard to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of standards in a region or create a Namestandards TypeResource DescriptionThe ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.<br/> You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.<br/> For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*. -Idaws.securityhub.standards +Id ## Fields - - + +
NameDatatypeDescription
standards_subscription_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of standards in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lake/index.md b/docs/aws-docs/providers/aws/securitylake/data_lake/index.md index f65a7ca4af..02a2fc0910 100644 --- a/docs/aws-docs/providers/aws/securitylake/data_lake/index.md +++ b/docs/aws-docs/providers/aws/securitylake/data_lake/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual data_lake resource, use data_lakes to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual data_lake resource, use dat Namedata_lake TypeResource DescriptionResource Type definition for AWS::SecurityLake::DataLake -Idaws.securitylake.data_lake +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
encryption_configurationobject
lifecycle_configurationobject
replication_configurationobject
meta_store_manager_role_arnstringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
tagsarray
arnstringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
s3_bucket_arnstringThe ARN for the Amazon Security Lake Amazon S3 bucket.
regionstringAWS region.
object
object
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual data_lake resource, use dat Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md index 8d227be4e1..65bddc7f06 100644 --- a/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md +++ b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of data_lakes in a region or create a data_lakes resource, use data_lake to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of data_lakes in a region or create a Namedata_lakes TypeResource DescriptionResource Type definition for AWS::SecurityLake::DataLake -Idaws.securitylake.data_lakes +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of data_lakes in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/securitylake/subscriber/index.md b/docs/aws-docs/providers/aws/securitylake/subscriber/index.md index 58e0a0aaac..448c2990ab 100644 --- a/docs/aws-docs/providers/aws/securitylake/subscriber/index.md +++ b/docs/aws-docs/providers/aws/securitylake/subscriber/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual subscriber resource, use subscribers to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual subscriber resource, use su Namesubscriber TypeResource DescriptionResource Type definition for AWS::SecurityLake::Subscriber -Idaws.securitylake.subscriber +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
access_typesarray
data_lake_arnstringThe ARN for the data lake.
subscriber_identityobjectThe AWS identity used to access your data.
subscriber_namestringThe name of your Security Lake subscriber account.
subscriber_descriptionstringThe description for your subscriber account in Security Lake.
tagsarrayAn array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
sourcesarrayThe supported AWS services from which logs and events are collected.
resource_share_arnstring
resource_share_namestring
subscriber_role_arnstring
s3_bucket_arnstring
subscriber_arnstring
regionstringAWS region.
array
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.
@@ -52,19 +55,19 @@ Gets or operates on an individual subscriber resource, use su Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/securitylake/subscribers/index.md b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md index d896df900a..896d209557 100644 --- a/docs/aws-docs/providers/aws/securitylake/subscribers/index.md +++ b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of subscribers in a region or create a subscribers resource, use subscriber to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of subscribers in a region or create a Namesubscribers TypeResource DescriptionResource Type definition for AWS::SecurityLake::Subscriber -Idaws.securitylake.subscribers +Id ## Fields - - + +
NameDatatypeDescription
subscriber_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of subscribers in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md index d5c17f247e..6d3b455464 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual cloud_formation_provisioned_product resource, use cloud_formation_provisioned_products to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual cloud_formation_provisioned_productNamecloud_formation_provisioned_product TypeResource DescriptionResource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct -Idaws.servicecatalog.cloud_formation_provisioned_product +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
accept_languagestring
notification_arnsarray
path_idstring
path_namestring
product_idstring
product_namestring
provisioned_product_namestring
provisioning_artifact_idstring
provisioning_artifact_namestring
provisioning_parametersarray
provisioning_preferencesobject
tagsarray
provisioned_product_idstring
record_idstring
cloudformation_stack_arnstring
outputsobjectList of key-value pair outputs.
regionstringAWS region.
string
array
string
string
string
string
string
string
string
array
object
array
string
string
string
objectList of key-value pair outputs.
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual cloud_formation_provisioned_productRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md index 94023539b9..26f01a0acb 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of cloud_formation_provisioned_products in a region or create a cloud_formation_provisioned_products resource, use cloud_formation_provisioned_product to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of cloud_formation_provisioned_products in Namecloud_formation_provisioned_products TypeResource DescriptionResource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct -Idaws.servicecatalog.cloud_formation_provisioned_products +Id ## Fields - - + +
NameDatatypeDescription
provisioned_product_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of cloud_formation_provisioned_products in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md index cd9eb7e730..c7be8ede02 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_action resource, use service_actions to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual service_action resource, use Nameservice_action TypeResource DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction -Idaws.servicecatalog.service_action +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
accept_languagestring
namestring
definition_typestring
definitionarray
descriptionstring
idstring
regionstringAWS region.
string
string
string
array
string
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual service_action resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md index 79c96480c4..713b57c645 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_action_association resource, use service_action_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual service_action_association resour Nameservice_action_association TypeResource DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation -Idaws.servicecatalog.service_action_association +Id ## Fields - - - - + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Gets or operates on an individual service_action_association resour Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md index c2ff11aa2e..13ca48e9ee 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_action_associations in a region or create a service_action_associations resource, use service_action_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of service_action_associations in a region Nameservice_action_associations TypeResource DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation -Idaws.servicecatalog.service_action_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
string
string
string
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of service_action_associations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md index 34c529a288..301f65b841 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_actions in a region or create a service_actions resource, use service_action to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_actions in a region or create a Nameservice_actions TypeResource DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction -Idaws.servicecatalog.service_actions +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_actions in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md index 0276bba00e..0ce74f7afe 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application -Idaws.servicecatalogappregistry.application +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestringThe name of the application.
descriptionstringThe description of the application.
tagsobject
application_tag_keystringThe key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
application_tag_valuestringThe value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
application_namestringThe name of the application.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md index 24efcbbefe..cb60102282 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application -Idaws.servicecatalogappregistry.applications +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md index 803a03b5d9..46a8a2a8a3 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual attribute_group resource, use attribute_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual attribute_group resource, use Nameattribute_group TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup. -Idaws.servicecatalogappregistry.attribute_group +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestringThe name of the attribute group.
descriptionstringThe description of the attribute group.
attributesobject
tagsobject
regionstringAWS region.
string
string
stringThe name of the attribute group.
stringThe description of the attribute group.
object
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual attribute_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md index 30b488f733..7c80ea02e7 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual attribute_group_association resource, use attribute_group_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual attribute_group_association resou Nameattribute_group_association TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation. -Idaws.servicecatalogappregistry.attribute_group_association +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
applicationstringThe name or the Id of the Application.
attribute_groupstringThe name or the Id of the AttributeGroup.
application_arnstring
attribute_group_arnstring
regionstringAWS region.
stringThe name or the Id of the Application.
stringThe name or the Id of the AttributeGroup.
string
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual attribute_group_association resou Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md index 0f7ac3762a..18855c72e3 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of attribute_group_associations in a region or create a attribute_group_associations resource, use attribute_group_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of attribute_group_associations in a region Nameattribute_group_associations TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation. -Idaws.servicecatalogappregistry.attribute_group_associations +Id ## Fields - - - + + +
NameDatatypeDescription
application_arnstring
attribute_group_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of attribute_group_associations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md index bfa8e3dde9..603b0f5844 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of attribute_groups in a region or create a attribute_groups resource, use attribute_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of attribute_groups in a region or create a Nameattribute_groups TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup. -Idaws.servicecatalogappregistry.attribute_groups +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of attribute_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md index d59df3726e..c1c448f4fa 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_association resource, use resource_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual resource_association resource, us Nameresource_association TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation -Idaws.servicecatalogappregistry.resource_association +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
applicationstringThe name or the Id of the Application.
resourcestringThe name or the Id of the Resource.
resource_typestringThe type of the CFN Resource for now it's enum CFN_STACK.
application_arnstring
resource_arnstring
regionstringAWS region.
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.
@@ -45,14 +48,14 @@ Gets or operates on an individual resource_association resource, us Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md index f239c0222a..52b75d863a 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_associations in a region or create a resource_associations resource, use resource_association to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of resource_associations in a region or cre Nameresource_associations TypeResource DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation -Idaws.servicecatalogappregistry.resource_associations +Id ## Fields - - - - + + + +
NameDatatypeDescription
application_arnstring
resource_arnstring
resource_typestringThe type of the CFN Resource for now it's enum CFN_STACK.
regionstringAWS region.
string
string
stringThe type of the CFN Resource for now it's enum CFN_STACK.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of resource_associations in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set/index.md b/docs/aws-docs/providers/aws/ses/configuration_set/index.md index d5b9db1341..da71ccd6a4 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_set/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration_set resource, use configuration_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual configuration_set resource, use < Nameconfiguration_set TypeResource DescriptionResource schema for AWS::SES::ConfigurationSet. -Idaws.ses.configuration_set +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringThe name of the configuration set.
tracking_optionsobject
delivery_optionsobject
reputation_optionsobject
sending_optionsobject
suppression_optionsobject
vdm_optionsobject
regionstringAWS region.
stringThe name of the configuration set.
object
object
object
object
object
object
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual configuration_set resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md b/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md index f4f60c9178..c817a629e2 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual configuration_set_event_destination resource, use configuration_set_event_destinations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual configuration_set_event_destinationNameconfiguration_set_event_destination TypeResource DescriptionResource Type definition for AWS::SES::ConfigurationSetEventDestination -Idaws.ses.configuration_set_event_destination +Id ## Fields - - - - + + + +
NameDatatypeDescription
idstring
configuration_set_namestringThe name of the configuration set that contains the event destination.
event_destinationobjectThe event destination object.
regionstringAWS region.
string
stringThe name of the configuration set that contains the event destination.
objectThe event destination object.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual configuration_set_event_destinationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md index bf08725b17..93baea07bf 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configuration_set_event_destinations in a region or create a configuration_set_event_destinations resource, use configuration_set_event_destination to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configuration_set_event_destinations in Nameconfiguration_set_event_destinations TypeResource DescriptionResource Type definition for AWS::SES::ConfigurationSetEventDestination -Idaws.ses.configuration_set_event_destinations +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configuration_set_event_destinations in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/configuration_sets/index.md b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md index e7078a3d69..41e462472e 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_sets/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of configuration_sets in a region or create a configuration_sets resource, use configuration_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of configuration_sets in a region or create Nameconfiguration_sets TypeResource DescriptionResource schema for AWS::SES::ConfigurationSet. -Idaws.ses.configuration_sets +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the configuration set.
regionstringAWS region.
stringThe name of the configuration set.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of configuration_sets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/contact_list/index.md b/docs/aws-docs/providers/aws/ses/contact_list/index.md index 90b3501962..dee539a485 100644 --- a/docs/aws-docs/providers/aws/ses/contact_list/index.md +++ b/docs/aws-docs/providers/aws/ses/contact_list/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual contact_list resource, use contact_lists to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual contact_list resource, use Namecontact_list TypeResource DescriptionResource schema for AWS::SES::ContactList. -Idaws.ses.contact_list +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
contact_list_namestringThe name of the contact list.
descriptionstringThe description of the contact list.
topicsarrayThe topics associated with the contact list.
tagsarrayThe tags (keys and values) associated with the contact list.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual contact_list resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/contact_lists/index.md b/docs/aws-docs/providers/aws/ses/contact_lists/index.md index bfca6a5891..117a3e4fa8 100644 --- a/docs/aws-docs/providers/aws/ses/contact_lists/index.md +++ b/docs/aws-docs/providers/aws/ses/contact_lists/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of contact_lists in a region or create a contact_lists resource, use contact_list to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of contact_lists in a region or create a Namecontact_lists TypeResource DescriptionResource schema for AWS::SES::ContactList. -Idaws.ses.contact_lists +Id ## Fields - - + +
NameDatatypeDescription
contact_list_namestringThe name of the contact list.
regionstringAWS region.
stringThe name of the contact list.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of contact_lists in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md index c86c601018..2094607ef9 100644 --- a/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual dedicated_ip_pool resource, use dedicated_ip_pools to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual dedicated_ip_pool resource, use < Namededicated_ip_pool TypeResource DescriptionResource Type definition for AWS::SES::DedicatedIpPool -Idaws.ses.dedicated_ip_pool +Id ## Fields - - - + + +
NameDatatypeDescription
pool_namestringThe name of the dedicated IP pool.
scaling_modestringSpecifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
regionstringAWS region.
stringThe name of the dedicated IP pool.
stringSpecifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual dedicated_ip_pool resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md index 1daaff1379..a612a5c3de 100644 --- a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of dedicated_ip_pools in a region or create a dedicated_ip_pools resource, use dedicated_ip_pool to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of dedicated_ip_pools in a region or create Namededicated_ip_pools TypeResource DescriptionResource Type definition for AWS::SES::DedicatedIpPool -Idaws.ses.dedicated_ip_pools +Id ## Fields - - + +
NameDatatypeDescription
pool_namestringThe name of the dedicated IP pool.
regionstringAWS region.
stringThe name of the dedicated IP pool.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of dedicated_ip_pools in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/email_identities/index.md b/docs/aws-docs/providers/aws/ses/email_identities/index.md index 3b16c114a0..dcede71190 100644 --- a/docs/aws-docs/providers/aws/ses/email_identities/index.md +++ b/docs/aws-docs/providers/aws/ses/email_identities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of email_identities in a region or create a email_identities resource, use email_identity to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of email_identities in a region or create a Nameemail_identities TypeResource DescriptionResource Type definition for AWS::SES::EmailIdentity -Idaws.ses.email_identities +Id ## Fields - - + +
NameDatatypeDescription
email_identitystringThe email address or domain to verify.
regionstringAWS region.
stringThe email address or domain to verify.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of email_identities in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/email_identity/index.md b/docs/aws-docs/providers/aws/ses/email_identity/index.md index abc87ac9e1..7175de2610 100644 --- a/docs/aws-docs/providers/aws/ses/email_identity/index.md +++ b/docs/aws-docs/providers/aws/ses/email_identity/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual email_identity resource, use email_identities to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual email_identity resource, use Nameemail_identity TypeResource DescriptionResource Type definition for AWS::SES::EmailIdentity -Idaws.ses.email_identity +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
email_identitystringThe email address or domain to verify.
configuration_set_attributesobject
dkim_signing_attributesobject
dkim_attributesobject
mail_from_attributesobject
feedback_attributesobject
dkim_dns_token_name1string
dkim_dns_token_name2string
dkim_dns_token_name3string
dkim_dns_token_value1string
dkim_dns_token_value2string
dkim_dns_token_value3string
regionstringAWS region.
stringThe email address or domain to verify.
object
object
object
object
object
string
string
string
string
string
string
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual email_identity resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/template/index.md b/docs/aws-docs/providers/aws/ses/template/index.md index a66cfba230..3090d0be2d 100644 --- a/docs/aws-docs/providers/aws/ses/template/index.md +++ b/docs/aws-docs/providers/aws/ses/template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual template resource, use templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual template resource, use temp Nametemplate TypeResource DescriptionResource Type definition for AWS::SES::Template -Idaws.ses.template +Id ## Fields - - - + + +
NameDatatypeDescription
idstring
templateobject
regionstringAWS region.
string
object
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual template resource, use temp Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ses/templates/index.md b/docs/aws-docs/providers/aws/ses/templates/index.md index 5fff896afa..7df497d6b1 100644 --- a/docs/aws-docs/providers/aws/ses/templates/index.md +++ b/docs/aws-docs/providers/aws/ses/templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of templates in a region or create a templates resource, use template to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of templates in a region or create a Nametemplates TypeResource DescriptionResource Type definition for AWS::SES::Template -Idaws.ses.templates +Id ## Fields - - + +
NameDatatypeDescription
idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md index d56d0456ad..61b53a04c5 100644 --- a/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md +++ b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual vdm_attributes resource, use vdm_attributes to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual vdm_attributes resource, use Namevdm_attributes TypeResource DescriptionResource Type definition for AWS::SES::VdmAttributes -Idaws.ses.vdm_attributes +Id ## Fields - - - - + + + +
NameDatatypeDescription
vdm_attributes_resource_idstringUnique identifier for this resource
dashboard_attributesobject
guardian_attributesobject
regionstringAWS region.
stringUnique identifier for this resource
object
object
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual vdm_attributes resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/shield/drt_access/index.md b/docs/aws-docs/providers/aws/shield/drt_access/index.md index ce07f479ea..02f46ded24 100644 --- a/docs/aws-docs/providers/aws/shield/drt_access/index.md +++ b/docs/aws-docs/providers/aws/shield/drt_access/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual drt_access resource, use drt_accesses to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual drt_access resource, use dr Namedrt_access TypeResource DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation. -Idaws.shield.drt_access +Id ## Fields - - - - + + + +
NameDatatypeDescription
account_idstring
log_bucket_listarrayAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
role_arnstringAuthorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual drt_access resource, use dr Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/shield/drt_accesses/index.md b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md index f2bcaef354..f606de1b2c 100644 --- a/docs/aws-docs/providers/aws/shield/drt_accesses/index.md +++ b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of drt_accesses in a region or create a drt_accesses resource, use drt_access to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of drt_accesses in a region or create a Namedrt_accesses TypeResource DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation. -Idaws.shield.drt_accesses +Id ## Fields - - + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of drt_accesses in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md index 3fbf10252a..55b09e4c13 100644 --- a/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md +++ b/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual proactive_engagement resource, use proactive_engagements to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual proactive_engagement resource, us Nameproactive_engagement TypeResource DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. -Idaws.shield.proactive_engagement +Id ## Fields - - - - + + + +
NameDatatypeDescription
account_idstring
proactive_engagement_statusstringIf `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.<br/>If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
emergency_contact_listarrayA list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.<br/>To enable proactive engagement, the contact list must include at least one phone number.
regionstringAWS region.
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.<br/>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.<br/>To enable proactive engagement, the contact list must include at least one phone number.
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual proactive_engagement resource, us Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md index 57176d3098..757bb7af5d 100644 --- a/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md +++ b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of proactive_engagements in a region or create a proactive_engagements resource, use proactive_engagement to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of proactive_engagements in a region or cre Nameproactive_engagements TypeResource DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. -Idaws.shield.proactive_engagements +Id ## Fields - - + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of proactive_engagements in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/shield/protection/index.md b/docs/aws-docs/providers/aws/shield/protection/index.md index d41d03433e..965f4ca724 100644 --- a/docs/aws-docs/providers/aws/shield/protection/index.md +++ b/docs/aws-docs/providers/aws/shield/protection/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual protection resource, use protections to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual protection resource, use pr Nameprotection TypeResource DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses. -Idaws.shield.protection +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
protection_idstringThe unique identifier (ID) of the protection.
protection_arnstringThe ARN (Amazon Resource Name) of the protection.
namestringFriendly name for the Protection.
resource_arnstringThe ARN (Amazon Resource Name) of the resource to be protected.
health_check_arnsarrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
application_layer_automatic_response_configurationobject
tagsarrayOne or more tag key-value pairs for the Protection object.
regionstringAWS region.
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.
object
arrayOne or more tag key-value pairs for the Protection object.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual protection resource, use pr Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/shield/protection_group/index.md b/docs/aws-docs/providers/aws/shield/protection_group/index.md index e7dfba2cc0..1d1e7437a7 100644 --- a/docs/aws-docs/providers/aws/shield/protection_group/index.md +++ b/docs/aws-docs/providers/aws/shield/protection_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual protection_group resource, use protection_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual protection_group resource, use Nameprotection_group TypeResource DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. -Idaws.shield.protection_group +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
protection_group_idstringThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
protection_group_arnstringThe ARN (Amazon Resource Name) of the protection group.
aggregationstringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.<br/>* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.<br/>* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.<br/>* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
patternstringThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
membersarrayThe Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
resource_typestringThe resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
tagsarrayOne or more tag key-value pairs for the Protection object.
regionstringAWS region.
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.<br/>* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.<br/>* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.<br/>* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual protection_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/shield/protection_groups/index.md b/docs/aws-docs/providers/aws/shield/protection_groups/index.md index 2d1ab8f398..74919c3097 100644 --- a/docs/aws-docs/providers/aws/shield/protection_groups/index.md +++ b/docs/aws-docs/providers/aws/shield/protection_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of protection_groups in a region or create a protection_groups resource, use protection_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of protection_groups in a region or create Nameprotection_groups TypeResource DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. -Idaws.shield.protection_groups +Id ## Fields - - + +
NameDatatypeDescription
protection_group_arnstringThe ARN (Amazon Resource Name) of the protection group.
regionstringAWS region.
stringThe ARN (Amazon Resource Name) of the protection group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of protection_groups in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/shield/protections/index.md b/docs/aws-docs/providers/aws/shield/protections/index.md index 389dc12219..01d0e29553 100644 --- a/docs/aws-docs/providers/aws/shield/protections/index.md +++ b/docs/aws-docs/providers/aws/shield/protections/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of protections in a region or create a protections resource, use protection to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of protections in a region or create a Nameprotections TypeResource DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses. -Idaws.shield.protections +Id ## Fields - - + +
NameDatatypeDescription
protection_arnstringThe ARN (Amazon Resource Name) of the protection.
regionstringAWS region.
stringThe ARN (Amazon Resource Name) of the protection.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of protections in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/signer/profile_permission/index.md b/docs/aws-docs/providers/aws/signer/profile_permission/index.md index 4ab8a14069..a0ea5768d5 100644 --- a/docs/aws-docs/providers/aws/signer/profile_permission/index.md +++ b/docs/aws-docs/providers/aws/signer/profile_permission/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual profile_permission resource, use profile_permissions to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual profile_permission resource, use Nameprofile_permission TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.signer.profile_permission +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
profile_namestring
profile_versionstring
actionstring
principalstring
statement_idstring
regionstringAWS region.
string
string
string
string
string
stringAWS region.
@@ -45,14 +48,14 @@ Gets or operates on an individual profile_permission resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/signer/profile_permissions/index.md b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md index 6f301df066..dccf72bd08 100644 --- a/docs/aws-docs/providers/aws/signer/profile_permissions/index.md +++ b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of profile_permissions in a region or create a profile_permissions resource, use profile_permission to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of profile_permissions in a region or creat Nameprofile_permissions TypeResource DescriptionAn example resource schema demonstrating some basic constructs and validation rules. -Idaws.signer.profile_permissions +Id ## Fields - - - + + +
NameDatatypeDescription
statement_idstring
profile_namestring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of profile_permissions in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/signer/signing_profile/index.md b/docs/aws-docs/providers/aws/signer/signing_profile/index.md index 8c6dab7261..679c7c1a89 100644 --- a/docs/aws-docs/providers/aws/signer/signing_profile/index.md +++ b/docs/aws-docs/providers/aws/signer/signing_profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual signing_profile resource, use signing_profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual signing_profile resource, use Namesigning_profile TypeResource DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job. -Idaws.signer.signing_profile +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
profile_namestringA name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
profile_versionstringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
arnstringThe Amazon Resource Name (ARN) of the specified signing profile.
profile_version_arnstringThe Amazon Resource Name (ARN) of the specified signing profile version.
signature_validity_periodobjectSignature validity period of the profile.
platform_idstringThe ID of the target signing platform.
tagsarrayA list of tags associated with the signing profile.
regionstringAWS region.
stringA name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
stringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringThe Amazon Resource Name (ARN) of the specified signing profile version.
objectSignature validity period of the profile.
stringThe ID of the target signing platform.
arrayA list of tags associated with the signing profile.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual signing_profile resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/signer/signing_profiles/index.md b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md index ea84f1a424..05328706f8 100644 --- a/docs/aws-docs/providers/aws/signer/signing_profiles/index.md +++ b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of signing_profiles in a region or create a signing_profiles resource, use signing_profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of signing_profiles in a region or create a Namesigning_profiles TypeResource DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job. -Idaws.signer.signing_profiles +Id ## Fields - - + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the specified signing profile.
regionstringAWS region.
undefinedThe Amazon Resource Name (ARN) of the specified signing profile.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of signing_profiles in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md index feb8041cc6..35fb9f8170 100644 --- a/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual simulation resource, use simulations to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual simulation resource, use si Namesimulation TypeResource DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation. -Idaws.simspaceweaver.simulation +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
namestringThe name of the simulation.
role_arnstringRole ARN.
schema_s3_locationobject
describe_payloadstringJson object with all simulation details
maximum_durationstringThe maximum running time of the simulation.
snapshot_s3_locationobject
regionstringAWS region.
stringThe name of the simulation.
stringRole ARN.
object
stringJson object with all simulation details
stringThe maximum running time of the simulation.
object
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual simulation resource, use si Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md index e7190f919b..f47fe657aa 100644 --- a/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of simulations in a region or create a simulations resource, use simulation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of simulations in a region or create a Namesimulations TypeResource DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation. -Idaws.simspaceweaver.simulations +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the simulation.
regionstringAWS region.
stringThe name of the simulation.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of simulations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sns/topic/index.md b/docs/aws-docs/providers/aws/sns/topic/index.md index 2cf3f85ad2..d5aacccb37 100644 --- a/docs/aws-docs/providers/aws/sns/topic/index.md +++ b/docs/aws-docs/providers/aws/sns/topic/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual topic resource, use topics to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual topic resource, use topics< Nametopic TypeResource DescriptionThe ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.<br/> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.<br/> The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*. -Idaws.sns.topic +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
display_namestringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
kms_master_key_idstringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.<br/> This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
data_protection_policyobjectThe body of the policy document you want to use for this topic.<br/> You can only add one policy per topic.<br/> The policy must be in JSON string format.<br/> Length Constraints: Maximum length of 30,720.
subscriptionarrayThe SNS subscriptions (endpoints) for this topic.<br/> If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.
fifo_topicbooleanSet to true to create a FIFO topic.
content_based_deduplicationbooleanEnables content-based deduplication for FIFO topics.<br/> + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. <br/> + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).<br/> (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.
archive_policyobjectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
tagsarrayThe list of tags to add to a new topic.<br/> To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.
topic_namestringThe name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
topic_arnstring
signature_versionstringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.
tracing_configstringTracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
delivery_status_loggingarray
regionstringAWS region.
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*.<br/> 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.<br/> You can only add one policy per topic.<br/> The policy must be in JSON string format.<br/> Length Constraints: Maximum length of 30,720.
arrayThe SNS subscriptions (endpoints) for this topic.<br/> If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.
booleanSet to true to create a FIFO topic.
booleanEnables content-based deduplication for FIFO topics.<br/> + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. <br/> + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).<br/> (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.
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.<br/> 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``.<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.
stringTracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual topic resource, use topics< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md index 8a74a1fdc1..e64da08b2c 100644 --- a/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md +++ b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of topic_inline_policies in a region or create a topic_inline_policies resource, use topic_inline_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of topic_inline_policies in a region or cre Nametopic_inline_policies TypeResource DescriptionSchema for AWS::SNS::TopicInlinePolicy -Idaws.sns.topic_inline_policies +Id ## Fields - - + +
NameDatatypeDescription
topic_arnstringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of topic_inline_policies in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md b/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md index ae55465046..523f4821a4 100644 --- a/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md +++ b/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual topic_inline_policy resource, use topic_inline_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual topic_inline_policy resource, use Nametopic_inline_policy TypeResource DescriptionSchema for AWS::SNS::TopicInlinePolicy -Idaws.sns.topic_inline_policy +Id ## Fields - - - + + +
NameDatatypeDescription
policy_documentobjectA policy document that contains permissions to add to the specified SNS topics.
topic_arnstringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual topic_inline_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sns/topics/index.md b/docs/aws-docs/providers/aws/sns/topics/index.md index fdcff3b291..40fa072f1d 100644 --- a/docs/aws-docs/providers/aws/sns/topics/index.md +++ b/docs/aws-docs/providers/aws/sns/topics/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of topics in a region or create a topics resource, use topic to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of topics in a region or create a top Nametopics TypeResource DescriptionThe ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.<br/> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.<br/> The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*. -Idaws.sns.topics +Id ## Fields - - + +
NameDatatypeDescription
topic_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of topics in a region or create a top Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sqs/queue/index.md b/docs/aws-docs/providers/aws/sqs/queue/index.md index 3cb211195e..29c11c6247 100644 --- a/docs/aws-docs/providers/aws/sqs/queue/index.md +++ b/docs/aws-docs/providers/aws/sqs/queue/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue resource, use queues to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual queue resource, use queues< Namequeue TypeResource DescriptionThe ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.<br/> Keep the following caveats in mind:<br/> + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.<br/> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. <br/> + If you don't provide a value for a property, the queue is created with the default value for the property.<br/> + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.<br/> + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.<br/> <br/> For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*. -Idaws.sqs.queue +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
queue_urlstring
arnstring
content_based_deduplicationbooleanFor first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.
deduplication_scopestringFor high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
delay_secondsintegerThe time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.
fifo_queuebooleanIf set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
fifo_throughput_limitstringFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
kms_data_key_reuse_period_secondsintegerThe length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).<br/> A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
kms_master_key_idstringThe ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:<br/> + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* <br/> + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* <br/> + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* <br/> + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
sqs_managed_sse_enabledbooleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.
maximum_message_sizeintegerThe limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).
message_retention_periodintegerThe number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).
queue_namestringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
receive_message_wait_time_secondsintegerSpecifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
redrive_allow_policyobjectThe string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:<br/> + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:<br/> + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.<br/> + ``denyAll``: No source queues can specify this queue as the dead-letter queue.<br/> + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.<br/> <br/> + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.
redrive_policyobjectThe string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:<br/> + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.<br/> + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.<br/> <br/> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.<br/> *JSON* <br/> ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` <br/> *YAML* <br/> ``deadLetterTargetArn : String`` <br/> ``maxReceiveCount : Integer``
tagsarrayThe tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
visibility_timeoutintegerThe length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.<br/> Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.<br/> For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
regionstringAWS region.
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``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
integerThe time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.
booleanIf set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
stringFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
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).<br/> A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
stringThe ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:<br/> + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* <br/> + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* <br/> + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* <br/> + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
booleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.
integerThe limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).
integerThe number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).
stringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. <br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
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:<br/> + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:<br/> + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.<br/> + ``denyAll``: No source queues can specify this queue as the dead-letter queue.<br/> + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.<br/> <br/> + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.
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:<br/> + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.<br/> + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.<br/> <br/> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.<br/> *JSON* <br/> ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` <br/> *YAML* <br/> ``deadLetterTargetArn : String`` <br/> ``maxReceiveCount : Integer``
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.<br/> Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.<br/> For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
stringAWS region.
@@ -58,19 +61,19 @@ Gets or operates on an individual queue resource, use queues< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md index 9b617cf7e3..c8f747fdac 100644 --- a/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md +++ b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queue_inline_policies in a region or create a queue_inline_policies resource, use queue_inline_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of queue_inline_policies in a region or cre Namequeue_inline_policies TypeResource DescriptionSchema for SQS QueueInlinePolicy -Idaws.sqs.queue_inline_policies +Id ## Fields - - + +
NameDatatypeDescription
queuestringThe URL of the SQS queue.
regionstringAWS region.
stringThe URL of the SQS queue.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of queue_inline_policies in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md b/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md index ca031edd79..f8580d84c5 100644 --- a/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md +++ b/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual queue_inline_policy resource, use queue_inline_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual queue_inline_policy resource, use Namequeue_inline_policy TypeResource DescriptionSchema for SQS QueueInlinePolicy -Idaws.sqs.queue_inline_policy +Id ## Fields - - - + + +
NameDatatypeDescription
policy_documentobjectA policy document that contains permissions to add to the specified SQS queue
queuestringThe URL of the SQS queue.
regionstringAWS region.
objectA policy document that contains permissions to add to the specified SQS queue
stringThe URL of the SQS queue.
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual queue_inline_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sqs/queues/index.md b/docs/aws-docs/providers/aws/sqs/queues/index.md index 45378ecbc3..40b3693c3e 100644 --- a/docs/aws-docs/providers/aws/sqs/queues/index.md +++ b/docs/aws-docs/providers/aws/sqs/queues/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of queues in a region or create a queues resource, use queue to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of queues in a region or create a que Namequeues TypeResource DescriptionThe ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.<br/> Keep the following caveats in mind:<br/> + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.<br/> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. <br/> + If you don't provide a value for a property, the queue is created with the default value for the property.<br/> + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.<br/> + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.<br/> <br/> For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*. -Idaws.sqs.queues +Id ## Fields - - + +
NameDatatypeDescription
queue_urlstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of queues in a region or create a que Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/association/index.md b/docs/aws-docs/providers/aws/ssm/association/index.md index 60a5b5031d..cb6b1c5389 100644 --- a/docs/aws-docs/providers/aws/ssm/association/index.md +++ b/docs/aws-docs/providers/aws/ssm/association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual association resource, use associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,31 +24,31 @@ Gets or operates on an individual association resource, use a Nameassociation TypeResource DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document. -Idaws.ssm.association +Id ## Fields - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
association_namestringThe name of the association.
calendar_namesarray
schedule_expressionstringA Cron or Rate expression that specifies when the association is applied to the target.
max_errorsstring
parametersobjectParameter values that the SSM document uses at runtime.
instance_idstringThe ID of the instance that the SSM document is associated with.
wait_for_success_timeout_secondsinteger
max_concurrencystring
compliance_severitystring
targetsarrayThe targets that the SSM document sends commands to.
sync_compliancestring
output_locationobject
schedule_offsetinteger
namestringThe name of the SSM document.
apply_only_at_cron_intervalboolean
document_versionstringThe version of the SSM document to associate with the target.
association_idstringUnique identifier of the association.
automation_target_parameter_namestring
regionstringAWS region.
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.
@@ -58,19 +61,19 @@ Gets or operates on an individual association resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssm/associations/index.md b/docs/aws-docs/providers/aws/ssm/associations/index.md index 7f9066e85b..4c2ad6c3b0 100644 --- a/docs/aws-docs/providers/aws/ssm/associations/index.md +++ b/docs/aws-docs/providers/aws/ssm/associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of associations in a region or create a associations resource, use association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of associations in a region or create a Nameassociations TypeResource DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document. -Idaws.ssm.associations +Id ## Fields - - + +
NameDatatypeDescription
association_idstringUnique identifier of the association.
regionstringAWS region.
stringUnique identifier of the association.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of associations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/document/index.md b/docs/aws-docs/providers/aws/ssm/document/index.md index 0b20588546..3c10d3077c 100644 --- a/docs/aws-docs/providers/aws/ssm/document/index.md +++ b/docs/aws-docs/providers/aws/ssm/document/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual document resource, use documents to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual document resource, use docu Namedocument TypeResource DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances. -Idaws.ssm.document +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
contentobjectThe content for the Systems Manager document in JSON, YAML or String format.
attachmentsarrayA list of key and value pairs that describe attachments to a version of a document.
namestringA name for the Systems Manager document.
version_namestringAn optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
document_typestringThe type of document to create.
document_formatstringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
target_typestringSpecify a target type to define the kinds of resources the document can run on.
tagsarrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
requiresarrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
update_methodstringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual document resource, use docu Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssm/documents/index.md b/docs/aws-docs/providers/aws/ssm/documents/index.md index 6fd6faefed..aa27f8864d 100644 --- a/docs/aws-docs/providers/aws/ssm/documents/index.md +++ b/docs/aws-docs/providers/aws/ssm/documents/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of documents in a region or create a documents resource, use document to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of documents in a region or create a Namedocuments TypeResource DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances. -Idaws.ssm.documents +Id ## Fields - - + +
NameDatatypeDescription
namestringA name for the Systems Manager document.
regionstringAWS region.
stringA name for the Systems Manager document.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of documents in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/parameter/index.md b/docs/aws-docs/providers/aws/ssm/parameter/index.md index fca6fad4eb..3dbd841283 100644 --- a/docs/aws-docs/providers/aws/ssm/parameter/index.md +++ b/docs/aws-docs/providers/aws/ssm/parameter/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual parameter resource, use parameters to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual parameter resource, use par Nameparameter TypeResource DescriptionThe ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.<br/> To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.<br/> To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.<br/> For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*. -Idaws.ssm.parameter +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
typestringThe type of parameter.
valuestringThe parameter value.<br/> If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.
descriptionstringInformation about the parameter.
policiesstringInformation about the policies assigned to a parameter.<br/> [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
allowed_patternstringA regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$``
tierstringThe parameter tier.
tagsobjectOptional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
data_typestringThe data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.
namestringThe name of the parameter.<br/> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
regionstringAWS region.
stringThe type of parameter.
stringThe parameter value.<br/> 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.<br/> [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.<br/> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual parameter resource, use par Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssm/parameters/index.md b/docs/aws-docs/providers/aws/ssm/parameters/index.md index 6047d0b2a6..90676fb4f1 100644 --- a/docs/aws-docs/providers/aws/ssm/parameters/index.md +++ b/docs/aws-docs/providers/aws/ssm/parameters/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of parameters in a region or create a parameters resource, use parameter to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of parameters in a region or create a Nameparameters TypeResource DescriptionThe ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.<br/> To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.<br/> To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.<br/> For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*. -Idaws.ssm.parameters +Id ## Fields - - + +
NameDatatypeDescription
namestringThe name of the parameter.<br/> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
regionstringAWS region.
stringThe name of the parameter.<br/> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of parameters in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md b/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md index 24b7394e71..9163bb026c 100644 --- a/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md +++ b/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual patch_baseline resource, use patch_baselines to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual patch_baseline resource, use Namepatch_baseline TypeResource DescriptionResource Type definition for AWS::SSM::PatchBaseline -Idaws.ssm.patch_baseline +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe ID of the patch baseline.
default_baselinebooleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
operating_systemstringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
descriptionstringThe description of the patch baseline.
approval_rulesobject
sourcesarrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
namestringThe name of the patch baseline.
rejected_patchesarrayA list of explicitly rejected patches for the baseline.
approved_patchesarrayA list of explicitly approved patches for the baseline.
rejected_patches_actionstringThe action for Patch Manager to take on patches included in the RejectedPackages list.
patch_groupsarrayPatchGroups is used to associate instances with a specific patch baseline
approved_patches_compliance_levelstringDefines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
approved_patches_enable_non_securitybooleanIndicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
global_filtersobjectA set of global filters used to include patches in the baseline.
tagsarrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.
regionstringAWS region.
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.
object
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual patch_baseline resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md index 4fc5d8cb65..0ed8afd052 100644 --- a/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md +++ b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of patch_baselines in a region or create a patch_baselines resource, use patch_baseline to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of patch_baselines in a region or create a Namepatch_baselines TypeResource DescriptionResource Type definition for AWS::SSM::PatchBaseline -Idaws.ssm.patch_baselines +Id ## Fields - - + +
NameDatatypeDescription
idstringThe ID of the patch baseline.
regionstringAWS region.
stringThe ID of the patch baseline.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of patch_baselines in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md index 8f49e5f5f7..f0854c4bdc 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_data_sync resource, use resource_data_syncs to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual resource_data_sync resource, use Nameresource_data_sync TypeResource DescriptionResource Type definition for AWS::SSM::ResourceDataSync -Idaws.ssm.resource_data_sync +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
s3_destinationobject
kms_key_arnstring
sync_sourceobject
bucket_namestring
bucket_regionstring
sync_formatstring
sync_namestring
sync_typestring
bucket_prefixstring
regionstringAWS region.
object
string
object
string
string
string
string
string
string
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual resource_data_sync resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md index 4c65ccdbcf..836d1f6be8 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_data_syncs in a region or create a resource_data_syncs resource, use resource_data_sync to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_data_syncs in a region or creat Nameresource_data_syncs TypeResource DescriptionResource Type definition for AWS::SSM::ResourceDataSync -Idaws.ssm.resource_data_syncs +Id ## Fields - - + +
NameDatatypeDescription
sync_namestring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_data_syncs in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/resource_policies/index.md b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md index f84dee83bd..5f183e11bb 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionResource Type definition for AWS::SSM::ResourcePolicy -Idaws.ssm.resource_policies +Id ## Fields - - - + + +
NameDatatypeDescription
policy_idstringAn unique identifier within the policies of a resource.
resource_arnstringArn of OpsItemGroup etc.
regionstringAWS region.
stringAn unique identifier within the policies of a resource.
stringArn of OpsItemGroup etc.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssm/resource_policy/index.md b/docs/aws-docs/providers/aws/ssm/resource_policy/index.md index 619963046d..a73b107491 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionResource Type definition for AWS::SSM::ResourcePolicy -Idaws.ssm.resource_policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
resource_arnstringArn of OpsItemGroup etc.
policyobjectActual policy statement.
policy_idstringAn unique identifier within the policies of a resource.
policy_hashstringA snapshot identifier for the policy over time.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md index 6b75ddeede..64f9a80cc2 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual contact resource, use contacts to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual contact resource, use conta Namecontact TypeResource DescriptionResource Type definition for AWS::SSMContacts::Contact -Idaws.ssmcontacts.contact +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
aliasstringAlias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
display_namestringName of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
typestringContact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“.
planarrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual contact resource, use conta Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md index bd30771d31..f904127222 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual contact_channel resource, use contact_channels to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual contact_channel resource, use Namecontact_channel TypeResource DescriptionResource Type definition for AWS::SSMContacts::ContactChannel -Idaws.ssmcontacts.contact_channel +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
contact_idstringARN of the contact resource
channel_namestringThe device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
channel_typestringDevice type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.
defer_activationbooleanIf you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
channel_addressstringThe details that SSM Incident Manager uses when trying to engage the contact channel.
arnstringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual contact_channel resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md index b6284d6ac0..9233c8a743 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of contact_channels in a region or create a contact_channels resource, use contact_channel to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of contact_channels in a region or create a Namecontact_channels TypeResource DescriptionResource Type definition for AWS::SSMContacts::ContactChannel -Idaws.ssmcontacts.contact_channels +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of contact_channels in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md index bf5bac88f9..9b9ea8ad40 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of contacts in a region or create a contacts resource, use contact to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of contacts in a region or create a c Namecontacts TypeResource DescriptionResource Type definition for AWS::SSMContacts::Contact -Idaws.ssmcontacts.contacts +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of contacts in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md b/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md index 3514ea3e56..16ad1e4cfb 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual plan resource, use plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual plan resource, use plansNameplan TypeResource DescriptionEngagement Plan for a SSM Incident Manager Contact. -Idaws.ssmcontacts.plan +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
contact_idstringContact ID for the AWS SSM Incident Manager Contact to associate the plan.
stagesarrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
rotation_idsarrayRotation Ids to associate with Oncall Contact for engagement.
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual plan resource, use plansRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md index 504f2c550e..d60256da18 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of plans in a region or create a plans resource, use plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of plans in a region or create a plan Nameplans TypeResource DescriptionEngagement Plan for a SSM Incident Manager Contact. -Idaws.ssmcontacts.plans +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of plans in a region or create a plan Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md index 72852723c6..dee870705d 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rotation resource, use rotations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual rotation resource, use rota Namerotation TypeResource DescriptionResource Type definition for AWS::SSMContacts::Rotation. -Idaws.ssmcontacts.rotation +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
namestringName of the Rotation
contact_idsarrayMembers of the rotation
start_timestringStart time of the first shift of Oncall Schedule
time_zone_idstringTimeZone Identifier for the Oncall Schedule
recurrenceobject
tagsarray
arnstringThe Amazon Resource Name (ARN) of the rotation.
regionstringAWS region.
stringName of the Rotation
arrayMembers of the rotation
stringStart time of the first shift of Oncall Schedule
stringTimeZone Identifier for the Oncall Schedule
object
array
stringThe Amazon Resource Name (ARN) of the rotation.
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual rotation resource, use rota Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md index 697fa2fd0d..27f10320f4 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rotations in a region or create a rotations resource, use rotation to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rotations in a region or create a Namerotations TypeResource DescriptionResource Type definition for AWS::SSMContacts::Rotation. -Idaws.ssmcontacts.rotations +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the rotation.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the rotation.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rotations in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md index 8e601514ee..c2080ff9a2 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual replication_set resource, use replication_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual replication_set resource, use Namereplication_set TypeResource DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet -Idaws.ssmincidents.replication_set +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstringThe ARN of the ReplicationSet.
regionsarrayThe ReplicationSet configuration.
deletion_protectedboolean
tagsarrayThe tags to apply to the replication set.
regionstringAWS region.
stringThe ARN of the ReplicationSet.
arrayThe ReplicationSet configuration.
boolean
arrayThe tags to apply to the replication set.
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual replication_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md index 0821bb913b..10e5a029bb 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of replication_sets in a region or create a replication_sets resource, use replication_set to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of replication_sets in a region or create a Namereplication_sets TypeResource DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet -Idaws.ssmincidents.replication_sets +Id ## Fields - - + +
NameDatatypeDescription
arnundefinedThe ARN of the ReplicationSet.
regionstringAWS region.
undefinedThe ARN of the ReplicationSet.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of replication_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md index 304f84b970..eeb24568a9 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual response_plan resource, use response_plans to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual response_plan resource, use Nameresponse_plan TypeResource DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan -Idaws.ssmincidents.response_plan +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the response plan.
namestringThe name of the response plan.
display_namestringThe display name of the response plan.
chat_channelobject
engagementsarrayThe list of engagements to use.
actionsarrayThe list of actions.
integrationsarrayThe list of integrations.
tagsarrayThe tags to apply to the response plan.
incident_templateobject
regionstringAWS region.
stringThe ARN of the response plan.
stringThe name of the response plan.
stringThe display name of the response plan.
object
arrayThe list of engagements to use.
arrayThe list of actions.
arrayThe list of integrations.
arrayThe tags to apply to the response plan.
object
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual response_plan resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md index bcbd60b8ac..4ef2a94aee 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of response_plans in a region or create a response_plans resource, use response_plan to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of response_plans in a region or create a < Nameresponse_plans TypeResource DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan -Idaws.ssmincidents.response_plans +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the response plan.
regionstringAWS region.
stringThe ARN of the response plan.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of response_plans in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sso/assignment/index.md b/docs/aws-docs/providers/aws/sso/assignment/index.md index 7c7a11018b..b07019eb2a 100644 --- a/docs/aws-docs/providers/aws/sso/assignment/index.md +++ b/docs/aws-docs/providers/aws/sso/assignment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assignment resource, use assignments to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual assignment resource, use as Nameassignment TypeResource DescriptionResource Type definition for SSO assignmet -Idaws.sso.assignment +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
instance_arnstringThe sso instance that the permission set is owned.
target_idstringThe account id to be provisioned.
target_typestringThe type of resource to be provsioned to, only aws account now
permission_set_arnstringThe permission set that the assignemt will be assigned
principal_typestringThe assignee's type, user/group
principal_idstringThe assignee's identifier, user id/group id
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Gets or operates on an individual assignment resource, use as Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sso/assignments/index.md b/docs/aws-docs/providers/aws/sso/assignments/index.md index fb0a182dfc..a42b8af2bb 100644 --- a/docs/aws-docs/providers/aws/sso/assignments/index.md +++ b/docs/aws-docs/providers/aws/sso/assignments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assignments in a region or create a assignments resource, use assignment to operate on an individual resource. ## Overview @@ -21,19 +24,19 @@ Used to retrieve a list of assignments in a region or create a Nameassignments TypeResource DescriptionResource Type definition for SSO assignmet -Idaws.sso.assignments +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
instance_arnstringThe sso instance that the permission set is owned.
target_idstringThe account id to be provisioned.
target_typestringThe type of resource to be provsioned to, only aws account now
permission_set_arnstringThe permission set that the assignemt will be assigned
principal_typestringThe assignee's type, user/group
principal_idstringThe assignee's identifier, user id/group id
regionstringAWS region.
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.
@@ -46,14 +49,14 @@ Used to retrieve a list of assignments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md index 2748ad92ad..59a812e94e 100644 --- a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual instance_access_control_attribute_configuration resource, use instance_access_control_attribute_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual instance_access_control_attribute_config Nameinstance_access_control_attribute_configuration TypeResource DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration -Idaws.sso.instance_access_control_attribute_configuration +Id ## Fields - - - - + + + +
NameDatatypeDescription
instance_arnstringThe ARN of the AWS SSO instance under which the operation will be executed.
instance_access_control_attribute_configurationobjectThe InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.
access_control_attributesarray
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual instance_access_control_attribute_config Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md index ab2d162e0b..9618299fb4 100644 --- a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of instance_access_control_attribute_configurations in a region or create a instance_access_control_attribute_configurations resource, use instance_access_control_attribute_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of instance_access_control_attribute_configuration Nameinstance_access_control_attribute_configurations TypeResource DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration -Idaws.sso.instance_access_control_attribute_configurations +Id ## Fields - - + +
NameDatatypeDescription
instance_arnstringThe ARN of the AWS SSO instance under which the operation will be executed.
regionstringAWS region.
stringThe ARN of the AWS SSO instance under which the operation will be executed.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of instance_access_control_attribute_configuration Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/sso/permission_set/index.md b/docs/aws-docs/providers/aws/sso/permission_set/index.md index 5041fe5a1d..70d8d7635c 100644 --- a/docs/aws-docs/providers/aws/sso/permission_set/index.md +++ b/docs/aws-docs/providers/aws/sso/permission_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual permission_set resource, use permission_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual permission_set resource, use Namepermission_set TypeResource DescriptionResource Type definition for SSO PermissionSet -Idaws.sso.permission_set +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this permission set.
permission_set_arnstringThe permission set that the policy will be attached to
descriptionstringThe permission set description.
instance_arnstringThe sso instance arn that the permission set is owned.
session_durationstringThe length of time that a user can be signed in to an AWS account.
relay_state_typestringThe relay state URL that redirect links to any service in the AWS Management Console.
managed_policiesarray
inline_policyobjectThe inline policy to put in permission set.
tagsarray
customer_managed_policy_referencesarray
permissions_boundaryobject
regionstringAWS region.
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.
@@ -51,19 +54,19 @@ Gets or operates on an individual permission_set resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/sso/permission_sets/index.md b/docs/aws-docs/providers/aws/sso/permission_sets/index.md index 37a053519a..3768ba9df2 100644 --- a/docs/aws-docs/providers/aws/sso/permission_sets/index.md +++ b/docs/aws-docs/providers/aws/sso/permission_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of permission_sets in a region or create a permission_sets resource, use permission_set to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of permission_sets in a region or create a Namepermission_sets TypeResource DescriptionResource Type definition for SSO PermissionSet -Idaws.sso.permission_sets +Id ## Fields - - - + + +
NameDatatypeDescription
instance_arnstringThe sso instance arn that the permission set is owned.
permission_set_arnstringThe permission set that the policy will be attached to
regionstringAWS region.
stringThe sso instance arn that the permission set is owned.
stringThe permission set that the policy will be attached to
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of permission_sets in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activities/index.md b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md index 53d3c75331..27367e1561 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/activities/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of activities in a region or create a activities resource, use activity to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of activities in a region or create a Nameactivities TypeResource DescriptionResource schema for Activity -Idaws.stepfunctions.activities +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of activities in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activity/index.md b/docs/aws-docs/providers/aws/stepfunctions/activity/index.md index 405232e16f..5eb1b68a60 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/activity/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/activity/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual activity resource, use activities to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual activity resource, use acti Nameactivity TypeResource DescriptionResource schema for Activity -Idaws.stepfunctions.activity +Id ## Fields - - - - + + + +
NameDatatypeDescription
arnstring
namestring
tagsarray
regionstringAWS region.
string
string
array
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual activity resource, use acti Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md index f735aaeab8..04a760c2ad 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual state_machine resource, use state_machines to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual state_machine resource, use Namestate_machine TypeResource DescriptionResource schema for StateMachine -Idaws.stepfunctions.state_machine +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
definition_substitutionsobject
definitionobject
role_arnstring
namestring
state_machine_typestring
tracing_configurationobject
definition_stringstring
logging_configurationobject
state_machine_revision_idstring
definition_s3_locationobject
arnstring
state_machine_namestring
tagsarray
regionstringAWS region.
object
object
string
string
string
object
string
object
string
object
string
string
array
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual state_machine resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md index e20402a0a2..e214f63aa9 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual state_machine_alias resource, use state_machine_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual state_machine_alias resource, use Namestate_machine_alias TypeResource DescriptionResource schema for StateMachineAlias -Idaws.stepfunctions.state_machine_alias +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstringThe ARN of the alias.
namestringThe alias name.
descriptionstringAn optional description of the alias.
routing_configurationarray
deployment_preferenceobject
regionstringAWS region.
stringThe ARN of the alias.
stringThe alias name.
stringAn optional description of the alias.
array
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual state_machine_alias resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md index e1e732b0c5..45d77cdfcf 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of state_machine_aliases in a region or create a state_machine_aliases resource, use state_machine_alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of state_machine_aliases in a region or cre Namestate_machine_aliases TypeResource DescriptionResource schema for StateMachineAlias -Idaws.stepfunctions.state_machine_aliases +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the alias.
regionstringAWS region.
stringThe ARN of the alias.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of state_machine_aliases in a region or cre Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md index 456277124d..9bf82b7345 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual state_machine_version resource, use state_machine_versions to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual state_machine_version resource, u Namestate_machine_version TypeResource DescriptionResource schema for StateMachineVersion -Idaws.stepfunctions.state_machine_version +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstring
state_machine_arnstring
state_machine_revision_idstring
descriptionstring
regionstringAWS region.
string
string
string
string
stringAWS region.
@@ -44,14 +47,14 @@ Gets or operates on an individual state_machine_version resource, u Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md index c27543d768..08189210c9 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of state_machine_versions in a region or create a state_machine_versions resource, use state_machine_version to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of state_machine_versions in a region or cr Namestate_machine_versions TypeResource DescriptionResource schema for StateMachineVersion -Idaws.stepfunctions.state_machine_versions +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of state_machine_versions in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md index de6bb0aaa9..712c10e60f 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of state_machines in a region or create a state_machines resource, use state_machine to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of state_machines in a region or create a < Namestate_machines TypeResource DescriptionResource schema for StateMachine -Idaws.stepfunctions.state_machines +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of state_machines in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/supportapp/account_alias/index.md b/docs/aws-docs/providers/aws/supportapp/account_alias/index.md index 990a1950ae..f3e7e7d8fa 100644 --- a/docs/aws-docs/providers/aws/supportapp/account_alias/index.md +++ b/docs/aws-docs/providers/aws/supportapp/account_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual account_alias resource, use account_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual account_alias resource, use Nameaccount_alias TypeResource DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias. -Idaws.supportapp.account_alias +Id ## Fields - - - + + +
NameDatatypeDescription
account_aliasstringAn account alias associated with a customer's account.
account_alias_resource_idstringUnique identifier representing an alias tied to an account
regionstringAWS region.
stringAn account alias associated with a customer's account.
stringUnique identifier representing an alias tied to an account
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual account_alias resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md index 0ad75cc898..e5a970ebb8 100644 --- a/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md +++ b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of account_aliases in a region or create a account_aliases resource, use account_alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of account_aliases in a region or create a Nameaccount_aliases TypeResource DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias. -Idaws.supportapp.account_aliases +Id ## Fields - - + +
NameDatatypeDescription
account_alias_resource_idstringUnique identifier representing an alias tied to an account
regionstringAWS region.
stringUnique identifier representing an alias tied to an account
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of account_aliases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md index e10226c1e7..f8c096cbf7 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual slack_channel_configuration resource, use slack_channel_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual slack_channel_configuration resou Nameslack_channel_configuration TypeResource DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations. -Idaws.supportapp.slack_channel_configuration +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
channel_idstringThe channel ID in Slack, which identifies a channel within a workspace.
channel_namestringThe channel name in Slack.
notify_on_create_or_reopen_casebooleanWhether to notify when a case is created or reopened.
notify_on_add_correspondence_to_casebooleanWhether to notify when a correspondence is added to a case.
notify_on_resolve_casebooleanWhether to notify when a case is resolved.
notify_on_case_severitystringThe severity level of a support case that a customer wants to get notified for.
channel_role_arnstringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual slack_channel_configuration resou Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md index 354464bb55..6a3c29213c 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of slack_channel_configurations in a region or create a slack_channel_configurations resource, use slack_channel_configuration to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of slack_channel_configurations in a region Nameslack_channel_configurations TypeResource DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations. -Idaws.supportapp.slack_channel_configurations +Id ## Fields - - - + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
channel_idstringThe channel ID in Slack, which identifies a channel within a workspace.
regionstringAWS region.
stringThe team ID in Slack, which uniquely identifies a workspace.
stringThe channel ID in Slack, which identifies a channel within a workspace.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of slack_channel_configurations in a region Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md index 01a38c74f1..78ab5ff5aa 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual slack_workspace_configuration resource, use slack_workspace_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual slack_workspace_configuration res Nameslack_workspace_configuration TypeResource DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations. -Idaws.supportapp.slack_workspace_configuration +Id ## Fields - - - + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
version_idstringAn identifier used to update an existing Slack workspace configuration in AWS CloudFormation.
regionstringAWS region.
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.
@@ -42,19 +45,19 @@ Gets or operates on an individual slack_workspace_configuration res Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md index 6c50da81cf..5e0269a38c 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of slack_workspace_configurations in a region or create a slack_workspace_configurations resource, use slack_workspace_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of slack_workspace_configurations in a regi Nameslack_workspace_configurations TypeResource DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations. -Idaws.supportapp.slack_workspace_configurations +Id ## Fields - - + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
regionstringAWS region.
stringThe team ID in Slack, which uniquely identifies a workspace.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of slack_workspace_configurations in a regi Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/synthetics/canaries/index.md b/docs/aws-docs/providers/aws/synthetics/canaries/index.md index 547705169c..ad2f8464d6 100644 --- a/docs/aws-docs/providers/aws/synthetics/canaries/index.md +++ b/docs/aws-docs/providers/aws/synthetics/canaries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of canaries in a region or create a canaries resource, use canary to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of canaries in a region or create a c Namecanaries TypeResource DescriptionResource Type definition for AWS::Synthetics::Canary -Idaws.synthetics.canaries +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the canary.
regionstringAWS region.
stringName of the canary.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of canaries in a region or create a c Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/synthetics/canary/index.md b/docs/aws-docs/providers/aws/synthetics/canary/index.md index c07135c356..1b39c54005 100644 --- a/docs/aws-docs/providers/aws/synthetics/canary/index.md +++ b/docs/aws-docs/providers/aws/synthetics/canary/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual canary resource, use canaries to retrieve a list of resources or to create a resource. ## Overview @@ -21,30 +24,30 @@ Gets or operates on an individual canary resource, use canari Namecanary TypeResource DescriptionResource Type definition for AWS::Synthetics::Canary -Idaws.synthetics.canary +Id ## Fields - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the canary.
idstringId of the canary
statestringState of the canary
codeobjectProvide the canary script source
artifact_s3_locationstringProvide the s3 bucket output location for test results
artifact_configobjectProvide artifact configuration
scheduleobjectFrequency to run your canaries
execution_role_arnstringLambda Execution role used to run your canaries
runtime_versionstringRuntime version of Synthetics Library
success_retention_periodintegerRetention period of successful canary runs represented in number of days
failure_retention_periodintegerRetention period of failed canary runs represented in number of days
tagsarray
vpc_configobjectProvide VPC Configuration if enabled.
run_configobjectProvide canary run configuration
start_canary_after_creationbooleanRuns canary if set to True. Default is False
visual_referenceobjectVisual reference configuration for visual testing
delete_lambda_resources_on_canary_deletionbooleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
regionstringAWS region.
stringName of the canary.
stringId of the canary
stringState of the canary
objectProvide the canary script source
stringProvide the s3 bucket output location for test results
objectProvide artifact configuration
objectFrequency to run your canaries
stringLambda Execution role used to run your canaries
stringRuntime version of Synthetics Library
integerRetention period of successful canary runs represented in number of days
integerRetention period of failed canary runs represented in number of days
array
objectProvide VPC Configuration if enabled.
objectProvide canary run configuration
booleanRuns canary if set to True. Default is False
objectVisual reference configuration for visual testing
booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
stringAWS region.
@@ -57,19 +60,19 @@ Gets or operates on an individual canary resource, use canari Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/synthetics/group/index.md b/docs/aws-docs/providers/aws/synthetics/group/index.md index 947cc8d4f0..7578cae850 100644 --- a/docs/aws-docs/providers/aws/synthetics/group/index.md +++ b/docs/aws-docs/providers/aws/synthetics/group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group resource, use groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual group resource, use groups< Namegroup TypeResource DescriptionResource Type definition for AWS::Synthetics::Group -Idaws.synthetics.group +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
namestringName of the group.
idstringId of the group.
tagsarray
resource_arnsarray
regionstringAWS region.
stringName of the group.
stringId of the group.
array
array
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual group resource, use groups< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/synthetics/groups/index.md b/docs/aws-docs/providers/aws/synthetics/groups/index.md index 2ef028e1b1..19bcb8b55f 100644 --- a/docs/aws-docs/providers/aws/synthetics/groups/index.md +++ b/docs/aws-docs/providers/aws/synthetics/groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of groups in a region or create a gro Namegroups TypeResource DescriptionResource Type definition for AWS::Synthetics::Group -Idaws.synthetics.groups +Id ## Fields - - + +
NameDatatypeDescription
namestringName of the group.
regionstringAWS region.
stringName of the group.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of groups in a region or create a gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md index 726d9ee3d1..22739b2f57 100644 --- a/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md +++ b/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual application resource, use applications to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual application resource, use a Nameapplication TypeResource DescriptionResource schema for AWS::SystemsManagerSAP::Application -Idaws.systemsmanagersap.application +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
application_idstring
application_typestring
arnstringThe ARN of the Helix application
credentialsarray
instancesarray
sap_instance_numberstring
sidstring
tagsarrayThe tags of a SystemsManagerSAP application.
regionstringAWS region.
string
string
stringThe ARN of the Helix application
array
array
string
string
arrayThe tags of a SystemsManagerSAP application.
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual application resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md index bb45c04d35..b7e7fd5848 100644 --- a/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md +++ b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of applications in a region or create a applications resource, use application to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of applications in a region or create a Nameapplications TypeResource DescriptionResource schema for AWS::SystemsManagerSAP::Application -Idaws.systemsmanagersap.applications +Id ## Fields - - + +
NameDatatypeDescription
arnstringThe ARN of the Helix application
regionstringAWS region.
stringThe ARN of the Helix application
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of applications in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/timestream/database/index.md b/docs/aws-docs/providers/aws/timestream/database/index.md index 4f8ef7a860..2acf2d2a97 100644 --- a/docs/aws-docs/providers/aws/timestream/database/index.md +++ b/docs/aws-docs/providers/aws/timestream/database/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual database resource, use databases to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual database resource, use data Namedatabase TypeResource DescriptionThe AWS::Timestream::Database resource creates a Timestream database. -Idaws.timestream.database +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
arnstring
database_namestringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
kms_key_idstringThe KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -44,19 +47,19 @@ Gets or operates on an individual database resource, use data Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/timestream/databases/index.md b/docs/aws-docs/providers/aws/timestream/databases/index.md index 639657bc84..a862dda10d 100644 --- a/docs/aws-docs/providers/aws/timestream/databases/index.md +++ b/docs/aws-docs/providers/aws/timestream/databases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of databases in a region or create a databases resource, use database to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of databases in a region or create a Namedatabases TypeResource DescriptionThe AWS::Timestream::Database resource creates a Timestream database. -Idaws.timestream.databases +Id ## Fields - - + +
NameDatatypeDescription
database_namestringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
regionstringAWS region.
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.
@@ -41,14 +44,14 @@ Used to retrieve a list of databases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md index 76380de5e4..ffd91b9b93 100644 --- a/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual influxdb_instance resource, use influxdb_instances to retrieve a list of resources or to create a resource. ## Overview @@ -21,35 +24,35 @@ Gets or operates on an individual influxdb_instance resource, use < Nameinfluxdb_instance TypeResource DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance. -Idaws.timestream.influxdb_instance +Id ## Fields - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
usernamestringThe username for the InfluxDB instance.
passwordstringThe password for the InfluxDB instance.
organizationstringThe organization for the InfluxDB instance.
bucketstringThe bucket for the InfluxDB instance.
db_instance_typestringThe compute instance of the InfluxDB instance.
vpc_subnet_idsarrayA list of EC2 subnet IDs for this InfluxDB instance.
vpc_security_group_idsarrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
publicly_accessiblebooleanAttach a public IP to the customer ENI.
db_storage_typestringThe storage type of the InfluxDB instance.
allocated_storageintegerThe allocated storage for the InfluxDB instance.
db_parameter_group_identifierstringThe name of an existing InfluxDB parameter group.
log_delivery_configurationobjectConfiguration for sending logs to customer account from the InfluxDB instance.
statusstringStatus of the InfluxDB Instance.
arnstringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
namestringThe unique name that is associated with the InfluxDB instance.
availability_zonestringThe Availability Zone (AZ) where the InfluxDB instance is created.
secondary_availability_zonestringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
endpointstringThe connection endpoint for the InfluxDB instance.
influx_auth_parameters_secret_arnstringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
idstringThe service generated unique identifier for InfluxDB instance.
deployment_typestringDeployment type of the InfluxDB Instance.
tagsarrayAn arbitrary set of tags (key-value pairs) for this DB instance.
regionstringAWS region.
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.
@@ -62,19 +65,19 @@ Gets or operates on an individual influxdb_instance resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md index da0b9368b7..7cccd78dc0 100644 --- a/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of influxdb_instances in a region or create a influxdb_instances resource, use influxdb_instance to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of influxdb_instances in a region or create Nameinfluxdb_instances TypeResource DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance. -Idaws.timestream.influxdb_instances +Id ## Fields - - + +
NameDatatypeDescription
idstringThe service generated unique identifier for InfluxDB instance.
regionstringAWS region.
stringThe service generated unique identifier for InfluxDB instance.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of influxdb_instances in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md index 4f1a0ed392..2aa41a3f4d 100644 --- a/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md +++ b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of scheduled_queries in a region or create a scheduled_queries resource, use scheduled_query to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of scheduled_queries in a region or create Namescheduled_queries TypeResource DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query. -Idaws.timestream.scheduled_queries +Id ## Fields - - + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of scheduled_queries in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md index fc802e21ef..54a4173dee 100644 --- a/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md +++ b/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual scheduled_query resource, use scheduled_queries to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual scheduled_query resource, use Namescheduled_query TypeResource DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query. -Idaws.timestream.scheduled_query +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
scheduled_query_namestring
query_stringstring
schedule_configurationobject
notification_configurationobject
client_tokenstring
scheduled_query_execution_role_arnstring
target_configurationobject
error_report_configurationobject
kms_key_idstring
sq_namestringThe name of the scheduled query. Scheduled query names must be unique within each Region.
sq_query_stringstringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
sq_schedule_configurationstringConfiguration for when the scheduled query is executed.
sq_notification_configurationstringNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
sq_scheduled_query_execution_role_arnstringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
sq_target_configurationstringConfiguration of target store where scheduled query results are written to.
sq_error_report_configurationstringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
sq_kms_key_idstringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
tagsarray
regionstringAWS region.
string
string
string
object
object
string
string
object
object
string
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.
array
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual scheduled_query resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/timestream/table/index.md b/docs/aws-docs/providers/aws/timestream/table/index.md index 55d2b61898..be4342b554 100644 --- a/docs/aws-docs/providers/aws/timestream/table/index.md +++ b/docs/aws-docs/providers/aws/timestream/table/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual table resource, use tables to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual table resource, use tables< Nametable TypeResource DescriptionThe AWS::Timestream::Table resource creates a Timestream Table. -Idaws.timestream.table +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe table name exposed as a read-only attribute.
database_namestringThe name for the database which the table to be created belongs to.
table_namestringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
retention_propertiesobjectThe retention duration of the memory store and the magnetic store.
schemaobjectA Schema specifies the expected data model of the table.
magnetic_store_write_propertiesobjectThe properties that determine whether magnetic store writes are enabled.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
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.
@@ -48,19 +51,19 @@ Gets or operates on an individual table resource, use tables< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/timestream/tables/index.md b/docs/aws-docs/providers/aws/timestream/tables/index.md index 599dc32edf..50572efc4d 100644 --- a/docs/aws-docs/providers/aws/timestream/tables/index.md +++ b/docs/aws-docs/providers/aws/timestream/tables/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of tables in a region or create a tables resource, use table to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of tables in a region or create a tab Nametables TypeResource DescriptionThe AWS::Timestream::Table resource creates a Timestream Table. -Idaws.timestream.tables +Id ## Fields - - - + + +
NameDatatypeDescription
database_namestringThe name for the database which the table to be created belongs to.
table_namestringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
regionstringAWS region.
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.
@@ -42,14 +45,14 @@ Used to retrieve a list of tables in a region or create a tab Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/transfer/agreement/index.md b/docs/aws-docs/providers/aws/transfer/agreement/index.md index ca5d6336ec..e9905bdfbc 100644 --- a/docs/aws-docs/providers/aws/transfer/agreement/index.md +++ b/docs/aws-docs/providers/aws/transfer/agreement/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual agreement resource, use agreements to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual agreement resource, use agr Nameagreement TypeResource DescriptionResource Type definition for AWS::Transfer::Agreement -Idaws.transfer.agreement +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA textual description for the agreement.
server_idstringA unique identifier for the server.
local_profile_idstringA unique identifier for the local profile.
partner_profile_idstringA unique identifier for the partner profile.
base_directorystringSpecifies the base directory for the agreement.
access_rolestringSpecifies the access role for the agreement.
statusstringSpecifies the status of the agreement.
tagsarrayKey-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
agreement_idstringA unique identifier for the agreement.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
regionstringAWS region.
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.
@@ -50,19 +53,19 @@ Gets or operates on an individual agreement resource, use agr Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/transfer/agreements/index.md b/docs/aws-docs/providers/aws/transfer/agreements/index.md index 4e3370e8ec..0a4eedc8b9 100644 --- a/docs/aws-docs/providers/aws/transfer/agreements/index.md +++ b/docs/aws-docs/providers/aws/transfer/agreements/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of agreements in a region or create a agreements resource, use agreement to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of agreements in a region or create a Nameagreements TypeResource DescriptionResource Type definition for AWS::Transfer::Agreement -Idaws.transfer.agreements +Id ## Fields - - - + + +
NameDatatypeDescription
agreement_idstringA unique identifier for the agreement.
server_idstringA unique identifier for the server.
regionstringAWS region.
stringA unique identifier for the agreement.
stringA unique identifier for the server.
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of agreements in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/transfer/certificate/index.md b/docs/aws-docs/providers/aws/transfer/certificate/index.md index c4df85f0d5..f1a8415334 100644 --- a/docs/aws-docs/providers/aws/transfer/certificate/index.md +++ b/docs/aws-docs/providers/aws/transfer/certificate/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual certificate resource, use certificates to retrieve a list of resources or to create a resource. ## Overview @@ -21,28 +24,28 @@ Gets or operates on an individual certificate resource, use c Namecertificate TypeResource DescriptionResource Type definition for AWS::Transfer::Certificate -Idaws.transfer.certificate +Id ## Fields - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
NameDatatypeDescription
usagestringSpecifies the usage type for the certificate.
certificatestringSpecifies the certificate body to be imported.
certificate_chainstringSpecifies the certificate chain to be imported.
private_keystringSpecifies the private key for the certificate.
active_datestringSpecifies the active date for the certificate.
inactive_datestringSpecifies the inactive date for the certificate.
descriptionstringA textual description for the certificate.
tagsarrayKey-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
certificate_idstringA unique identifier for the certificate.
statusstringA status description for the certificate.
typestringDescribing the type of certificate. With or without a private key.
serialstringSpecifies Certificate's serial.
not_before_datestringSpecifies the not before date for the certificate.
not_after_datestringSpecifies the not after date for the certificate.
regionstringAWS region.
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.
@@ -55,19 +58,19 @@ Gets or operates on an individual certificate resource, use c Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/transfer/certificates/index.md b/docs/aws-docs/providers/aws/transfer/certificates/index.md index 5a397d2602..3b3cf9aa16 100644 --- a/docs/aws-docs/providers/aws/transfer/certificates/index.md +++ b/docs/aws-docs/providers/aws/transfer/certificates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of certificates in a region or create a certificates resource, use certificate to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of certificates in a region or create a Namecertificates TypeResource DescriptionResource Type definition for AWS::Transfer::Certificate -Idaws.transfer.certificates +Id ## Fields - - + +
NameDatatypeDescription
certificate_idstringA unique identifier for the certificate.
regionstringAWS region.
stringA unique identifier for the certificate.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of certificates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/transfer/connector/index.md b/docs/aws-docs/providers/aws/transfer/connector/index.md index e6a17cba15..51ed7a8f11 100644 --- a/docs/aws-docs/providers/aws/transfer/connector/index.md +++ b/docs/aws-docs/providers/aws/transfer/connector/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connector resource, use connectors to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual connector resource, use con Nameconnector TypeResource DescriptionResource Type definition for AWS::Transfer::Connector -Idaws.transfer.connector +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
access_rolestringSpecifies the access role for the connector.
as2_configobjectConfiguration for an AS2 connector.
sftp_configobjectConfiguration for an SFTP connector.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the connector.
connector_idstringA unique identifier for the connector.
logging_rolestringSpecifies the logging role for the connector.
tagsarrayKey-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
urlstringURL for Connector
regionstringAWS region.
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.
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
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual connector resource, use con Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/transfer/connectors/index.md b/docs/aws-docs/providers/aws/transfer/connectors/index.md index 8d46ed2e87..de64484fd9 100644 --- a/docs/aws-docs/providers/aws/transfer/connectors/index.md +++ b/docs/aws-docs/providers/aws/transfer/connectors/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connectors in a region or create a connectors resource, use connector to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connectors in a region or create a Nameconnectors TypeResource DescriptionResource Type definition for AWS::Transfer::Connector -Idaws.transfer.connectors +Id ## Fields - - + +
NameDatatypeDescription
connector_idstringA unique identifier for the connector.
regionstringAWS region.
stringA unique identifier for the connector.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connectors in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/transfer/profile/index.md b/docs/aws-docs/providers/aws/transfer/profile/index.md index 67977a9d39..682cff61fb 100644 --- a/docs/aws-docs/providers/aws/transfer/profile/index.md +++ b/docs/aws-docs/providers/aws/transfer/profile/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual profile resource, use profiles to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual profile resource, use profi Nameprofile TypeResource DescriptionResource Type definition for AWS::Transfer::Profile -Idaws.transfer.profile +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
as2_idstringAS2 identifier agreed with a trading partner.
profile_typestringEnum specifying whether the profile is local or associated with a trading partner.
tagsarrayAn array of key-value pairs to apply to this resource.
certificate_idsarrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the profile.
profile_idstringA unique identifier for the profile
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual profile resource, use profi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/transfer/profiles/index.md b/docs/aws-docs/providers/aws/transfer/profiles/index.md index a7ed050eef..48c16fe20c 100644 --- a/docs/aws-docs/providers/aws/transfer/profiles/index.md +++ b/docs/aws-docs/providers/aws/transfer/profiles/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of profiles in a region or create a profiles resource, use profile to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of profiles in a region or create a p Nameprofiles TypeResource DescriptionResource Type definition for AWS::Transfer::Profile -Idaws.transfer.profiles +Id ## Fields - - + +
NameDatatypeDescription
profile_idstringA unique identifier for the profile
regionstringAWS region.
stringA unique identifier for the profile
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of profiles in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/transfer/workflow/index.md b/docs/aws-docs/providers/aws/transfer/workflow/index.md index 5bbb50766e..c2a6915c01 100644 --- a/docs/aws-docs/providers/aws/transfer/workflow/index.md +++ b/docs/aws-docs/providers/aws/transfer/workflow/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual workflow resource, use workflows to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual workflow resource, use work Nameworkflow TypeResource DescriptionResource Type definition for AWS::Transfer::Workflow -Idaws.transfer.workflow +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
on_exception_stepsarraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
stepsarraySpecifies the details for the steps that are in the specified workflow.
tagsarrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
descriptionstringA textual description for the workflow.
workflow_idstringA unique identifier for the workflow.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
regionstringAWS region.
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.
@@ -46,19 +49,19 @@ Gets or operates on an individual workflow resource, use work Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/transfer/workflows/index.md b/docs/aws-docs/providers/aws/transfer/workflows/index.md index 122545ee71..d44ebc0a0f 100644 --- a/docs/aws-docs/providers/aws/transfer/workflows/index.md +++ b/docs/aws-docs/providers/aws/transfer/workflows/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of workflows in a region or create a workflows resource, use workflow to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of workflows in a region or create a Nameworkflows TypeResource DescriptionResource Type definition for AWS::Transfer::Workflow -Idaws.transfer.workflows +Id ## Fields - - + +
NameDatatypeDescription
workflow_idstringA unique identifier for the workflow.
regionstringAWS region.
stringA unique identifier for the workflow.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of workflows in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md index b943b9e332..9267e8fbbe 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_source resource, use identity_sources to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual identity_source resource, use Nameidentity_source TypeResource DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type -Idaws.verifiedpermissions.identity_source +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
configurationobject
detailsobject
identity_source_idstring
policy_store_idstring
principal_entity_typestring
regionstringAWS region.
object
object
string
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual identity_source resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md index c6cdfaaa3c..2478e213dd 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_sources in a region or create a identity_sources resource, use identity_source to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of identity_sources in a region or create a Nameidentity_sources TypeResource DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type -Idaws.verifiedpermissions.identity_sources +Id ## Fields - - - + + +
NameDatatypeDescription
identity_source_idstring
policy_store_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of identity_sources in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md index 27618c054f..b38fce7f29 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policies in a region or create a policies resource, use policy to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of policies in a region or create a p Namepolicies TypeResource DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type -Idaws.verifiedpermissions.policies +Id ## Fields - - - + + +
NameDatatypeDescription
policy_idstring
policy_store_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of policies in a region or create a p Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md index 717c5c1fee..1c3b0d8800 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy resource, use policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual policy resource, use polici Namepolicy TypeResource DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type -Idaws.verifiedpermissions.policy +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
definitionundefined
policy_idstring
policy_store_idstring
policy_typestring
regionstringAWS region.
undefined
string
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual policy resource, use polici Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md index 3260bf9255..ef586cb9d6 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy_store resource, use policy_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual policy_store resource, use Namepolicy_store TypeResource DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests -Idaws.verifiedpermissions.policy_store +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
policy_store_idstring
validation_settingsobject
schemaobject
regionstringAWS region.
string
string
string
object
object
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual policy_store resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md index 6b1276a57a..81ef103236 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policy_stores in a region or create a policy_stores resource, use policy_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of policy_stores in a region or create a Namepolicy_stores TypeResource DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests -Idaws.verifiedpermissions.policy_stores +Id ## Fields - - + +
NameDatatypeDescription
policy_store_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of policy_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md index a7b5c29686..6d5caf900f 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual policy_template resource, use policy_templates to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual policy_template resource, use Namepolicy_template TypeResource DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type -Idaws.verifiedpermissions.policy_template +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
descriptionstring
policy_store_idstring
policy_template_idstring
statementstring
regionstringAWS region.
string
string
string
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual policy_template resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md index f2bfe5ac1b..dc8d11a1fe 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of policy_templates in a region or create a policy_templates resource, use policy_template to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of policy_templates in a region or create a Namepolicy_templates TypeResource DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type -Idaws.verifiedpermissions.policy_templates +Id ## Fields - - - + + +
NameDatatypeDescription
policy_store_idstring
policy_template_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of policy_templates in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/voiceid/domain/index.md b/docs/aws-docs/providers/aws/voiceid/domain/index.md index 1ca0998d80..85b266d662 100644 --- a/docs/aws-docs/providers/aws/voiceid/domain/index.md +++ b/docs/aws-docs/providers/aws/voiceid/domain/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual domain resource, use domains to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual domain resource, use domain Namedomain TypeResource DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain. -Idaws.voiceid.domain +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
descriptionstring
domain_idstring
namestring
server_side_encryption_configurationobject
tagsarray
regionstringAWS region.
string
string
string
object
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual domain resource, use domain Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/voiceid/domains/index.md b/docs/aws-docs/providers/aws/voiceid/domains/index.md index 3ebd758e4a..0d3d20f8a3 100644 --- a/docs/aws-docs/providers/aws/voiceid/domains/index.md +++ b/docs/aws-docs/providers/aws/voiceid/domains/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of domains in a region or create a domains resource, use domain to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of domains in a region or create a do Namedomains TypeResource DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain. -Idaws.voiceid.domains +Id ## Fields - - + +
NameDatatypeDescription
domain_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of domains in a region or create a do Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md index 8a886aedde..32688ae2ff 100644 --- a/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual access_log_subscription resource, use access_log_subscriptions to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual access_log_subscription resource, Nameaccess_log_subscription TypeResource DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. -Idaws.vpclattice.access_log_subscription +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
destination_arnstring
idstring
resource_arnstring
resource_idstring
resource_identifierstring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual access_log_subscription resource, Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md index cde8895784..a39d372540 100644 --- a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of access_log_subscriptions in a region or create a access_log_subscriptions resource, use access_log_subscription to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of access_log_subscriptions in a region or Nameaccess_log_subscriptions TypeResource DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. -Idaws.vpclattice.access_log_subscriptions +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of access_log_subscriptions in a region or Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md index 4aeff1f1d5..138a8f639d 100644 --- a/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of auth_policies in a region or create a auth_policies resource, use auth_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of auth_policies in a region or create a Nameauth_policies TypeResource DescriptionCreates or updates the auth policy. -Idaws.vpclattice.auth_policies +Id ## Fields - - + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of auth_policies in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md b/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md index 2ec5b4c5f7..1230b0363c 100644 --- a/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual auth_policy resource, use auth_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual auth_policy resource, use a Nameauth_policy TypeResource DescriptionCreates or updates the auth policy. -Idaws.vpclattice.auth_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
resource_identifierstring
policyobject
statestring
regionstringAWS region.
string
object
string
stringAWS region.
@@ -43,19 +46,19 @@ Gets or operates on an individual auth_policy resource, use a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/listener/index.md b/docs/aws-docs/providers/aws/vpclattice/listener/index.md index 1d4e7a3bb6..d7284e7911 100644 --- a/docs/aws-docs/providers/aws/vpclattice/listener/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/listener/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual listener resource, use listeners to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual listener resource, use list Namelistener TypeResource DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. -Idaws.vpclattice.listener +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring
default_actionobject
idstring
namestring
portinteger
protocolstring
service_arnstring
service_idstring
service_identifierstring
tagsarray
regionstringAWS region.
string
object
string
string
integer
string
string
string
string
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual listener resource, use list Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/listeners/index.md b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md index 8cd6910910..918000e3c6 100644 --- a/docs/aws-docs/providers/aws/vpclattice/listeners/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of listeners in a region or create a listeners resource, use listener to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of listeners in a region or create a Namelisteners TypeResource DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. -Idaws.vpclattice.listeners +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of listeners in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md index 61266676a5..a86017ca1b 100644 --- a/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionRetrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource. -Idaws.vpclattice.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
resource_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md b/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md index 1d85ebd7eb..5c64ae25a3 100644 --- a/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionRetrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource. -Idaws.vpclattice.resource_policy +Id ## Fields - - - + + +
NameDatatypeDescription
resource_arnstring
policyobject
regionstringAWS region.
string
object
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/rule/index.md b/docs/aws-docs/providers/aws/vpclattice/rule/index.md index 8456ccf123..bed9ced67e 100644 --- a/docs/aws-docs/providers/aws/vpclattice/rule/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule resource, use rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual rule resource, use rulesNamerule TypeResource DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. -Idaws.vpclattice.rule +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
actionobject
arnstring
idstring
listener_identifierstring
matchobject
namestring
priorityinteger
service_identifierstring
tagsarray
regionstringAWS region.
object
string
string
string
object
string
integer
string
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual rule resource, use rulesRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/rules/index.md b/docs/aws-docs/providers/aws/vpclattice/rules/index.md index e2dc4d3456..ae43da6154 100644 --- a/docs/aws-docs/providers/aws/vpclattice/rules/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rules in a region or create a rules resource, use rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of rules in a region or create a rule Namerules TypeResource DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. -Idaws.vpclattice.rules +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of rules in a region or create a rule Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service/index.md b/docs/aws-docs/providers/aws/vpclattice/service/index.md index 12996eb9d7..0dd017f6f0 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service resource, use services to retrieve a list of resources or to create a resource. ## Overview @@ -21,24 +24,24 @@ Gets or operates on an individual service resource, use servi Nameservice TypeResource DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). -Idaws.vpclattice.service +Id ## Fields - - - - - - - - - - - - + + + + + + + + + + + +
NameDatatypeDescription
arnstring
auth_typestring
created_atstring
dns_entryobject
idstring
last_updated_atstring
namestring
statusstring
certificate_arnstring
custom_domain_namestring
tagsarray
regionstringAWS region.
string
string
string
object
string
string
string
string
string
string
array
stringAWS region.
@@ -51,19 +54,19 @@ Gets or operates on an individual service resource, use servi Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network/index.md index 39947dd302..e83f6b1f56 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_network resource, use service_networks to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual service_network resource, use Nameservice_network TypeResource DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. -Idaws.vpclattice.service_network +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
idstring
last_updated_atstring
namestring
auth_typestring
tagsarray
regionstringAWS region.
string
string
string
string
string
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual service_network resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md index 2383e8614b..5e86f0153d 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_network_service_association resource, use service_network_service_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,27 +24,27 @@ Gets or operates on an individual service_network_service_associationNameservice_network_service_association TypeResource DescriptionAssociates a service with a service network. -Idaws.vpclattice.service_network_service_association +Id ## Fields - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
dns_entryobject
idstring
service_network_arnstring
service_network_idstring
service_network_identifierstring
service_network_namestring
service_arnstring
service_idstring
service_identifierstring
service_namestring
statusstring
tagsarray
regionstringAWS region.
string
string
object
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
@@ -54,19 +57,19 @@ Gets or operates on an individual service_network_service_associationRequired Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md index b785a2223e..ebf222b86a 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_network_service_associations in a region or create a service_network_service_associations resource, use service_network_service_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_network_service_associations in Nameservice_network_service_associations TypeResource DescriptionAssociates a service with a service network. -Idaws.vpclattice.service_network_service_associations +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_network_service_associations in Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md index e300be66d5..05a07d465a 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual service_network_vpc_association resource, use service_network_vpc_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,25 +24,25 @@ Gets or operates on an individual service_network_vpc_association r Nameservice_network_vpc_association TypeResource DescriptionAssociates a VPC with a service network. -Idaws.vpclattice.service_network_vpc_association +Id ## Fields - - - - - - - - - - - - - + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
security_group_idsarray
idstring
service_network_arnstring
service_network_idstring
service_network_identifierstring
service_network_namestring
statusstring
vpc_idstring
vpc_identifierstring
tagsarray
regionstringAWS region.
string
string
array
string
string
string
string
string
string
string
string
array
stringAWS region.
@@ -52,19 +55,19 @@ Gets or operates on an individual service_network_vpc_association r Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md index 27d4768b4e..72fa01f311 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_network_vpc_associations in a region or create a service_network_vpc_associations resource, use service_network_vpc_association to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_network_vpc_associations in a re Nameservice_network_vpc_associations TypeResource DescriptionAssociates a VPC with a service network. -Idaws.vpclattice.service_network_vpc_associations +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_network_vpc_associations in a re Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md index 4555e6b571..5c9066cc79 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of service_networks in a region or create a service_networks resource, use service_network to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of service_networks in a region or create a Nameservice_networks TypeResource DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. -Idaws.vpclattice.service_networks +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of service_networks in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/services/index.md b/docs/aws-docs/providers/aws/vpclattice/services/index.md index 519a42c529..97b9254af0 100644 --- a/docs/aws-docs/providers/aws/vpclattice/services/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/services/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of services in a region or create a services resource, use service to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of services in a region or create a s Nameservices TypeResource DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). -Idaws.vpclattice.services +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of services in a region or create a s Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_group/index.md b/docs/aws-docs/providers/aws/vpclattice/target_group/index.md index 151413768c..f7707e14ff 100644 --- a/docs/aws-docs/providers/aws/vpclattice/target_group/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/target_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual target_group resource, use target_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,23 +24,23 @@ Gets or operates on an individual target_group resource, use Nametarget_group TypeResource DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. -Idaws.vpclattice.target_group +Id ## Fields - - - - - - - - - - - + + + + + + + + + + +
NameDatatypeDescription
arnstring
configobject
created_atstring
idstring
last_updated_atstring
namestring
statusstring
typestring
targetsarray
tagsarray
regionstringAWS region.
string
object
string
string
string
string
string
string
array
array
stringAWS region.
@@ -50,19 +53,19 @@ Gets or operates on an individual target_group resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md index a0e8283450..45812bc7a6 100644 --- a/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of target_groups in a region or create a target_groups resource, use target_group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of target_groups in a region or create a Nametarget_groups TypeResource DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. -Idaws.vpclattice.target_groups +Id ## Fields - - + +
NameDatatypeDescription
arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of target_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/ip_set/index.md b/docs/aws-docs/providers/aws/wafv2/ip_set/index.md index e95aeecfa4..2bee9b2fd9 100644 --- a/docs/aws-docs/providers/aws/wafv2/ip_set/index.md +++ b/docs/aws-docs/providers/aws/wafv2/ip_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ip_set resource, use ip_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,21 +24,21 @@ Gets or operates on an individual ip_set resource, use ip_set Nameip_set TypeResource DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually -Idaws.wafv2.ip_set +Id ## Fields - - - - - - - - - + + + + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
namestring
idstring
scopestring
ip_address_versionstring
addressesarrayList of IPAddresses.
tagsarray
regionstringAWS region.
string
string
string
string
string
string
arrayList of IPAddresses.
array
stringAWS region.
@@ -48,19 +51,19 @@ Gets or operates on an individual ip_set resource, use ip_set Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md index 2086eba7e3..c75b3ebc22 100644 --- a/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md +++ b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of ip_sets in a region or create a ip_sets resource, use ip_set to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of ip_sets in a region or create a ip Nameip_sets TypeResource DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually -Idaws.wafv2.ip_sets +Id ## Fields - - - - + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
undefined
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of ip_sets in a region or create a ip Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md index fa8e06072a..43c4b1cc38 100644 --- a/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md +++ b/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual logging_configuration resource, use logging_configurations to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual logging_configuration resource, u Namelogging_configuration TypeResource DescriptionA WAFv2 Logging Configuration Resource Provider -Idaws.wafv2.logging_configuration +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
resource_arnstringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
log_destination_configsarrayThe Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.
redacted_fieldsarrayThe parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.
managed_by_firewall_managerbooleanIndicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
logging_filterobjectFiltering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
regionstringAWS region.
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.
@@ -45,19 +48,19 @@ Gets or operates on an individual logging_configuration resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md index 1cb4621769..1debf98b47 100644 --- a/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of logging_configurations in a region or create a logging_configurations resource, use logging_configuration to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of logging_configurations in a region or cr Namelogging_configurations TypeResource DescriptionA WAFv2 Logging Configuration Resource Provider -Idaws.wafv2.logging_configurations +Id ## Fields - - + +
NameDatatypeDescription
resource_arnstringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
regionstringAWS region.
stringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of logging_configurations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md index c3844772a1..36c218f8b8 100644 --- a/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual regex_pattern_set resource, use regex_pattern_sets to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual regex_pattern_set resource, use < Nameregex_pattern_set TypeResource DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions . -Idaws.wafv2.regex_pattern_set +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
arnstringARN of the WAF entity.
descriptionstringDescription of the entity.
namestringName of the RegexPatternSet.
idstringId of the RegexPatternSet
regular_expression_listarray
scopestringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
tagsarray
regionstringAWS region.
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.
@@ -47,19 +50,19 @@ Gets or operates on an individual regex_pattern_set resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md index 9a3a1bf5d5..4fbb045a9b 100644 --- a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of regex_pattern_sets in a region or create a regex_pattern_sets resource, use regex_pattern_set to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of regex_pattern_sets in a region or create Nameregex_pattern_sets TypeResource DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions . -Idaws.wafv2.regex_pattern_sets +Id ## Fields - - - - + + + +
NameDatatypeDescription
namestringName of the RegexPatternSet.
idstringId of the RegexPatternSet
scopestringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
regionstringAWS region.
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of regex_pattern_sets in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_group/index.md b/docs/aws-docs/providers/aws/wafv2/rule_group/index.md index 8697a83ad9..6e4aceb280 100644 --- a/docs/aws-docs/providers/aws/wafv2/rule_group/index.md +++ b/docs/aws-docs/providers/aws/wafv2/rule_group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual rule_group resource, use rule_groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual rule_group resource, use ru Namerule_group TypeResource DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted. -Idaws.wafv2.rule_group +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
capacityinteger
descriptionstring
namestring
idstring
scopestring
rulesarrayCollection of Rules.
visibility_configobject
tagsarray
label_namespacestring
custom_response_bodiesobject
available_labelsarrayCollection of Available Labels.
consumed_labelsarrayCollection of Consumed Labels.
regionstringAWS region.
string
integer
string
string
string
string
arrayCollection of Rules.
object
array
string
object
arrayCollection of Available Labels.
arrayCollection of Consumed Labels.
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual rule_group resource, use ru Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md index a576b10b71..34e19f8fa8 100644 --- a/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md +++ b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of rule_groups in a region or create a rule_groups resource, use rule_group to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of rule_groups in a region or create a Namerule_groups TypeResource DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted. -Idaws.wafv2.rule_groups +Id ## Fields - - - - + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
undefined
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of rule_groups in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acl/index.md b/docs/aws-docs/providers/aws/wafv2/web_acl/index.md index d0f4c0d125..f50391e473 100644 --- a/docs/aws-docs/providers/aws/wafv2/web_acl/index.md +++ b/docs/aws-docs/providers/aws/wafv2/web_acl/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual web_acl resource, use web_acls to retrieve a list of resources or to create a resource. ## Overview @@ -21,29 +24,29 @@ Gets or operates on an individual web_acl resource, use web_a Nameweb_acl TypeResource DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. -Idaws.wafv2.web_acl +Id ## Fields - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
capacityinteger
default_actionobject
descriptionstring
namestring
idstring
scopestring
rulesarrayCollection of Rules.
visibility_configobject
tagsarray
label_namespacestring
custom_response_bodiesobject
captcha_configobject
challenge_configobject
token_domainsarray
association_configobject
regionstringAWS region.
string
integer
object
string
string
string
string
arrayCollection of Rules.
object
array
string
object
object
object
array
object
stringAWS region.
@@ -56,19 +59,19 @@ Gets or operates on an individual web_acl resource, use web_a Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acls/index.md b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md index dcc9d41f59..a09398642a 100644 --- a/docs/aws-docs/providers/aws/wafv2/web_acls/index.md +++ b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of web_acls in a region or create a web_acls resource, use web_acl to operate on an individual resource. ## Overview @@ -21,16 +24,16 @@ Used to retrieve a list of web_acls in a region or create a w Nameweb_acls TypeResource DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. -Idaws.wafv2.web_acls +Id ## Fields - - - - + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
undefined
undefined
undefined
stringAWS region.
@@ -43,14 +46,14 @@ Used to retrieve a list of web_acls in a region or create a w Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md b/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md index 7284615b88..dd4b6d15d7 100644 --- a/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md +++ b/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual webacl_association resource, use webacl_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,15 +24,15 @@ Gets or operates on an individual webacl_association resource, use Namewebacl_association TypeResource DescriptionAssociates WebACL to Application Load Balancer, CloudFront or API Gateway. -Idaws.wafv2.webacl_association +Id ## Fields - - - + + +
NameDatatypeDescription
resource_arnstring
web_acl_arnstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,19 +45,19 @@ Gets or operates on an individual webacl_association resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md index f2bb3feff2..454be4ab7d 100644 --- a/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md +++ b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of webacl_associations in a region or create a webacl_associations resource, use webacl_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of webacl_associations in a region or creat Namewebacl_associations TypeResource DescriptionAssociates WebACL to Application Load Balancer, CloudFront or API Gateway. -Idaws.wafv2.webacl_associations +Id ## Fields - - - + + +
NameDatatypeDescription
resource_arnundefined
web_acl_arnundefined
regionstringAWS region.
undefined
undefined
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of webacl_associations in a region or creat Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant/index.md b/docs/aws-docs/providers/aws/wisdom/assistant/index.md index 422bdfa0fc..e66bb3417a 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistant/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistant/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assistant resource, use assistants to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual assistant resource, use ass Nameassistant TypeResource DescriptionDefinition of AWS::Wisdom::Assistant Resource Type -Idaws.wisdom.assistant +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
typestring
descriptionstring
assistant_arnstring
assistant_idstring
server_side_encryption_configurationobject
tagsarray
namestring
regionstringAWS region.
string
string
string
string
object
array
string
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual assistant resource, use ass Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md index e5c042c9a6..dd173dab55 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual assistant_association resource, use assistant_associations to retrieve a list of resources or to create a resource. ## Overview @@ -21,20 +24,20 @@ Gets or operates on an individual assistant_association resource, u Nameassistant_association TypeResource DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type -Idaws.wisdom.assistant_association +Id ## Fields - - - - - - - - + + + + + + + +
NameDatatypeDescription
assistant_association_arnstring
assistant_arnstring
assistant_association_idstring
assistant_idstring
associationobject
association_typestring
tagsarray
regionstringAWS region.
string
string
string
string
object
string
array
stringAWS region.
@@ -47,19 +50,19 @@ Gets or operates on an individual assistant_association resource, u Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md index 5c2d07d292..6d079234f2 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assistant_associations in a region or create a assistant_associations resource, use assistant_association to operate on an individual resource. ## Overview @@ -21,15 +24,15 @@ Used to retrieve a list of assistant_associations in a region or cr Nameassistant_associations TypeResource DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type -Idaws.wisdom.assistant_associations +Id ## Fields - - - + + +
NameDatatypeDescription
assistant_association_idstring
assistant_idstring
regionstringAWS region.
string
string
stringAWS region.
@@ -42,14 +45,14 @@ Used to retrieve a list of assistant_associations in a region or cr Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wisdom/assistants/index.md b/docs/aws-docs/providers/aws/wisdom/assistants/index.md index 21001e30f1..3912249e3e 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistants/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistants/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of assistants in a region or create a assistants resource, use assistant to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of assistants in a region or create a Nameassistants TypeResource DescriptionDefinition of AWS::Wisdom::Assistant Resource Type -Idaws.wisdom.assistants +Id ## Fields - - + +
NameDatatypeDescription
assistant_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of assistants in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md index 874068378e..002b631783 100644 --- a/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual knowledge_base resource, use knowledge_bases to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual knowledge_base resource, use Nameknowledge_base TypeResource DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type -Idaws.wisdom.knowledge_base +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
descriptionstring
knowledge_base_arnstring
knowledge_base_idstring
knowledge_base_typestring
namestring
rendering_configurationobject
server_side_encryption_configurationobject
source_configurationobject
tagsarray
regionstringAWS region.
string
string
string
string
string
object
object
object
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual knowledge_base resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md index 133c60bd92..0ea0055f01 100644 --- a/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of knowledge_bases in a region or create a knowledge_bases resource, use knowledge_base to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of knowledge_bases in a region or create a Nameknowledge_bases TypeResource DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type -Idaws.wisdom.knowledge_bases +Id ## Fields - - + +
NameDatatypeDescription
knowledge_base_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of knowledge_bases in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md b/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md index 3214acb208..5e42c4a248 100644 --- a/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md +++ b/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual connection_alias resource, use connection_aliases to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual connection_alias resource, use Nameconnection_alias TypeResource DescriptionResource Type definition for AWS::WorkSpaces::ConnectionAlias -Idaws.workspaces.connection_alias +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
associationsarray
alias_idstring
connection_stringstring
connection_alias_statestring
tagsarray
regionstringAWS region.
array
string
string
string
array
stringAWS region.
@@ -45,14 +48,14 @@ Gets or operates on an individual connection_alias resource, use Required Params - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md index 09a10382ec..ba75b117ec 100644 --- a/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md +++ b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of connection_aliases in a region or create a connection_aliases resource, use connection_alias to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of connection_aliases in a region or create Nameconnection_aliases TypeResource DescriptionResource Type definition for AWS::WorkSpaces::ConnectionAlias -Idaws.workspaces.connection_aliases +Id ## Fields - - + +
NameDatatypeDescription
alias_idstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of connection_aliases in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md index c3c331da07..c2b640917a 100644 --- a/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual environment resource, use environments to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual environment resource, use e Nameenvironment TypeResource DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment. -Idaws.workspacesthinclient.environment +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringUnique identifier of the environment.
namestringThe name of the environment.
desktop_arnstringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
desktop_endpointstringThe URL for the identity provider login (only for environments that use AppStream 2.0).
desktop_typestringThe type of VDI.
activation_codestringActivation code for devices associated with environment.
registered_devices_countintegerNumber of devices registered to the environment.
software_set_update_schedulestringAn option to define if software updates should be applied within a maintenance window.
maintenance_windowobjectA specification for a time window to apply software updates.
software_set_update_modestringAn option to define which software updates to apply.
desired_software_set_idstringThe ID of the software set to apply.
pending_software_set_idstringThe ID of the software set that is pending to be installed.
pending_software_set_versionstringThe version of the software set that is pending to be installed.
software_set_compliance_statusstringDescribes if the software currently installed on all devices in the environment is a supported version.
created_atstringThe timestamp in unix epoch format when environment was created.
updated_atstringThe timestamp in unix epoch format when environment was last updated.
arnstringThe environment ARN.
kms_key_arnstringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
stringUnique identifier of the environment.
stringThe name of the environment.
stringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
stringThe URL for the identity provider login (only for environments that use AppStream 2.0).
stringThe type of VDI.
stringActivation code for devices associated with environment.
integerNumber of devices registered to the environment.
stringAn option to define if software updates should be applied within a maintenance window.
objectA specification for a time window to apply software updates.
stringAn option to define which software updates to apply.
stringThe ID of the software set to apply.
stringThe ID of the software set that is pending to be installed.
stringThe version of the software set that is pending to be installed.
stringDescribes if the software currently installed on all devices in the environment is a supported version.
stringThe timestamp in unix epoch format when environment was created.
stringThe timestamp in unix epoch format when environment was last updated.
stringThe environment ARN.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual environment resource, use e Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md index a5a2dd9510..6d2376f539 100644 --- a/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of environments in a region or create a environments resource, use environment to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of environments in a region or create a Nameenvironments TypeResource DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment. -Idaws.workspacesthinclient.environments +Id ## Fields - - + +
NameDatatypeDescription
idstringUnique identifier of the environment.
regionstringAWS region.
stringUnique identifier of the environment.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of environments in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md index 25efba4977..18982abef7 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual browser_settings resource, use browser_settings to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual browser_settings resource, use Namebrowser_settings TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type -Idaws.workspacesweb.browser_settings +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
browser_policystring
browser_settings_arnstring
customer_managed_keystring
tagsarray
regionstringAWS region.
object
array
string
string
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual browser_settings resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md index 0bdc083839..e76381324a 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual identity_provider resource, use identity_providers to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual identity_provider resource, use < Nameidentity_provider TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type -Idaws.workspacesweb.identity_provider +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
identity_provider_arnstring
identity_provider_detailsobject
identity_provider_namestring
identity_provider_typestring
portal_arnstring
regionstringAWS region.
string
object
string
string
string
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual identity_provider resource, use < Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md index 763ecdfedc..e337a23bca 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of identity_providers in a region or create a identity_providers resource, use identity_provider to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of identity_providers in a region or create Nameidentity_providers TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type -Idaws.workspacesweb.identity_providers +Id ## Fields - - + +
NameDatatypeDescription
identity_provider_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of identity_providers in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md index 10a678f450..9360754aad 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual ip_access_settings resource, use ip_access_settings to retrieve a list of resources or to create a resource. ## Overview @@ -21,22 +24,22 @@ Gets or operates on an individual ip_access_settings resource, use Nameip_access_settings TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type -Idaws.workspacesweb.ip_access_settings +Id ## Fields - - - - - - - - - - + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
creation_datestring
customer_managed_keystring
descriptionstring
display_namestring
ip_access_settings_arnstring
ip_rulesarray
tagsarray
regionstringAWS region.
object
array
string
string
string
string
string
array
array
stringAWS region.
@@ -49,19 +52,19 @@ Gets or operates on an individual ip_access_settings resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md index 438e01bc1d..5544e88f90 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual network_settings resource, use network_settings to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual network_settings resource, use Namenetwork_settings TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type -Idaws.workspacesweb.network_settings +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
network_settings_arnstring
security_group_idsarray
subnet_idsarray
tagsarray
vpc_idstring
regionstringAWS region.
array
string
array
array
array
string
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual network_settings resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portal/index.md b/docs/aws-docs/providers/aws/workspacesweb/portal/index.md index 01b08f5121..e4a528d53f 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/portal/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/portal/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual portal resource, use portals to retrieve a list of resources or to create a resource. ## Overview @@ -21,32 +24,32 @@ Gets or operates on an individual portal resource, use portal Nameportal TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type -Idaws.workspacesweb.portal +Id ## Fields - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
authentication_typestring
browser_settings_arnstring
browser_typestring
creation_datestring
customer_managed_keystring
display_namestring
ip_access_settings_arnstring
network_settings_arnstring
portal_arnstring
portal_endpointstring
portal_statusstring
renderer_typestring
service_provider_saml_metadatastring
status_reasonstring
tagsarray
trust_store_arnstring
user_access_logging_settings_arnstring
user_settings_arnstring
regionstringAWS region.
object
string
string
string
string
string
string
string
string
string
string
string
string
string
string
array
string
string
string
stringAWS region.
@@ -59,19 +62,19 @@ Gets or operates on an individual portal resource, use portal Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portals/index.md b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md index fd875f461d..631c2b3645 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/portals/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of portals in a region or create a portals resource, use portal to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of portals in a region or create a po Nameportals TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type -Idaws.workspacesweb.portals +Id ## Fields - - + +
NameDatatypeDescription
portal_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of portals in a region or create a po Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md index fafbe28507..144d6f1546 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual trust_store resource, use trust_stores to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual trust_store resource, use t Nametrust_store TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type -Idaws.workspacesweb.trust_store +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
associated_portal_arnsarray
certificate_listarray
tagsarray
trust_store_arnstring
regionstringAWS region.
array
array
array
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual trust_store resource, use t Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md index d7cd7acb1b..0e15de37e4 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of trust_stores in a region or create a trust_stores resource, use trust_store to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of trust_stores in a region or create a Nametrust_stores TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type -Idaws.workspacesweb.trust_stores +Id ## Fields - - + +
NameDatatypeDescription
trust_store_arnstring
regionstringAWS region.
string
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of trust_stores in a region or create a Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md index 6e752029f2..6995a8806c 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_access_logging_settings resource, use user_access_logging_settings to retrieve a list of resources or to create a resource. ## Overview @@ -21,17 +24,17 @@ Gets or operates on an individual user_access_logging_settings reso Nameuser_access_logging_settings TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type -Idaws.workspacesweb.user_access_logging_settings +Id ## Fields - - - - - + + + + +
NameDatatypeDescription
associated_portal_arnsarray
kinesis_stream_arnstringKinesis stream ARN to which log events are published.
tagsarray
user_access_logging_settings_arnstring
regionstringAWS region.
array
stringKinesis stream ARN to which log events are published.
array
string
stringAWS region.
@@ -44,19 +47,19 @@ Gets or operates on an individual user_access_logging_settings reso Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md index 86ec972e07..b49712313d 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual user_settings resource, use user_settings to retrieve a list of resources or to create a resource. ## Overview @@ -21,26 +24,26 @@ Gets or operates on an individual user_settings resource, use Nameuser_settings TypeResource DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type -Idaws.workspacesweb.user_settings +Id ## Fields - - - - - - - - - - - - - - + + + + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
cookie_synchronization_configurationobject
copy_allowedstring
customer_managed_keystring
disconnect_timeout_in_minutesnumber
download_allowedstring
idle_disconnect_timeout_in_minutesnumber
paste_allowedstring
print_allowedstring
tagsarray
upload_allowedstring
user_settings_arnstring
regionstringAWS region.
object
array
object
string
string
number
string
number
string
string
array
string
string
stringAWS region.
@@ -53,19 +56,19 @@ Gets or operates on an individual user_settings resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/xray/group/index.md b/docs/aws-docs/providers/aws/xray/group/index.md index 79d4823acc..a58695ce40 100644 --- a/docs/aws-docs/providers/aws/xray/group/index.md +++ b/docs/aws-docs/providers/aws/xray/group/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual group resource, use groups to retrieve a list of resources or to create a resource. ## Overview @@ -21,18 +24,18 @@ Gets or operates on an individual group resource, use groups< Namegroup TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters. -Idaws.xray.group +Id ## Fields - - - - - - + + + + + +
NameDatatypeDescription
filter_expressionstringThe filter expression defining criteria by which to group traces.
group_namestringThe case-sensitive name of the new group. Names must be unique.
group_arnstringThe ARN of the group that was generated on creation.
insights_configurationobject
tagsarray
regionstringAWS region.
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
array
stringAWS region.
@@ -45,19 +48,19 @@ Gets or operates on an individual group resource, use groups< Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/xray/groups/index.md b/docs/aws-docs/providers/aws/xray/groups/index.md index c1b0dba9f2..5598b0d674 100644 --- a/docs/aws-docs/providers/aws/xray/groups/index.md +++ b/docs/aws-docs/providers/aws/xray/groups/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of groups in a region or create a gro Namegroups TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters. -Idaws.xray.groups +Id ## Fields - - + +
NameDatatypeDescription
group_arnstringThe ARN of the group that was generated on creation.
regionstringAWS region.
stringThe ARN of the group that was generated on creation.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of groups in a region or create a gro Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/xray/resource_policies/index.md b/docs/aws-docs/providers/aws/xray/resource_policies/index.md index baf8930e50..90cab2fcb3 100644 --- a/docs/aws-docs/providers/aws/xray/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/xray/resource_policies/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of resource_policies in a region or create a resource_policies resource, use resource_policy to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of resource_policies in a region or create Nameresource_policies TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters. -Idaws.xray.resource_policies +Id ## Fields - - + +
NameDatatypeDescription
policy_namestringThe name of the resource policy. Must be unique within a specific AWS account.
regionstringAWS region.
stringThe name of the resource policy. Must be unique within a specific AWS account.
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of resource_policies in a region or create Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/docs/aws-docs/providers/aws/xray/resource_policy/index.md b/docs/aws-docs/providers/aws/xray/resource_policy/index.md index e7795ae1e0..52af76e0e4 100644 --- a/docs/aws-docs/providers/aws/xray/resource_policy/index.md +++ b/docs/aws-docs/providers/aws/xray/resource_policy/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual resource_policy resource, use resource_policies to retrieve a list of resources or to create a resource. ## Overview @@ -21,16 +24,16 @@ Gets or operates on an individual resource_policy resource, use Nameresource_policy TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters. -Idaws.xray.resource_policy +Id ## Fields - - - - + + + +
NameDatatypeDescription
policy_namestringThe name of the resource policy. Must be unique within a specific AWS account.
policy_documentstringThe resource policy document, which can be up to 5kb in size.
bypass_policy_lockout_checkbooleanA flag to indicate whether to bypass the resource policy lockout safety check
regionstringAWS region.
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.
@@ -43,19 +46,19 @@ Gets or operates on an individual resource_policy resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rule/index.md b/docs/aws-docs/providers/aws/xray/sampling_rule/index.md index 2edfdf3c6a..276b484d2e 100644 --- a/docs/aws-docs/providers/aws/xray/sampling_rule/index.md +++ b/docs/aws-docs/providers/aws/xray/sampling_rule/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Gets or operates on an individual sampling_rule resource, use sampling_rules to retrieve a list of resources or to create a resource. ## Overview @@ -21,19 +24,19 @@ Gets or operates on an individual sampling_rule resource, use Namesampling_rule TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters. -Idaws.xray.sampling_rule +Id ## Fields - - - - - - - + + + + + + +
NameDatatypeDescription
sampling_ruleobject
sampling_rule_recordobject
sampling_rule_updateobject
rule_arnstring
rule_namestring
tagsarray
regionstringAWS region.
object
object
object
string
string
array
stringAWS region.
@@ -46,19 +49,19 @@ Gets or operates on an individual sampling_rule resource, use Required Params - update_resource + UPDATE - data__Identifier, data__PatchDocument, region + - delete_resource + DELETE - data__Identifier, region + - get_resource + SELECT - data__Identifier, region + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rules/index.md b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md index 22330305fe..b6028a5d99 100644 --- a/docs/aws-docs/providers/aws/xray/sampling_rules/index.md +++ b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md @@ -14,6 +14,9 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Used to retrieve a list of sampling_rules in a region or create a sampling_rules resource, use sampling_rule to operate on an individual resource. ## Overview @@ -21,14 +24,14 @@ Used to retrieve a list of sampling_rules in a region or create a < Namesampling_rules TypeResource DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters. -Idaws.xray.sampling_rules +Id ## Fields - - + +
NameDatatypeDescription
rule_arnundefined
regionstringAWS region.
undefined
stringAWS region.
@@ -41,14 +44,14 @@ Used to retrieve a list of sampling_rules in a region or create a < Required Params - create_resource + INSERT - data__DesiredState, region + - list_resource + SELECT - region + diff --git a/package.json b/package.json index 15d38d8d9d..d5f1ac5141 100644 --- a/package.json +++ b/package.json @@ -69,6 +69,7 @@ "@mui/styles": "^5.2.3", "@svgr/webpack": "^5.5.0", "aos": "^2.3.4", + "clipboard": "^2.0.11", "clsx": "^1.1.1", "docusaurus-plugin-hubspot": "^1.0.0", "docusaurus-plugin-smartlook": "^1.0.1", diff --git a/src/components/CopyableCode/CopyableCode.js b/src/components/CopyableCode/CopyableCode.js new file mode 100644 index 0000000000..8115f33108 --- /dev/null +++ b/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/src/css/global.css b/src/css/global.css index 37e59389bb..60f8228bed 100644 --- a/src/css/global.css +++ b/src/css/global.css @@ -557,4 +557,21 @@ html[data-theme='dark'] .contactFormHeading { position: relative; top: 2px; transform: translateY(-50%); - } \ No newline at end of file + } + + /* copyable code */ + + /* src/css/custom.css */ +.copyable-code-container code { + cursor: pointer; + position: relative; + background: #f4f4f4; + border: 1px solid #ccc; + padding: 2px 6px; +} + +.copyable-code-container code:hover { + background-color: #e8e8e8; +} + +/* end copyable code */ \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index fa5fb30621..a0155c7fb6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5780,6 +5780,15 @@ cli-width@^2.0.0: resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-2.2.1.tgz#b0433d0b4e9c847ef18868a4ef16fd5fc8271c48" integrity sha512-GRMWDxpOB6Dgk2E5Uo+3eEBvtOOlimMmpbFiKuLFnQzYDavtLFY3K5ona41jgN/WdRZtG7utuVSVTL4HbZHGkw== +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" + cliui@^8.0.1: version "8.0.1" resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa" @@ -6751,6 +6760,11 @@ delayed-stream@~1.0.0: resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ== +delegate@^3.1.2: + version "3.2.0" + resolved "https://registry.yarnpkg.com/delegate/-/delegate-3.2.0.tgz#b66b71c3158522e8ab5744f720d8ca0c2af59166" + integrity sha512-IofjkYBZaZivn0V8nnsMJGBr4jVLxHDheKSW88PyxS5QC4Vo9ZbZVvhzlSxY87fVq3STR6r+4cGepyHkcWOQSw== + delegates@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a" @@ -8386,6 +8400,13 @@ gonzales-pe@^4.2.3, gonzales-pe@^4.3.0: dependencies: minimist "^1.2.5" +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" + google-map-react@^2.1.10: version "2.1.10" resolved "https://registry.yarnpkg.com/google-map-react/-/google-map-react-2.1.10.tgz#16b5b699f257d6008dc9333d0bbbf1ab5b31fa42" @@ -13347,6 +13368,11 @@ select-hose@^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.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.0.1.tgz#8b2df7fa56bf014d19b6007655fff209c0ef0a56" @@ -14364,6 +14390,11 @@ timed-out@^4.0.1: resolved "https://registry.yarnpkg.com/timed-out/-/timed-out-4.0.1.tgz#f32eacac5a175bea25d7fab565ab3ed8741ef56f" integrity sha512-G7r3AhovYtr5YKOWQkta8RKAPb+J9IsO4uVmzjl8AZwfhs8UcUwTiD6gcJYSgOtzyjvQKrKYn41syHbUWMkafA== +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.2.0" resolved "https://registry.yarnpkg.com/tiny-invariant/-/tiny-invariant-1.2.0.tgz#a1141f86b672a9148c72e978a19a73b9b94a15a9"