Class: Aws::CloudFormation::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudFormation::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb
Overview
An API client for CloudFormation. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudFormation::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_organizations_access(params = {}) ⇒ Struct
Activate trusted access with Organizations.
-
#activate_type(params = {}) ⇒ Types::ActivateTypeOutput
Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region.
-
#batch_describe_type_configurations(params = {}) ⇒ Types::BatchDescribeTypeConfigurationsOutput
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.
-
#cancel_update_stack(params = {}) ⇒ Struct
Cancels an update on the specified stack.
-
#continue_update_rollback(params = {}) ⇒ Struct
Continues rolling back a stack from
UPDATE_ROLLBACK_FAILED
toUPDATE_ROLLBACK_COMPLETE
state. -
#create_change_set(params = {}) ⇒ Types::CreateChangeSetOutput
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
-
#create_generated_template(params = {}) ⇒ Types::CreateGeneratedTemplateOutput
Creates a template from existing resources that are not already managed with CloudFormation.
-
#create_stack(params = {}) ⇒ Types::CreateStackOutput
Creates a stack as specified in the template.
-
#create_stack_instances(params = {}) ⇒ Types::CreateStackInstancesOutput
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
-
#create_stack_refactor(params = {}) ⇒ Types::CreateStackRefactorOutput
Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.
-
#create_stack_set(params = {}) ⇒ Types::CreateStackSetOutput
Creates a StackSet.
-
#deactivate_organizations_access(params = {}) ⇒ Struct
Deactivates trusted access with Organizations.
-
#deactivate_type(params = {}) ⇒ Struct
Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.
-
#delete_change_set(params = {}) ⇒ Struct
Deletes the specified change set.
-
#delete_generated_template(params = {}) ⇒ Struct
Deleted a generated template.
-
#delete_stack(params = {}) ⇒ Struct
Deletes a specified stack.
-
#delete_stack_instances(params = {}) ⇒ Types::DeleteStackInstancesOutput
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
-
#delete_stack_set(params = {}) ⇒ Struct
Deletes a StackSet.
-
#deregister_type(params = {}) ⇒ Struct
Marks an extension or extension version as
DEPRECATED
in the CloudFormation registry, removing it from active use. -
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.
-
#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetOutput
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.
-
#describe_change_set_hooks(params = {}) ⇒ Types::DescribeChangeSetHooksOutput
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
-
#describe_generated_template(params = {}) ⇒ Types::DescribeGeneratedTemplateOutput
Describes a generated template.
-
#describe_organizations_access(params = {}) ⇒ Types::DescribeOrganizationsAccessOutput
Retrieves information about the account's
OrganizationAccess
status. -
#describe_publisher(params = {}) ⇒ Types::DescribePublisherOutput
Returns information about a CloudFormation extension publisher.
-
#describe_resource_scan(params = {}) ⇒ Types::DescribeResourceScanOutput
Describes details of a resource scan.
-
#describe_stack_drift_detection_status(params = {}) ⇒ Types::DescribeStackDriftDetectionStatusOutput
Returns information about a stack drift detection operation.
-
#describe_stack_events(params = {}) ⇒ Types::DescribeStackEventsOutput
Returns all stack related events for a specified stack in reverse chronological order.
-
#describe_stack_instance(params = {}) ⇒ Types::DescribeStackInstanceOutput
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
-
#describe_stack_refactor(params = {}) ⇒ Types::DescribeStackRefactorOutput
Describes the stack refactor status.
-
#describe_stack_resource(params = {}) ⇒ Types::DescribeStackResourceOutput
Returns a description of the specified resource in the specified stack.
-
#describe_stack_resource_drifts(params = {}) ⇒ Types::DescribeStackResourceDriftsOutput
Returns drift information for the resources that have been checked for drift in the specified stack.
-
#describe_stack_resources(params = {}) ⇒ Types::DescribeStackResourcesOutput
Returns Amazon Web Services resource descriptions for running and deleted stacks.
-
#describe_stack_set(params = {}) ⇒ Types::DescribeStackSetOutput
Returns the description of the specified StackSet.
-
#describe_stack_set_operation(params = {}) ⇒ Types::DescribeStackSetOperationOutput
Returns the description of the specified StackSet operation.
-
#describe_stacks(params = {}) ⇒ Types::DescribeStacksOutput
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
-
#describe_type(params = {}) ⇒ Types::DescribeTypeOutput
Returns detailed information about an extension from the CloudFormation registry in your current account and Region.
-
#describe_type_registration(params = {}) ⇒ Types::DescribeTypeRegistrationOutput
Returns information about an extension's registration, including its current status and type and version identifiers.
-
#detect_stack_drift(params = {}) ⇒ Types::DetectStackDriftOutput
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
-
#detect_stack_resource_drift(params = {}) ⇒ Types::DetectStackResourceDriftOutput
Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
-
#detect_stack_set_drift(params = {}) ⇒ Types::DetectStackSetDriftOutput
Detect drift on a StackSet.
-
#estimate_template_cost(params = {}) ⇒ Types::EstimateTemplateCostOutput
Returns the estimated monthly cost of a template.
-
#execute_change_set(params = {}) ⇒ Struct
Updates a stack using the input information that was provided when the specified change set was created.
-
#execute_stack_refactor(params = {}) ⇒ Struct
Executes the stack refactor operation.
-
#get_generated_template(params = {}) ⇒ Types::GetGeneratedTemplateOutput
Retrieves a generated template.
-
#get_stack_policy(params = {}) ⇒ Types::GetStackPolicyOutput
Returns the stack policy for a specified stack.
-
#get_template(params = {}) ⇒ Types::GetTemplateOutput
Returns the template body for a specified stack.
-
#get_template_summary(params = {}) ⇒ Types::GetTemplateSummaryOutput
Returns information about a new or existing template.
-
#import_stacks_to_stack_set(params = {}) ⇒ Types::ImportStacksToStackSetOutput
Import existing stacks into a new StackSets.
-
#list_change_sets(params = {}) ⇒ Types::ListChangeSetsOutput
Returns the ID and status of each active change set for a stack.
-
#list_exports(params = {}) ⇒ Types::ListExportsOutput
Lists all exported output values in the account and Region in which you call this action.
-
#list_generated_templates(params = {}) ⇒ Types::ListGeneratedTemplatesOutput
Lists your generated templates in this Region.
-
#list_hook_results(params = {}) ⇒ Types::ListHookResultsOutput
Returns summaries of invoked Hooks.
-
#list_imports(params = {}) ⇒ Types::ListImportsOutput
Lists all stacks that are importing an exported output value.
-
#list_resource_scan_related_resources(params = {}) ⇒ Types::ListResourceScanRelatedResourcesOutput
Lists the related resources for a list of resources from a resource scan.
-
#list_resource_scan_resources(params = {}) ⇒ Types::ListResourceScanResourcesOutput
Lists the resources from a resource scan.
-
#list_resource_scans(params = {}) ⇒ Types::ListResourceScansOutput
List the resource scans from newest to oldest.
-
#list_stack_instance_resource_drifts(params = {}) ⇒ Types::ListStackInstanceResourceDriftsOutput
Returns drift information for resources in a stack instance.
-
#list_stack_instances(params = {}) ⇒ Types::ListStackInstancesOutput
Returns summary information about stack instances that are associated with the specified StackSet.
-
#list_stack_refactor_actions(params = {}) ⇒ Types::ListStackRefactorActionsOutput
Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.
-
#list_stack_refactors(params = {}) ⇒ Types::ListStackRefactorsOutput
Lists all account stack refactor operations and their statuses.
-
#list_stack_resources(params = {}) ⇒ Types::ListStackResourcesOutput
Returns descriptions of all resources of the specified stack.
-
#list_stack_set_auto_deployment_targets(params = {}) ⇒ Types::ListStackSetAutoDeploymentTargetsOutput
Returns summary information about deployment targets for a StackSet.
-
#list_stack_set_operation_results(params = {}) ⇒ Types::ListStackSetOperationResultsOutput
Returns summary information about the results of a StackSet operation.
-
#list_stack_set_operations(params = {}) ⇒ Types::ListStackSetOperationsOutput
Returns summary information about operations performed on a StackSet.
-
#list_stack_sets(params = {}) ⇒ Types::ListStackSetsOutput
Returns summary information about StackSets that are associated with the user.
-
#list_stacks(params = {}) ⇒ Types::ListStacksOutput
Returns the summary information for stacks whose status matches the specified
StackStatusFilter
. -
#list_type_registrations(params = {}) ⇒ Types::ListTypeRegistrationsOutput
Returns a list of registration tokens for the specified extension(s).
-
#list_type_versions(params = {}) ⇒ Types::ListTypeVersionsOutput
Returns summary information about the versions of an extension.
-
#list_types(params = {}) ⇒ Types::ListTypesOutput
Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.
-
#publish_type(params = {}) ⇒ Types::PublishTypeOutput
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
-
#record_handler_progress(params = {}) ⇒ Struct
Reports progress of a resource handler to CloudFormation.
-
#register_publisher(params = {}) ⇒ Types::RegisterPublisherOutput
Registers your account as a publisher of public extensions in the CloudFormation registry.
-
#register_type(params = {}) ⇒ Types::RegisterTypeOutput
Registers an extension with the CloudFormation service.
-
#rollback_stack(params = {}) ⇒ Types::RollbackStackOutput
When specifying
RollbackStack
, you preserve the state of previously provisioned resources when an operation fails. -
#set_stack_policy(params = {}) ⇒ Struct
Sets a stack policy for a specified stack.
-
#set_type_configuration(params = {}) ⇒ Types::SetTypeConfigurationOutput
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
-
#set_type_default_version(params = {}) ⇒ Struct
Specify the default version of an extension.
-
#signal_resource(params = {}) ⇒ Struct
Sends a signal to the specified resource with a success or failure status.
-
#start_resource_scan(params = {}) ⇒ Types::StartResourceScanOutput
Starts a scan of the resources in this account in this Region.
-
#stop_stack_set_operation(params = {}) ⇒ Struct
Stops an in-progress operation on a StackSet and its associated stack instances.
-
#test_type(params = {}) ⇒ Types::TestTypeOutput
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
-
#update_generated_template(params = {}) ⇒ Types::UpdateGeneratedTemplateOutput
Updates a generated template.
-
#update_stack(params = {}) ⇒ Types::UpdateStackOutput
Updates a stack as specified in the template.
-
#update_stack_instances(params = {}) ⇒ Types::UpdateStackInstancesOutput
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.
-
#update_stack_set(params = {}) ⇒ Types::UpdateStackSetOutput
Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions.
-
#update_termination_protection(params = {}) ⇒ Types::UpdateTerminationProtectionOutput
Updates termination protection for the specified stack.
-
#validate_template(params = {}) ⇒ Types::ValidateTemplateOutput
Validates a specified template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#activate_organizations_access(params = {}) ⇒ Struct
Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
489 490 491 492 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 489 def activate_organizations_access(params = {}, = {}) req = build_request(:activate_organizations_access, params) req.send_request() end |
#activate_type(params = {}) ⇒ Types::ActivateTypeOutput
Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.
After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.
To see which extensions have been activated, use ListTypes. To see configuration details for an extension, use DescribeType.
For more information, see Activate a third-party public extension in your account in the CloudFormation User Guide. For information about creating Hooks, see the CloudFormation Hooks User Guide.
617 618 619 620 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 617 def activate_type(params = {}, = {}) req = build_request(:activate_type, params) req.send_request() end |
#batch_describe_type_configurations(params = {}) ⇒ Types::BatchDescribeTypeConfigurationsOutput
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.
For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
685 686 687 688 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 685 def batch_describe_type_configurations(params = {}, = {}) req = build_request(:batch_describe_type_configurations, params) req.send_request() end |
#cancel_update_stack(params = {}) ⇒ Struct
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
UPDATE_IN_PROGRESS
state.
734 735 736 737 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 734 def cancel_update_stack(params = {}, = {}) req = build_request(:cancel_update_stack, params) req.send_request() end |
#continue_update_rollback(params = {}) ⇒ Struct
Continues rolling back a stack from UPDATE_ROLLBACK_FAILED
to
UPDATE_ROLLBACK_COMPLETE
state. Depending on the cause of the
failure, you can manually fix the error and continue the rollback. By
continuing the rollback, you can return your stack to a working state
(the UPDATE_ROLLBACK_COMPLETE
state) and then try to update the
stack again.
A stack enters the UPDATE_ROLLBACK_FAILED
state when CloudFormation
can't roll back all changes after a failed stack update. For example,
this might occur when a stack attempts to roll back to an old database
that was deleted outside of CloudFormation. Because CloudFormation
doesn't know the instance was deleted, it assumes the instance still
exists and attempts to roll back to it, causing the update rollback to
fail.
For more information, see Continue rolling back an update in the CloudFormation User Guide. For information for troubleshooting a failed update rollback, see Update rollback failed.
854 855 856 857 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 854 def continue_update_rollback(params = {}, = {}) req = build_request(:continue_update_rollback, params) req.send_request() end |
#create_change_set(params = {}) ⇒ Types::CreateChangeSetOutput
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the
ChangeSetType
parameter, specify CREATE
. To create a change set
for an existing stack, specify UPDATE
for the ChangeSetType
parameter. To create a change set for an import operation, specify
IMPORT
for the ChangeSetType
parameter. After the
CreateChangeSet
call successfully completes, CloudFormation starts
creating the change set. To check the status of the change set or to
review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set
IncludeNestedStacks
to True
.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1215 def create_change_set(params = {}, = {}) req = build_request(:create_change_set, params) req.send_request() end |
#create_generated_template(params = {}) ⇒ Types::CreateGeneratedTemplateOutput
Creates a template from existing resources that are not already
managed with CloudFormation. You can check the status of the template
generation using the DescribeGeneratedTemplate
API action.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1303 def create_generated_template(params = {}, = {}) req = build_request(:create_generated_template, params) req.send_request() end |
#create_stack(params = {}) ⇒ Types::CreateStackOutput
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1650 def create_stack(params = {}, = {}) req = build_request(:create_stack, params) req.send_request() end |
#create_stack_instances(params = {}) ⇒ Types::CreateStackInstancesOutput
Creates stack instances for the specified accounts, within the
specified Amazon Web Services Regions. A stack instance refers to a
stack in a specific account and Region. You must specify at least one
value for either Accounts
or DeploymentTargets
, and you must
specify at least one value for Regions
.
CreateStackInstances
operation is 50.
If you need more than 50, consider the following options:
Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1819 def create_stack_instances(params = {}, = {}) req = build_request(:create_stack_instances, params) req.send_request() end |
#create_stack_refactor(params = {}) ⇒ Types::CreateStackRefactorOutput
Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.
1878 1879 1880 1881 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1878 def create_stack_refactor(params = {}, = {}) req = build_request(:create_stack_refactor, params) req.send_request() end |
#create_stack_set(params = {}) ⇒ Types::CreateStackSetOutput
Creates a StackSet.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2161 def create_stack_set(params = {}, = {}) req = build_request(:create_stack_set, params) req.send_request() end |
#deactivate_organizations_access(params = {}) ⇒ Struct
Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
2176 2177 2178 2179 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2176 def deactivate_organizations_access(params = {}, = {}) req = build_request(:deactivate_organizations_access, params) req.send_request() end |
#deactivate_type(params = {}) ⇒ Struct
Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.
Deactivating an extension deletes the configuration details that are associated with it. To temporary disable a CloudFormation Hook instead, you can use SetTypeConfiguration.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
To see which extensions are currently activated, use ListTypes.
2233 2234 2235 2236 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2233 def deactivate_type(params = {}, = {}) req = build_request(:deactivate_type, params) req.send_request() end |
#delete_change_set(params = {}) ⇒ Struct
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If IncludeNestedStacks
specifies True
during the creation of the
nested change set, then DeleteChangeSet
will delete all change sets
that belong to the stacks hierarchy and will also delete all change
sets for nested stacks with the status of REVIEW_IN_PROGRESS
.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2270 def delete_change_set(params = {}, = {}) req = build_request(:delete_change_set, params) req.send_request() end |
#delete_generated_template(params = {}) ⇒ Struct
Deleted a generated template.
2301 2302 2303 2304 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2301 def delete_generated_template(params = {}, = {}) req = build_request(:delete_generated_template, params) req.send_request() end |
#delete_stack(params = {}) ⇒ Struct
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.
2385 2386 2387 2388 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2385 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_stack_instances(params = {}) ⇒ Types::DeleteStackInstancesOutput
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
DeleteStackInstances
operation is 50.
If you need more than 50, consider the following options:
Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.
2518 2519 2520 2521 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2518 def delete_stack_instances(params = {}, = {}) req = build_request(:delete_stack_instances, params) req.send_request() end |
#delete_stack_set(params = {}) ⇒ Struct
Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
2566 2567 2568 2569 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2566 def delete_stack_set(params = {}, = {}) req = build_request(:delete_stack_set, params) req.send_request() end |
#deregister_type(params = {}) ⇒ Struct
Marks an extension or extension version as DEPRECATED
in the
CloudFormation registry, removing it from active use. Deprecated
extensions or extension versions cannot be used in CloudFormation
operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
For more information, see Remove third-party private extensions from your account in the CloudFormation User Guide.
2633 2634 2635 2636 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2633 def deregister_type(params = {}, = {}) req = build_request(:deregister_type, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2675 2676 2677 2678 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2675 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetOutput
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- change_set_create_complete
2808 2809 2810 2811 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2808 def describe_change_set(params = {}, = {}) req = build_request(:describe_change_set, params) req.send_request() end |
#describe_change_set_hooks(params = {}) ⇒ Types::DescribeChangeSetHooksOutput
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
2875 2876 2877 2878 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2875 def describe_change_set_hooks(params = {}, = {}) req = build_request(:describe_change_set_hooks, params) req.send_request() end |
#describe_generated_template(params = {}) ⇒ Types::DescribeGeneratedTemplateOutput
Describes a generated template. The output includes details about the
progress of the creation of a generated template started by a
CreateGeneratedTemplate
API action or the update of a generated
template started with an UpdateGeneratedTemplate
API action.
2972 2973 2974 2975 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2972 def describe_generated_template(params = {}, = {}) req = build_request(:describe_generated_template, params) req.send_request() end |
#describe_organizations_access(params = {}) ⇒ Types::DescribeOrganizationsAccessOutput
Retrieves information about the account's OrganizationAccess
status. This API can be called either by the management account or the
delegated administrator by using the CallAs
parameter. This API can
also be called without the CallAs
parameter by the management
account.
3022 3023 3024 3025 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3022 def describe_organizations_access(params = {}, = {}) req = build_request(:describe_organizations_access, params) req.send_request() end |
#describe_publisher(params = {}) ⇒ Types::DescribePublisherOutput
Returns information about a CloudFormation extension publisher.
If you don't supply a PublisherId
, and you have registered as an
extension publisher, DescribePublisher
returns information about
your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide
3076 3077 3078 3079 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3076 def describe_publisher(params = {}, = {}) req = build_request(:describe_publisher, params) req.send_request() end |
#describe_resource_scan(params = {}) ⇒ Types::DescribeResourceScanOutput
Describes details of a resource scan.
3220 3221 3222 3223 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3220 def describe_resource_scan(params = {}, = {}) req = build_request(:describe_resource_scan, params) req.send_request() end |
#describe_stack_drift_detection_status(params = {}) ⇒ Types::DescribeStackDriftDetectionStatusOutput
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift to initiate a stack drift detection operation.
DetectStackDrift
returns a StackDriftDetectionId
you can use to
monitor the progress of the operation using
DescribeStackDriftDetectionStatus
. Once the drift detection
operation has completed, use DescribeStackResourceDrifts to return
drift information about the stack and its resources.
3284 3285 3286 3287 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3284 def describe_stack_drift_detection_status(params = {}, = {}) req = build_request(:describe_stack_drift_detection_status, params) req.send_request() end |
#describe_stack_events(params = {}) ⇒ Types::DescribeStackEventsOutput
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3357 def describe_stack_events(params = {}, = {}) req = build_request(:describe_stack_events, params) req.send_request() end |
#describe_stack_instance(params = {}) ⇒ Types::DescribeStackInstanceOutput
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
3437 3438 3439 3440 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3437 def describe_stack_instance(params = {}, = {}) req = build_request(:describe_stack_instance, params) req.send_request() end |
#describe_stack_refactor(params = {}) ⇒ Types::DescribeStackRefactorOutput
Describes the stack refactor status.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- stack_refactor_create_complete
- stack_refactor_execute_complete
3485 3486 3487 3488 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3485 def describe_stack_refactor(params = {}, = {}) req = build_request(:describe_stack_refactor, params) req.send_request() end |
#describe_stack_resource(params = {}) ⇒ Types::DescribeStackResourceOutput
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
3540 3541 3542 3543 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3540 def describe_stack_resource(params = {}, = {}) req = build_request(:describe_stack_resource, params) req.send_request() end |
#describe_stack_resource_drifts(params = {}) ⇒ Types::DescribeStackResourceDriftsOutput
Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift
for each
stack resource that has been checked for drift. Resources that
haven't yet been checked for drift aren't included. Resources that
don't currently support drift detection aren't checked, and so not
included. For a list of resources that support drift detection, see
Resource type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3640 3641 3642 3643 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3640 def describe_stack_resource_drifts(params = {}, = {}) req = build_request(:describe_stack_resource_drifts, params) req.send_request() end |
#describe_stack_resources(params = {}) ⇒ Types::DescribeStackResourcesOutput
Returns Amazon Web Services resource descriptions for running and
deleted stacks. If StackName
is specified, all the associated
resources that are part of the stack are returned. If
PhysicalResourceId
is specified, the associated resources of the
stack that the resource belongs to are returned.
ListStackResources
instead.
For deleted stacks, DescribeStackResources
returns resource
information for up to 90 days after the stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not
both. In addition, you can specify LogicalResourceId
to filter the
returned result. For more information about resources, the
LogicalResourceId
and PhysicalResourceId
, see the CloudFormation
User Guide.
ValidationError
is returned if you specify both StackName
and
PhysicalResourceId
in the same request.
3734 3735 3736 3737 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3734 def describe_stack_resources(params = {}, = {}) req = build_request(:describe_stack_resources, params) req.send_request() end |
#describe_stack_set(params = {}) ⇒ Types::DescribeStackSetOutput
Returns the description of the specified StackSet.
3823 3824 3825 3826 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3823 def describe_stack_set(params = {}, = {}) req = build_request(:describe_stack_set, params) req.send_request() end |
#describe_stack_set_operation(params = {}) ⇒ Types::DescribeStackSetOperationOutput
Returns the description of the specified StackSet operation.
3916 3917 3918 3919 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3916 def describe_stack_set_operation(params = {}, = {}) req = build_request(:describe_stack_set_operation, params) req.send_request() end |
#describe_stacks(params = {}) ⇒ Types::DescribeStacksOutput
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
ValidationError
is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- stack_create_complete
- stack_delete_complete
- stack_exists
- stack_import_complete
- stack_rollback_complete
- stack_update_complete
4040 4041 4042 4043 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4040 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_type(params = {}) ⇒ Types::DescribeTypeOutput
Returns detailed information about an extension from the CloudFormation registry in your current account and Region.
If you specify a VersionId
, DescribeType
returns information about
that specific extension version. Otherwise, it returns information
about the default extension version.
4166 4167 4168 4169 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4166 def describe_type(params = {}, = {}) req = build_request(:describe_type, params) req.send_request() end |
#describe_type_registration(params = {}) ⇒ Types::DescribeTypeRegistrationOutput
Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- type_registration_complete
4216 4217 4218 4219 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4216 def describe_type_registration(params = {}, = {}) req = build_request(:describe_type_registration, params) req.send_request() end |
#detect_stack_drift(params = {}) ⇒ Types::DetectStackDriftOutput
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift
to detect drift on all supported resources for
a given stack, or DetectStackResourceDrift to detect drift on
individual resources.
For a list of stack resources that currently support drift detection, see Resource type support for imports and drift detection.
DetectStackDrift
can take up to several minutes, depending on the
number of resources contained within the stack. Use
DescribeStackDriftDetectionStatus to monitor the progress of a detect
stack drift operation. Once the drift detection operation has
completed, use DescribeStackResourceDrifts to return drift information
about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift
on any nested stacks belonging to that stack. Perform
DetectStackDrift
directly on the nested stack itself.
4281 4282 4283 4284 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4281 def detect_stack_drift(params = {}, = {}) req = build_request(:detect_stack_drift, params) req.send_request() end |
#detect_stack_resource_drift(params = {}) ⇒ Types::DetectStackResourceDriftOutput
Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackResourceDrift
to detect drift on individual
resources, or DetectStackDrift to detect drift on all resources in a
given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.
4353 4354 4355 4356 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4353 def detect_stack_resource_drift(params = {}, = {}) req = build_request(:detect_stack_resource_drift, params) req.send_request() end |
#detect_stack_set_drift(params = {}) ⇒ Types::DetectStackSetDriftOutput
Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see Performing drift detection on CloudFormation StackSets.
DetectStackSetDrift
returns the OperationId
of the StackSet drift
detection operation. Use this operation id with
DescribeStackSetOperation to monitor the progress of the drift
detection operation. The drift detection operation may take some time,
depending on the number of stack instances included in the StackSet,
in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the StackSet, including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
You can only run a single drift detection operation on a given StackSet at one time.
To stop a drift detection StackSet operation, use StopStackSetOperation.
4469 4470 4471 4472 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4469 def detect_stack_set_drift(params = {}, = {}) req = build_request(:detect_stack_set_drift, params) req.send_request() end |
#estimate_template_cost(params = {}) ⇒ Types::EstimateTemplateCostOutput
Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
4524 4525 4526 4527 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4524 def estimate_template_cost(params = {}, = {}) req = build_request(:estimate_template_cost, params) req.send_request() end |
#execute_change_set(params = {}) ⇒ Struct
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy,
IncludeNestedStacks
must have been set to True
.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4604 def execute_change_set(params = {}, = {}) req = build_request(:execute_change_set, params) req.send_request() end |
#execute_stack_refactor(params = {}) ⇒ Struct
Executes the stack refactor operation.
4627 4628 4629 4630 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4627 def execute_stack_refactor(params = {}, = {}) req = build_request(:execute_stack_refactor, params) req.send_request() end |
#get_generated_template(params = {}) ⇒ Types::GetGeneratedTemplateOutput
Retrieves a generated template. If the template is in an InProgress
or Pending
status then the template returned will be the template
when the template was last in a Complete
status. If the template has
not yet been in a Complete
status then an empty template will be
returned.
4705 4706 4707 4708 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4705 def get_generated_template(params = {}, = {}) req = build_request(:get_generated_template, params) req.send_request() end |
#get_stack_policy(params = {}) ⇒ Types::GetStackPolicyOutput
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
4735 4736 4737 4738 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4735 def get_stack_policy(params = {}, = {}) req = build_request(:get_stack_policy, params) req.send_request() end |
#get_template(params = {}) ⇒ Types::GetTemplateOutput
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate
returns the template for up to 90
days after the stack has been deleted.
ValidationError
is returned.
4797 4798 4799 4800 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4797 def get_template(params = {}, = {}) req = build_request(:get_template, params) req.send_request() end |
#get_template_summary(params = {}) ⇒ Types::GetTemplateSummaryOutput
Returns information about a new or existing template. The
GetTemplateSummary
action is useful for viewing parameter
information, such as default parameter values and parameter types,
before you create or update a stack or StackSet.
You can use the GetTemplateSummary
action when you submit a
template, or you can get template information for a StackSet, or a
running or deleted stack.
For deleted stacks, GetTemplateSummary
returns the template
information for up to 90 days after the stack has been deleted. If the
template doesn't exist, a ValidationError
is returned.
4931 4932 4933 4934 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4931 def get_template_summary(params = {}, = {}) req = build_request(:get_template_summary, params) req.send_request() end |
#import_stacks_to_stack_set(params = {}) ⇒ Types::ImportStacksToStackSetOutput
Import existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
5018 5019 5020 5021 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5018 def import_stacks_to_stack_set(params = {}, = {}) req = build_request(:import_stacks_to_stack_set, params) req.send_request() end |
#list_change_sets(params = {}) ⇒ Types::ListChangeSetsOutput
Returns the ID and status of each active change set for a stack. For
example, CloudFormation lists change sets that are in the
CREATE_IN_PROGRESS
or CREATE_PENDING
state.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5071 5072 5073 5074 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5071 def list_change_sets(params = {}, = {}) req = build_request(:list_change_sets, params) req.send_request() end |
#list_exports(params = {}) ⇒ Types::ListExportsOutput
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see Get exported outputs from a deployed CloudFormation stack.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5118 5119 5120 5121 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5118 def list_exports(params = {}, = {}) req = build_request(:list_exports, params) req.send_request() end |
#list_generated_templates(params = {}) ⇒ Types::ListGeneratedTemplatesOutput
Lists your generated templates in this Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5206 5207 5208 5209 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5206 def list_generated_templates(params = {}, = {}) req = build_request(:list_generated_templates, params) req.send_request() end |
#list_hook_results(params = {}) ⇒ Types::ListHookResultsOutput
Returns summaries of invoked Hooks. For more information, see View CloudFormation Hooks invocations in the CloudFormation Hooks User Guide.
This operation supports the following parameter combinations:
No parameters: Returns all Hook invocation summaries.
TypeArn
only: Returns summaries for a specific Hook.TypeArn
andStatus
: Returns summaries for a specific Hook filtered by status.TargetId
andTargetType
: Returns summaries for a specific Hook invocation target.
5313 5314 5315 5316 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5313 def list_hook_results(params = {}, = {}) req = build_request(:list_hook_results, params) req.send_request() end |
#list_imports(params = {}) ⇒ Types::ListImportsOutput
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5363 5364 5365 5366 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5363 def list_imports(params = {}, = {}) req = build_request(:list_imports, params) req.send_request() end |
#list_resource_scan_related_resources(params = {}) ⇒ Types::ListResourceScanRelatedResourcesOutput
Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5484 5485 5486 5487 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5484 def (params = {}, = {}) req = build_request(:list_resource_scan_related_resources, params) req.send_request() end |
#list_resource_scan_resources(params = {}) ⇒ Types::ListResourceScanResourcesOutput
Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5616 5617 5618 5619 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5616 def list_resource_scan_resources(params = {}, = {}) req = build_request(:list_resource_scan_resources, params) req.send_request() end |
#list_resource_scans(params = {}) ⇒ Types::ListResourceScansOutput
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5695 5696 5697 5698 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5695 def list_resource_scans(params = {}, = {}) req = build_request(:list_resource_scans, params) req.send_request() end |
#list_stack_instance_resource_drifts(params = {}) ⇒ Types::ListStackInstanceResourceDriftsOutput
Returns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts
returns drift information for the
most recent drift detection operation. If an operation is in progress,
it may only return partial results.
5813 5814 5815 5816 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5813 def list_stack_instance_resource_drifts(params = {}, = {}) req = build_request(:list_stack_instance_resource_drifts, params) req.send_request() end |
#list_stack_instances(params = {}) ⇒ Types::ListStackInstancesOutput
Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5917 5918 5919 5920 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5917 def list_stack_instances(params = {}, = {}) req = build_request(:list_stack_instances, params) req.send_request() end |
#list_stack_refactor_actions(params = {}) ⇒ Types::ListStackRefactorActionsOutput
Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5982 5983 5984 5985 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5982 def list_stack_refactor_actions(params = {}, = {}) req = build_request(:list_stack_refactor_actions, params) req.send_request() end |
#list_stack_refactors(params = {}) ⇒ Types::ListStackRefactorsOutput
Lists all account stack refactor operations and their statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6037 6038 6039 6040 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6037 def list_stack_refactors(params = {}, = {}) req = build_request(:list_stack_refactors, params) req.send_request() end |
#list_stack_resources(params = {}) ⇒ Types::ListStackResourcesOutput
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6093 6094 6095 6096 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6093 def list_stack_resources(params = {}, = {}) req = build_request(:list_stack_resources, params) req.send_request() end |
#list_stack_set_auto_deployment_targets(params = {}) ⇒ Types::ListStackSetAutoDeploymentTargetsOutput
Returns summary information about deployment targets for a StackSet.
6162 6163 6164 6165 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6162 def list_stack_set_auto_deployment_targets(params = {}, = {}) req = build_request(:list_stack_set_auto_deployment_targets, params) req.send_request() end |
#list_stack_set_operation_results(params = {}) ⇒ Types::ListStackSetOperationResultsOutput
Returns summary information about the results of a StackSet operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6259 6260 6261 6262 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6259 def list_stack_set_operation_results(params = {}, = {}) req = build_request(:list_stack_set_operation_results, params) req.send_request() end |
#list_stack_set_operations(params = {}) ⇒ Types::ListStackSetOperationsOutput
Returns summary information about operations performed on a StackSet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6352 6353 6354 6355 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6352 def list_stack_set_operations(params = {}, = {}) req = build_request(:list_stack_set_operations, params) req.send_request() end |
#list_stack_sets(params = {}) ⇒ Types::ListStackSetsOutput
Returns summary information about StackSets that are associated with the user.
[Self-managed permissions] If you set the
CallAs
parameter toSELF
while signed in to your Amazon Web Services account,ListStackSets
returns all self-managed StackSets in your Amazon Web Services account.[Service-managed permissions] If you set the
CallAs
parameter toSELF
while signed in to the organization's management account,ListStackSets
returns all StackSets in the management account.[Service-managed permissions] If you set the
CallAs
parameter toDELEGATED_ADMIN
while signed in to your member account,ListStackSets
returns all StackSets with service-managed permissions in the management account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6454 6455 6456 6457 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6454 def list_stack_sets(params = {}, = {}) req = build_request(:list_stack_sets, params) req.send_request() end |
#list_stacks(params = {}) ⇒ Types::ListStacksOutput
Returns the summary information for stacks whose status matches the
specified StackStatusFilter
. Summary information for stacks that
have been deleted is kept for 90 days after the stack is deleted. If
no StackStatusFilter
is specified, summary information for all
stacks is returned (including existing stacks and stacks that have
been deleted).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6511 6512 6513 6514 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6511 def list_stacks(params = {}, = {}) req = build_request(:list_stacks, params) req.send_request() end |
#list_type_registrations(params = {}) ⇒ Types::ListTypeRegistrationsOutput
Returns a list of registration tokens for the specified extension(s).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6580 6581 6582 6583 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6580 def list_type_registrations(params = {}, = {}) req = build_request(:list_type_registrations, params) req.send_request() end |
#list_type_versions(params = {}) ⇒ Types::ListTypeVersionsOutput
Returns summary information about the versions of an extension.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6674 6675 6676 6677 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6674 def list_type_versions(params = {}, = {}) req = build_request(:list_type_versions, params) req.send_request() end |
#list_types(params = {}) ⇒ Types::ListTypesOutput
Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6806 6807 6808 6809 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6806 def list_types(params = {}, = {}) req = build_request(:list_types, params) req.send_request() end |
#publish_type(params = {}) ⇒ Types::PublishTypeOutput
Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
6883 6884 6885 6886 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6883 def publish_type(params = {}, = {}) req = build_request(:publish_type, params) req.send_request() end |
#record_handler_progress(params = {}) ⇒ Struct
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
6964 6965 6966 6967 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6964 def record_handler_progress(params = {}, = {}) req = build_request(:record_handler_progress, params) req.send_request() end |
#register_publisher(params = {}) ⇒ Types::RegisterPublisherOutput
Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
7029 7030 7031 7032 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7029 def register_publisher(params = {}, = {}) req = build_request(:register_publisher, params) req.send_request() end |
#register_type(params = {}) ⇒ Types::RegisterTypeOutput
Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating resource types using the CloudFormation CLI in the CloudFormation Command Line Interface (CLI) User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
7187 7188 7189 7190 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7187 def register_type(params = {}, = {}) req = build_request(:register_type, params) req.send_request() end |
#rollback_stack(params = {}) ⇒ Types::RollbackStackOutput
When specifying RollbackStack
, you preserve the state of previously
provisioned resources when an operation fails. You can check the
status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from
CREATE_FAILED
or UPDATE_FAILED
stack statuses.
This operation will delete a stack if it doesn't contain a last known
stable state. A last known stable state includes any status in a
*_COMPLETE
. This includes the following stack statuses.
CREATE_COMPLETE
UPDATE_COMPLETE
UPDATE_ROLLBACK_COMPLETE
IMPORT_COMPLETE
IMPORT_ROLLBACK_COMPLETE
7251 7252 7253 7254 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7251 def rollback_stack(params = {}, = {}) req = build_request(:rollback_stack, params) req.send_request() end |
#set_stack_policy(params = {}) ⇒ Struct
Sets a stack policy for a specified stack.
7295 7296 7297 7298 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7295 def set_stack_policy(params = {}, = {}) req = build_request(:set_stack_policy, params) req.send_request() end |
#set_type_configuration(params = {}) ⇒ Types::SetTypeConfigurationOutput
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the
ConfigurationSchema
element of DescribeType. For more
information, see Edit configuration data for extensions in your
account in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.
7392 7393 7394 7395 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7392 def set_type_configuration(params = {}, = {}) req = build_request(:set_type_configuration, params) req.send_request() end |
#set_type_default_version(params = {}) ⇒ Struct
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
7436 7437 7438 7439 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7436 def set_type_default_version(params = {}, = {}) req = build_request(:set_type_default_version, params) req.send_request() end |
#signal_resource(params = {}) ⇒ Struct
Sends a signal to the specified resource with a success or failure
status. You can use the SignalResource
operation in conjunction with
a creation policy or update policy. CloudFormation doesn't proceed
with a stack creation or update until resources receive the required
number of signals or the timeout period is exceeded. The
SignalResource
operation is useful in cases where you want to send
signals from anywhere other than an Amazon EC2 instance.
7484 7485 7486 7487 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7484 def signal_resource(params = {}, = {}) req = build_request(:signal_resource, params) req.send_request() end |
#start_resource_scan(params = {}) ⇒ Types::StartResourceScanOutput
Starts a scan of the resources in this account in this Region. You can
the status of a scan using the ListResourceScans
API action.
7536 7537 7538 7539 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7536 def start_resource_scan(params = {}, = {}) req = build_request(:start_resource_scan, params) req.send_request() end |
#stop_stack_set_operation(params = {}) ⇒ Struct
Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
7589 7590 7591 7592 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7589 def stop_stack_set_operation(params = {}, = {}) req = build_request(:stop_stack_set_operation, params) req.send_request() end |
#test_type(params = {}) ⇒ Types::TestTypeOutput
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension before publishing in the CloudFormation Command Line Interface (CLI) User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType
, you
can pass the returned TypeVersionArn
into DescribeType to
monitor the current test status and test status description for the
extension.
An extension must have a test status of PASSED
before it can be
published. For more information, see Publishing extensions to make
them available for public use in the CloudFormation Command Line
Interface (CLI) User Guide.
7700 7701 7702 7703 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7700 def test_type(params = {}, = {}) req = build_request(:test_type, params) req.send_request() end |
#update_generated_template(params = {}) ⇒ Types::UpdateGeneratedTemplateOutput
Updates a generated template. This can be used to change the name, add
and remove resources, refresh resources, and change the
DeletionPolicy
and UpdateReplacePolicy
settings. You can check the
status of the update to the generated template using the
DescribeGeneratedTemplate
API action.
7828 7829 7830 7831 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7828 def update_generated_template(params = {}, = {}) req = build_request(:update_generated_template, params) req.send_request() end |
#update_stack(params = {}) ⇒ Types::UpdateStackOutput
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
8172 8173 8174 8175 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8172 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#update_stack_instances(params = {}) ⇒ Types::UpdateStackInstancesOutput
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During StackSet updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the
StackSet. To add or delete a parameter itself, use UpdateStackSet
to update the StackSet template. If you add a parameter to a template,
before you can override the parameter value specified in the StackSet
you must first use UpdateStackSet to update all stack instances
with the updated template and parameter value specified in the
StackSet. Once a stack instance has been updated with the new
parameter, you can then override the parameter value using
UpdateStackInstances
.
UpdateStackInstances
operation is 50.
If you need more than 50, consider the following options:
Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.
8371 8372 8373 8374 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8371 def update_stack_instances(params = {}, = {}) req = build_request(:update_stack_instances, params) req.send_request() end |
#update_stack_set(params = {}) ⇒ Types::UpdateStackSetOutput
Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent CreateStackInstances calls on the specified StackSet use the updated StackSet.
UpdateStackSet
operation is 50.
If you need more than 50, consider the following options:
Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.
8770 8771 8772 8773 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8770 def update_stack_set(params = {}, = {}) req = build_request(:update_stack_set, params) req.send_request() end |
#update_termination_protection(params = {}) ⇒ Types::UpdateTerminationProtectionOutput
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
8815 8816 8817 8818 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8815 def update_termination_protection(params = {}, = {}) req = build_request(:update_termination_protection, params) req.send_request() end |
#validate_template(params = {}) ⇒ Types::ValidateTemplateOutput
Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
8874 8875 8876 8877 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8874 def validate_template(params = {}, = {}) req = build_request(:validate_template, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
change_set_create_complete | #describe_change_set | 30 | 120 |
stack_create_complete | #describe_stacks | 30 | 120 |
stack_delete_complete | #describe_stacks | 30 | 120 |
stack_exists | #describe_stacks | 5 | 20 |
stack_import_complete | #describe_stacks | 30 | 120 |
stack_refactor_create_complete | #describe_stack_refactor | 5 | 120 |
stack_refactor_execute_complete | #describe_stack_refactor | 15 | 120 |
stack_rollback_complete | #describe_stacks | 30 | 120 |
stack_update_complete | #describe_stacks | 30 | 120 |
type_registration_complete | #describe_type_registration | 30 | 120 |
8998 8999 9000 9001 9002 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8998 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |