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, making it available for use in stack templates.
-
#batch_describe_type_configurations(params = {}) ⇒ Types::BatchDescribeTypeConfigurationsOutput
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
-
#cancel_update_stack(params = {}) ⇒ Struct
Cancels an update on the specified stack.
-
#continue_update_rollback(params = {}) ⇒ Struct
For a specified stack that's in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_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_set(params = {}) ⇒ Types::CreateStackSetOutput
Creates a stack set.
-
#deactivate_organizations_access(params = {}) ⇒ Struct
Deactivates trusted access with Organizations.
-
#deactivate_type(params = {}) ⇒ Struct
Deactivates a public extension that was previously activated in this account and Region.
-
#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 stack set.
-
#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_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 that has been registered.
-
#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 stack set.
-
#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.
-
#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 stack sets.
-
#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_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 stack set.
-
#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 stack set.
-
#list_stack_set_operation_results(params = {}) ⇒ Types::ListStackSetOperationResultsOutput
Returns summary information about the results of a stack set operation.
-
#list_stack_set_operations(params = {}) ⇒ Types::ListStackSetOperationsOutput
Returns summary information about operations performed on a stack set.
-
#list_stack_sets(params = {}) ⇒ Types::ListStackSetsOutput
Returns summary information about stack sets 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 extension that have been registered with CloudFormation.
-
#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 stack set 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 stack set, 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.
409 410 411 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 409 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.
425 426 427 428 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 425 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, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
544 545 546 547 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 544 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 for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
612 613 614 615 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 612 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.
661 662 663 664 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 661 def cancel_update_stack(params = {}, = {}) req = build_request(:cancel_update_stack, params) req.send_request() end |
#continue_update_rollback(params = {}) ⇒ Struct
For a specified stack that's in the UPDATE_ROLLBACK_FAILED
state,
continues rolling it back to the 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 goes into the UPDATE_ROLLBACK_FAILED
state when
CloudFormation can't roll back all changes after a failed stack
update. For example, you might have a stack that's rolling back to an
old database instance that was deleted outside of CloudFormation.
Because CloudFormation doesn't know the database was deleted, it
assumes that the database instance still exists and attempts to roll
back to it, causing the update rollback to fail.
777 778 779 780 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 777 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
.
1141 1142 1143 1144 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1141 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1229 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.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1567 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
.
1723 1724 1725 1726 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1723 def create_stack_instances(params = {}, = {}) req = build_request(:create_stack_instances, params) req.send_request() end |
#create_stack_set(params = {}) ⇒ Types::CreateStackSetOutput
Creates a stack set.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2004 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.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2019 def deactivate_organizations_access(params = {}, = {}) req = build_request(:deactivate_organizations_access, params) req.send_request() end |
#deactivate_type(params = {}) ⇒ Struct
Deactivates a public extension that was previously activated in this account and Region.
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.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2065 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
.
2102 2103 2104 2105 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2102 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.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2133 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.
2201 2202 2203 2204 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2201 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.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2321 def delete_stack_instances(params = {}, = {}) req = build_request(:delete_stack_instances, params) req.send_request() end |
#delete_stack_set(params = {}) ⇒ Struct
Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
2369 2370 2371 2372 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2369 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.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2432 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 CloudFormation Quotas in the CloudFormation User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2474 2475 2476 2477 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2474 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 Updating 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
2607 2608 2609 2610 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2607 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.
2674 2675 2676 2677 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2674 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.
2771 2772 2773 2774 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2771 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.
2821 2822 2823 2824 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2821 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 CLI User Guide
2875 2876 2877 2878 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2875 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.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3015 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 Detecting Unregulated Configuration Changes to Stacks and Resources.
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.
3078 3079 3080 3081 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3078 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 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.
3152 3153 3154 3155 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3152 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.
3232 3233 3234 3235 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3232 def describe_stack_instance(params = {}, = {}) req = build_request(:describe_stack_instance, 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.
3291 3292 3293 3294 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3291 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
Resources that Support 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.
3387 3388 3389 3390 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3387 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
, go to the
CloudFormation User Guide.
ValidationError
is returned if you specify both StackName
and
PhysicalResourceId
in the same request.
3487 3488 3489 3490 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3487 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.
3571 3572 3573 3574 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3571 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.
3659 3660 3661 3662 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3659 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 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
3785 3786 3787 3788 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3785 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 that has been registered.
If you specify a VersionId
, DescribeType
returns information about
that specific extension version. Otherwise, it returns information
about the default extension version.
3911 3912 3913 3914 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3911 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
3961 3962 3963 3964 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3961 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 Detecting Unregulated Configuration Changes to Stacks and Resources.
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 Resources that Support 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.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4025 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 Detecting Unregulated Configuration Changes to Stacks and Resources.
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 Resources that Support Drift Detection.
4096 4097 4098 4099 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4096 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 stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDrift
returns the OperationId
of the stack set 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 stack set,
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 stack set. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set, 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.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
4215 4216 4217 4218 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4215 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.
4280 4281 4282 4283 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4280 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
.
4360 4361 4362 4363 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4360 def execute_change_set(params = {}, = {}) req = build_request(:execute_change_set, 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.
4438 4439 4440 4441 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4438 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.
4468 4469 4470 4471 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4468 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.
4532 4533 4534 4535 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4532 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 stack set.
You can use the GetTemplateSummary
action when you submit a
template, or you can get template information for a stack set, 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.
4678 4679 4680 4681 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4678 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 stack sets. Use the stack import operation to import up to 10 stacks into a new stack set 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.
4765 4766 4767 4768 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4765 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.
4818 4819 4820 4821 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4818 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 CloudFormation export stack output values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4865 4866 4867 4868 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4865 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.
4953 4954 4955 4956 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4953 def list_generated_templates(params = {}, = {}) req = build_request(:list_generated_templates, 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.
5003 5004 5005 5006 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5003 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.
5124 5125 5126 5127 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5124 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.
5256 5257 5258 5259 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5256 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.
5329 5330 5331 5332 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5329 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.
5447 5448 5449 5450 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5447 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 stack set. 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.
5551 5552 5553 5554 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5551 def list_stack_instances(params = {}, = {}) req = build_request(:list_stack_instances, 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.
5609 5610 5611 5612 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5609 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 stack set.
5678 5679 5680 5681 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5678 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 stack set operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5771 5772 5773 5774 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5771 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 stack set.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5859 5860 5861 5862 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5859 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 stack sets 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 stack sets 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 stack sets 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 stack sets with service-managed permissions in the management account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5956 5957 5958 5959 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5956 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.
6013 6014 6015 6016 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6013 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.
6082 6083 6084 6085 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6082 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.
6176 6177 6178 6179 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6176 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 extension that have been registered with CloudFormation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6308 6309 6310 6311 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6308 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 CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
6384 6385 6386 6387 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6384 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.
6465 6466 6467 6468 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6465 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 Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
6528 6529 6530 6531 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6528 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 Providers in the CloudFormation 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 Configuring extensions at the account level in the CloudFormation User Guide.
6684 6685 6686 6687 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6684 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
6748 6749 6750 6751 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6748 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.
6789 6790 6791 6792 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6789 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 Configuring extensions at the account level 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 Using dynamic references to specify template values in the CloudFormation User Guide.
6885 6886 6887 6888 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6885 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.
6929 6930 6931 6932 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6929 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.
6977 6978 6979 6980 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6977 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.
7021 7022 7023 7024 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7021 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 stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
7073 7074 7075 7076 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7073 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 prior to publishing in the CloudFormation 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 CLI User
Guide.
7184 7185 7186 7187 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7184 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.
7312 7313 7314 7315 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7312 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 creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
7660 7661 7662 7663 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7660 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 stack set 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
stack set; to add or delete a parameter itself, use
UpdateStackSet to update the stack set template. If you add a
parameter to a template, before you can override the parameter value
specified in the stack set you must first use UpdateStackSet to
update all stack instances with the updated template and parameter
value specified in the stack set. Once a stack instance has been
updated with the new parameter, you can then override the parameter
value using UpdateStackInstances
.
7845 7846 7847 7848 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7845 def update_stack_instances(params = {}, = {}) req = build_request(:update_stack_instances, params) req.send_request() end |
#update_stack_set(params = {}) ⇒ Types::UpdateStackSetOutput
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
8237 8238 8239 8240 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8237 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 Protecting a 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.
8282 8283 8284 8285 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8282 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.
8351 8352 8353 8354 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8351 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_rollback_complete | #describe_stacks | 30 | 120 |
stack_update_complete | #describe_stacks | 30 | 120 |
type_registration_complete | #describe_type_registration | 30 | 120 |
8468 8469 8470 8471 8472 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8468 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |