Skip to content

CloudFormation  >  Operations  >  create_stack_refactor

create_stack_refactor

Operation

create_stack_refactor async

create_stack_refactor(request: CreateStackRefactorInput | CreateStackRefactorInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateStackRefactorOutput
create_stack_refactor(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateStackRefactorInputDict]) -> CreateStackRefactorOutput

Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.

Parameters:

Name Type Description Default
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
CreateStackRefactorOutput

An instance of CreateStackRefactorOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateStackRefactorInput dataclass

Bases: _SerdeShape

Dataclass for CreateStackRefactorInput structure.

Attributes
description class-attribute instance-attribute
description: str | None = ...

A description to help you identify the stack refactor.

enable_stack_creation class-attribute instance-attribute
enable_stack_creation: bool | None = ...

Determines if a new stack is created with the refactor.

resource_mappings class-attribute instance-attribute
resource_mappings: list[ResourceMapping] | None = ...

The mappings for the stack resource Source and stack resource Destination.

stack_definitions class-attribute instance-attribute
stack_definitions: list[StackDefinition] | None = ...

The stacks being refactored.

Dictionaries

CreateStackRefactorInputDict

Bases: TypedDict

Dictionary form of CreateStackRefactorInput.

Attributes
description instance-attribute
description: str | None

A description to help you identify the stack refactor.

enable_stack_creation instance-attribute
enable_stack_creation: bool | None

Determines if a new stack is created with the refactor.

resource_mappings instance-attribute
resource_mappings: Sequence[ResourceMapping | ResourceMappingDict] | None

The mappings for the stack resource Source and stack resource Destination.

stack_definitions instance-attribute

The stacks being refactored.

Output

CreateStackRefactorOutput dataclass

Bases: _SerdeShape

Dataclass for CreateStackRefactorOutput 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.

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

The ID associated with the stack refactor created from the CreateStackRefactor action.