Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

stacksets

AWS CloudFormation StackSet related operations.

aws_cloudformation.better_boto.stacksets.describe_stack_set(bsm: boto_session_manager.manager.BotoSesManager, name: str, call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING')) → Optional[aws_cloudformation.stack_set.StackSet]

Ref:

• describe_stack_set: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/describe_stack_set.html#describe_stack_set

aws_cloudformation.better_boto.stacksets.create_stack_set(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, description: Optional[str] = Sentinel('NOTHING'), template_body: Optional[str] = Sentinel('NOTHING'), template_url: Optional[str] = Sentinel('NOTHING'), stack_id: Optional[str] = Sentinel('NOTHING'), parameters: Optional[List[aws_cloudformation.stack.Parameter]] = Sentinel('NOTHING'), tags: Optional[Dict[str, str]] = Sentinel('NOTHING'), include_iam: Optional[bool] = Sentinel('NOTHING'), include_named_iam: Optional[bool] = Sentinel('NOTHING'), include_macro: Optional[bool] = Sentinel('NOTHING'), admin_role_arn: Optional[str] = Sentinel('NOTHING'), execution_role_name: Optional[str] = Sentinel('NOTHING'), permission_model_is_self_managed: Optional[bool] = Sentinel('NOTHING'), permission_model_is_service_managed: Optional[bool] = Sentinel('NOTHING'), auto_deployment_is_enabled: Optional[bool] = Sentinel('NOTHING'), auto_deployment_retain_stacks_on_account_removal: Optional[bool] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING'), client_request_token: Optional[str] = Sentinel('NOTHING')) → str

Ref:

• create_stack_set: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/create_stack_set.html

Returns

stack_set_id

aws_cloudformation.better_boto.stacksets.update_stack_set(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, description: Optional[str] = Sentinel('NOTHING'), template_body: Optional[str] = Sentinel('NOTHING'), template_url: Optional[str] = Sentinel('NOTHING'), use_previous_template: Optional[bool] = Sentinel('NOTHING'), parameters: Optional[List[aws_cloudformation.stack.Parameter]] = Sentinel('NOTHING'), tags: Optional[Dict[str, str]] = Sentinel('NOTHING'), include_iam: Optional[bool] = Sentinel('NOTHING'), include_named_iam: Optional[bool] = Sentinel('NOTHING'), include_macro: Optional[bool] = Sentinel('NOTHING'), operation_preferences: Optional[dict] = Sentinel('NOTHING'), admin_role_arn: Optional[str] = Sentinel('NOTHING'), execution_role_name: Optional[str] = Sentinel('NOTHING'), deployment_target: Optional[dict] = Sentinel('NOTHING'), permission_model_is_self_managed: Optional[bool] = Sentinel('NOTHING'), permission_model_is_service_managed: Optional[bool] = Sentinel('NOTHING'), auto_deployment_is_enabled: Optional[bool] = Sentinel('NOTHING'), auto_deployment_retain_stacks_on_account_removal: Optional[bool] = Sentinel('NOTHING'), operation_id: Optional[str] = Sentinel('NOTHING'), accounts: Optional[List[str]] = Sentinel('NOTHING'), regions: Optional[List[str]] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING'), managed_execution_active: Optional[bool] = Sentinel('NOTHING')) → str

Ref:

• update_stack_set: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/update_stack_set.html

Returns

operation_id

aws_cloudformation.better_boto.stacksets.delete_stack_set(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING'))

Ref:

• delete_stack_set: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/delete_stack_set.html

aws_cloudformation.better_boto.stacksets.describe_stack_instance(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, stack_instance_account: str, stack_instance_region: str, call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING')) → Optional[aws_cloudformation.stack_set.StackInstance]

Ref:

• describe_stack_instance: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/describe_stack_instance.html

aws_cloudformation.better_boto.stacksets.create_stack_instances(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, regions: List[str], accounts: Optional[List[str]] = Sentinel('NOTHING'), deployment_targets: Optional[dict] = Sentinel('NOTHING'), param_overrides: Optional[List[aws_cloudformation.stack.Parameter]] = Sentinel('NOTHING'), operation_preference: Optional[dict] = Sentinel('NOTHING'), operation_id: Optional[str] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING')) → str

Ref:

• create_stack_instances: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/create_stack_instances.html

Returns

operation_id

aws_cloudformation.better_boto.stacksets.update_stack_instances(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, regions: List[str], accounts: Optional[List[str]] = Sentinel('NOTHING'), deployment_targets: Optional[dict] = Sentinel('NOTHING'), param_overrides: Optional[List[aws_cloudformation.stack.Parameter]] = Sentinel('NOTHING'), operation_preference: Optional[dict] = Sentinel('NOTHING'), operation_id: Optional[str] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING'))

Ref:

• update_stack_instances: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/update_stack_instances.html

aws_cloudformation.better_boto.stacksets.delete_stack_instances(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, regions: List[str], retain_stacks: bool, accounts: Optional[List[str]] = Sentinel('NOTHING'), deployment_targets: Optional[dict] = Sentinel('NOTHING'), operation_preference: Optional[dict] = Sentinel('NOTHING'), operation_id: Optional[str] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING')) → str

Ref:

• delete_stack_instances: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/delete_stack_instances.html

Returns

operation_id

class aws_cloudformation.better_boto.stacksets.StackInstanceIterProxy(iterable: Iterable)

Reference:

• https://github.com/MacHu-GWU/iterproxy-project

aws_cloudformation.better_boto.stacksets.list_stack_instances(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, filters: Optional[List[dict]] = Sentinel('NOTHING'), stack_instance_account: Optional[str] = Sentinel('NOTHING'), stack_instance_region: Optional[str] = Sentinel('NOTHING'), call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING'), page_size: int = 20, max_results: int = 1000) → aws_cloudformation.better_boto.stacksets.StackInstanceIterProxy

Ref:

• list_stack_instances: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation/client/list_stack_instances.html

Returns

StackInstanceIterProxy

aws_cloudformation.better_boto.stacksets.wait_deploy_stack_instances_to_stop(bsm: boto_session_manager.manager.BotoSesManager, stack_set_name: str, raise_error_until_exec_stopped: bool, delays: Union[int, float], timeout: Union[int, float], verbose: bool, call_as_self: Optional[bool] = Sentinel('NOTHING'), call_as_delegated_admin: Optional[bool] = Sentinel('NOTHING')) → List[aws_cloudformation.stack_set.StackInstance]

This function can be called after you did a create_stack_instances, update_stack_instances, delete_stack_instances or update_stack_set. It waits until all changes to stack instances finished. If the deployment failed, then it will error.

TODO: add test and doc

Parameters

• bsm –

• stack_set_name –

• raise_error_until_exec_stopped –

• delays –

• timeout –

• verbose –

• call_as_self –

• call_as_delegated_admin –

Returns