Skip to content

CloudFormation  >  Operations  >  stop_stack_set_operation

stop_stack_set_operation

Operation

stop_stack_set_operation async 

stop_stack_set_operation(input: StopStackSetOperationInput, plugins: list[Plugin] | None = None) -> StopStackSetOperationOutput

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.

Parameters:

Name Type Description Default
input StopStackSetOperationInput

An instance of StopStackSetOperationInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StopStackSetOperationOutput

An instance of StopStackSetOperationOutput.

Input

StopStackSetOperationInput dataclass

Bases: _SerdeShape

Dataclass for StopStackSetOperationInput structure.

Attributes

call_as class-attribute instance-attribute 
call_as: str | None = ...

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

operation_id class-attribute instance-attribute 
operation_id: str | None = ...

The ID of the stack operation.

stack_set_name class-attribute instance-attribute 
stack_set_name: str | None = ...

The name or unique ID of the StackSet that you want to stop the operation for.

Output

StopStackSetOperationOutput dataclass

Bases: _SerdeShape

Dataclass for StopStackSetOperationOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.