AWS CloudFormation

2021/11/22 - AWS CloudFormation - 1 updated api methods

Changes  This release include SDK changes for the feature launch of Stack Import to Service Managed StackSet.

ImportStacksToStackSet (updated) Link ¶
Changes (request)
{'OrganizationalUnitIds': ['string'], 'StackIdsUrl': 'string'}

Use the stack import operations for self-managed or service-managed StackSets. For self-managed StackSets, the import operation can import stacks in the administrator account or in different target accounts and Amazon Web Services Regions. For service-managed StackSets, the import operation can import any stack in the same AWS Organizations as the management account. The import operation can import up to 10 stacks using inline stack IDs or up to 10,000 stacks using an Amazon S3 object.

See also: AWS API Documentation

Request Syntax

client.import_stacks_to_stack_set(
    StackSetName='string',
    StackIds=[
        'string',
    ],
    StackIdsUrl='string',
    OrganizationalUnitIds=[
        'string',
    ],
    OperationPreferences={
        'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
        'RegionOrder': [
            'string',
        ],
        'FailureToleranceCount': 123,
        'FailureTolerancePercentage': 123,
        'MaxConcurrentCount': 123,
        'MaxConcurrentPercentage': 123
    },
    OperationId='string',
    CallAs='SELF'|'DELEGATED_ADMIN'
)
type StackSetName

string

param StackSetName

[REQUIRED]

The name of the stack set. The name must be unique in the Region where you create your stack set.

type StackIds

list

param StackIds

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.

Specify either StackIds or StackIdsUrl .

  • (string) --

type StackIdsUrl

string

param StackIdsUrl

The Amazon S3 URL which contains list of stack ids to be inputted.

Specify either StackIds or StackIdsUrl .

type OrganizationalUnitIds

list

param OrganizationalUnitIds

The list of OU ID’s to which the stacks being imported has to be mapped as deployment target.

  • (string) --

type OperationPreferences

dict

param OperationPreferences

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options .

  • RegionConcurrencyType (string) --

    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

  • RegionOrder (list) --

    The order of the Regions in where you want to perform the stack operation.

    • (string) --

  • FailureToleranceCount (integer) --

    The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

    Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

    By default, 0 is specified.

  • FailureTolerancePercentage (integer) --

    The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

    Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.

    By default, 0 is specified.

  • MaxConcurrentCount (integer) --

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount . MaxConcurrentCount is at most one more than the FailureToleranceCount .

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.

    By default, 1 is specified.

  • MaxConcurrentPercentage (integer) --

    The maximum percentage of accounts in which to perform this operation at one time.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.

    By default, 1 is specified.

type OperationId

string

param OperationId

A unique, user defined, identifier for the stack set operation.

This field is autopopulated if not provided.

type CallAs

string

param CallAs

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

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

  • For service managed stack sets, specify DELEGATED_ADMIN .

rtype

dict

returns

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) --

    • OperationId (string) --

      The unique identifier for the stack set operation.