1. Packages
  2. AWS Native
  3. API Docs
  4. cloudformation
  5. StackSet

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi

aws-native.cloudformation.StackSet

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi

    StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances

    Create StackSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StackSet(name: string, args: StackSetArgs, opts?: CustomResourceOptions);
    @overload
    def StackSet(resource_name: str,
                 args: StackSetArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def StackSet(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 permission_model: Optional[StackSetPermissionModel] = None,
                 capabilities: Optional[Sequence[StackSetCapability]] = None,
                 parameters: Optional[Sequence[StackSetParameterArgs]] = None,
                 administration_role_arn: Optional[str] = None,
                 description: Optional[str] = None,
                 execution_role_name: Optional[str] = None,
                 managed_execution: Optional[ManagedExecutionPropertiesArgs] = None,
                 operation_preferences: Optional[StackSetOperationPreferencesArgs] = None,
                 call_as: Optional[StackSetCallAs] = None,
                 auto_deployment: Optional[StackSetAutoDeploymentArgs] = None,
                 stack_instances_group: Optional[Sequence[StackSetStackInstancesArgs]] = None,
                 stack_set_name: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                 template_body: Optional[str] = None,
                 template_url: Optional[str] = None)
    func NewStackSet(ctx *Context, name string, args StackSetArgs, opts ...ResourceOption) (*StackSet, error)
    public StackSet(string name, StackSetArgs args, CustomResourceOptions? opts = null)
    public StackSet(String name, StackSetArgs args)
    public StackSet(String name, StackSetArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudformation:StackSet
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StackSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StackSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StackSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StackSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StackSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const stackSetResource = new aws_native.cloudformation.StackSet("stackSetResource", {
        permissionModel: aws_native.cloudformation.StackSetPermissionModel.ServiceManaged,
        capabilities: [aws_native.cloudformation.StackSetCapability.CapabilityIam],
        parameters: [{
            parameterKey: "string",
            parameterValue: "string",
        }],
        administrationRoleArn: "string",
        description: "string",
        executionRoleName: "string",
        managedExecution: {
            active: false,
        },
        operationPreferences: {
            failureToleranceCount: 0,
            failureTolerancePercentage: 0,
            maxConcurrentCount: 0,
            maxConcurrentPercentage: 0,
            regionConcurrencyType: aws_native.cloudformation.StackSetRegionConcurrencyType.Sequential,
            regionOrder: ["string"],
        },
        callAs: aws_native.cloudformation.StackSetCallAs.Self,
        autoDeployment: {
            enabled: false,
            retainStacksOnAccountRemoval: false,
        },
        stackInstancesGroup: [{
            deploymentTargets: {
                accountFilterType: aws_native.cloudformation.StackSetDeploymentTargetsAccountFilterType.None,
                accounts: ["string"],
                accountsUrl: "string",
                organizationalUnitIds: ["string"],
            },
            regions: ["string"],
            parameterOverrides: [{
                parameterKey: "string",
                parameterValue: "string",
            }],
        }],
        stackSetName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        templateBody: "string",
        templateUrl: "string",
    });
    
    Coming soon!
    

    StackSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The StackSet resource accepts the following input properties:

    PermissionModel Pulumi.AwsNative.CloudFormation.StackSetPermissionModel
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    AdministrationRoleArn string
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    AutoDeployment Pulumi.AwsNative.CloudFormation.Inputs.StackSetAutoDeployment
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    CallAs Pulumi.AwsNative.CloudFormation.StackSetCallAs
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    Capabilities List<Pulumi.AwsNative.CloudFormation.StackSetCapability>
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    Description string
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    ExecutionRoleName string
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    ManagedExecution Pulumi.AwsNative.CloudFormation.Inputs.ManagedExecutionProperties
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    OperationPreferences Pulumi.AwsNative.CloudFormation.Inputs.StackSetOperationPreferences
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    Parameters List<Pulumi.AwsNative.CloudFormation.Inputs.StackSetParameter>
    The input parameters for the stack set template.
    StackInstancesGroup List<Pulumi.AwsNative.CloudFormation.Inputs.StackSetStackInstances>
    A group of stack instances with parameters in some specific accounts and regions.
    StackSetName string
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    TemplateBody string
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    TemplateUrl string
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
    PermissionModel StackSetPermissionModel
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    AdministrationRoleArn string
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    AutoDeployment StackSetAutoDeploymentArgs
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    CallAs StackSetCallAs
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    Capabilities []StackSetCapability
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    Description string
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    ExecutionRoleName string
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    ManagedExecution ManagedExecutionPropertiesArgs
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    OperationPreferences StackSetOperationPreferencesArgs
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    Parameters []StackSetParameterArgs
    The input parameters for the stack set template.
    StackInstancesGroup []StackSetStackInstancesArgs
    A group of stack instances with parameters in some specific accounts and regions.
    StackSetName string
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    Tags TagArgs
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    TemplateBody string
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    TemplateUrl string
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
    permissionModel StackSetPermissionModel
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    administrationRoleArn String
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    autoDeployment StackSetAutoDeployment
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    callAs StackSetCallAs
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    capabilities List<StackSetCapability>
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    description String
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    executionRoleName String
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    managedExecution ManagedExecutionProperties
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    operationPreferences StackSetOperationPreferences
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    parameters List<StackSetParameter>
    The input parameters for the stack set template.
    stackInstancesGroup List<StackSetStackInstances>
    A group of stack instances with parameters in some specific accounts and regions.
    stackSetName String
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    tags List<Tag>
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    templateBody String
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    templateUrl String
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
    permissionModel StackSetPermissionModel
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    administrationRoleArn string
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    autoDeployment StackSetAutoDeployment
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    callAs StackSetCallAs
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    capabilities StackSetCapability[]
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    description string
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    executionRoleName string
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    managedExecution ManagedExecutionProperties
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    operationPreferences StackSetOperationPreferences
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    parameters StackSetParameter[]
    The input parameters for the stack set template.
    stackInstancesGroup StackSetStackInstances[]
    A group of stack instances with parameters in some specific accounts and regions.
    stackSetName string
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    tags Tag[]
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    templateBody string
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    templateUrl string
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
    permission_model StackSetPermissionModel
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    administration_role_arn str
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    auto_deployment StackSetAutoDeploymentArgs
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    call_as StackSetCallAs
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    capabilities Sequence[StackSetCapability]
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    description str
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    execution_role_name str
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    managed_execution ManagedExecutionPropertiesArgs
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    operation_preferences StackSetOperationPreferencesArgs
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    parameters Sequence[StackSetParameterArgs]
    The input parameters for the stack set template.
    stack_instances_group Sequence[StackSetStackInstancesArgs]
    A group of stack instances with parameters in some specific accounts and regions.
    stack_set_name str
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    tags Sequence[TagArgs]
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    template_body str
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    template_url str
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
    permissionModel "SERVICE_MANAGED" | "SELF_MANAGED"
    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
    administrationRoleArn String
    The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
    autoDeployment Property Map
    Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
    callAs "SELF" | "DELEGATED_ADMIN"
    Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
    capabilities List<"CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND">
    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
    description String
    A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
    executionRoleName String
    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    managedExecution Property Map
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    operationPreferences Property Map
    The user-specified preferences for how AWS CloudFormation performs a stack set operation.
    parameters List<Property Map>
    The input parameters for the stack set template.
    stackInstancesGroup List<Property Map>
    A group of stack instances with parameters in some specific accounts and regions.
    stackSetName String
    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
    tags List<Property Map>
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
    templateBody String
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
    templateUrl String
    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StackSet resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    StackSetId string
    The ID of the stack set that you're creating.
    Id string
    The provider-assigned unique ID for this managed resource.
    StackSetId string
    The ID of the stack set that you're creating.
    id String
    The provider-assigned unique ID for this managed resource.
    stackSetId String
    The ID of the stack set that you're creating.
    id string
    The provider-assigned unique ID for this managed resource.
    stackSetId string
    The ID of the stack set that you're creating.
    id str
    The provider-assigned unique ID for this managed resource.
    stack_set_id str
    The ID of the stack set that you're creating.
    id String
    The provider-assigned unique ID for this managed resource.
    stackSetId String
    The ID of the stack set that you're creating.

    Supporting Types

    ManagedExecutionProperties, ManagedExecutionPropertiesArgs

    Active bool

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    Active bool

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    active Boolean

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    active boolean

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    active bool

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    active Boolean

    When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

    If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

    You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

    When false (default), StackSets performs one operation at a time in request order.

    StackSetAutoDeployment, StackSetAutoDeploymentArgs

    Enabled bool
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    RetainStacksOnAccountRemoval bool
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
    Enabled bool
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    RetainStacksOnAccountRemoval bool
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
    enabled Boolean
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    retainStacksOnAccountRemoval Boolean
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
    enabled boolean
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    retainStacksOnAccountRemoval boolean
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
    enabled bool
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    retain_stacks_on_account_removal bool
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
    enabled Boolean
    If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
    retainStacksOnAccountRemoval Boolean
    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

    StackSetCallAs, StackSetCallAsArgs

    Self
    SELF
    DelegatedAdmin
    DELEGATED_ADMIN
    StackSetCallAsSelf
    SELF
    StackSetCallAsDelegatedAdmin
    DELEGATED_ADMIN
    Self
    SELF
    DelegatedAdmin
    DELEGATED_ADMIN
    Self
    SELF
    DelegatedAdmin
    DELEGATED_ADMIN
    SELF
    SELF
    DELEGATED_ADMIN
    DELEGATED_ADMIN
    "SELF"
    SELF
    "DELEGATED_ADMIN"
    DELEGATED_ADMIN

    StackSetCapability, StackSetCapabilityArgs

    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    StackSetCapabilityCapabilityIam
    CAPABILITY_IAM
    StackSetCapabilityCapabilityNamedIam
    CAPABILITY_NAMED_IAM
    StackSetCapabilityCapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_IAM
    CAPABILITY_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_AUTO_EXPAND
    "CAPABILITY_IAM"
    CAPABILITY_IAM
    "CAPABILITY_NAMED_IAM"
    CAPABILITY_NAMED_IAM
    "CAPABILITY_AUTO_EXPAND"
    CAPABILITY_AUTO_EXPAND

    StackSetDeploymentTargets, StackSetDeploymentTargetsArgs

    AccountFilterType Pulumi.AwsNative.CloudFormation.StackSetDeploymentTargetsAccountFilterType
    The filter type you want to apply on organizational units and accounts.
    Accounts List<string>
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    AccountsUrl string
    Returns the value of the AccountsUrl property.
    OrganizationalUnitIds List<string>
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
    AccountFilterType StackSetDeploymentTargetsAccountFilterType
    The filter type you want to apply on organizational units and accounts.
    Accounts []string
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    AccountsUrl string
    Returns the value of the AccountsUrl property.
    OrganizationalUnitIds []string
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
    accountFilterType StackSetDeploymentTargetsAccountFilterType
    The filter type you want to apply on organizational units and accounts.
    accounts List<String>
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    accountsUrl String
    Returns the value of the AccountsUrl property.
    organizationalUnitIds List<String>
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
    accountFilterType StackSetDeploymentTargetsAccountFilterType
    The filter type you want to apply on organizational units and accounts.
    accounts string[]
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    accountsUrl string
    Returns the value of the AccountsUrl property.
    organizationalUnitIds string[]
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
    account_filter_type StackSetDeploymentTargetsAccountFilterType
    The filter type you want to apply on organizational units and accounts.
    accounts Sequence[str]
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    accounts_url str
    Returns the value of the AccountsUrl property.
    organizational_unit_ids Sequence[str]
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
    accountFilterType "NONE" | "UNION" | "INTERSECTION" | "DIFFERENCE"
    The filter type you want to apply on organizational units and accounts.
    accounts List<String>
    AWS accounts that you want to create stack instances in the specified Region(s) for.
    accountsUrl String
    Returns the value of the AccountsUrl property.
    organizationalUnitIds List<String>
    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    StackSetDeploymentTargetsAccountFilterType, StackSetDeploymentTargetsAccountFilterTypeArgs

    None
    NONE
    Union
    UNION
    Intersection
    INTERSECTION
    Difference
    DIFFERENCE
    StackSetDeploymentTargetsAccountFilterTypeNone
    NONE
    StackSetDeploymentTargetsAccountFilterTypeUnion
    UNION
    StackSetDeploymentTargetsAccountFilterTypeIntersection
    INTERSECTION
    StackSetDeploymentTargetsAccountFilterTypeDifference
    DIFFERENCE
    None
    NONE
    Union
    UNION
    Intersection
    INTERSECTION
    Difference
    DIFFERENCE
    None
    NONE
    Union
    UNION
    Intersection
    INTERSECTION
    Difference
    DIFFERENCE
    NONE
    NONE
    UNION
    UNION
    INTERSECTION
    INTERSECTION
    DIFFERENCE
    DIFFERENCE
    "NONE"
    NONE
    "UNION"
    UNION
    "INTERSECTION"
    INTERSECTION
    "DIFFERENCE"
    DIFFERENCE

    StackSetOperationPreferences, StackSetOperationPreferencesArgs

    FailureToleranceCount int

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

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

    FailureTolerancePercentage int

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

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

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

    MaxConcurrentCount int

    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.

    MaxConcurrentPercentage int

    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, AWS 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.

    RegionConcurrencyType Pulumi.AwsNative.CloudFormation.StackSetRegionConcurrencyType
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    RegionOrder List<string>

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    FailureToleranceCount int

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

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

    FailureTolerancePercentage int

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

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

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

    MaxConcurrentCount int

    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.

    MaxConcurrentPercentage int

    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, AWS 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.

    RegionConcurrencyType StackSetRegionConcurrencyType
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    RegionOrder []string

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    failureToleranceCount Integer

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

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

    failureTolerancePercentage Integer

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

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

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

    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.

    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, AWS 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.

    regionConcurrencyType StackSetRegionConcurrencyType
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    regionOrder List<String>

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    failureToleranceCount number

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

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

    failureTolerancePercentage number

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

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

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

    maxConcurrentCount number

    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.

    maxConcurrentPercentage number

    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, AWS 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.

    regionConcurrencyType StackSetRegionConcurrencyType
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    regionOrder string[]

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    failure_tolerance_count int

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

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

    failure_tolerance_percentage int

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

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

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

    max_concurrent_count int

    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.

    max_concurrent_percentage int

    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, AWS 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.

    region_concurrency_type StackSetRegionConcurrencyType
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    region_order Sequence[str]

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    failureToleranceCount Number

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

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

    failureTolerancePercentage Number

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

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

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

    maxConcurrentCount Number

    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.

    maxConcurrentPercentage Number

    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, AWS 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.

    regionConcurrencyType "SEQUENTIAL" | "PARALLEL"
    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
    regionOrder List<String>

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

    RegionOrder isn't followed if AutoDeployment is enabled.

    StackSetParameter, StackSetParameterArgs

    ParameterKey string
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    ParameterValue string
    The input value associated with the parameter.
    ParameterKey string
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    ParameterValue string
    The input value associated with the parameter.
    parameterKey String
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    parameterValue String
    The input value associated with the parameter.
    parameterKey string
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    parameterValue string
    The input value associated with the parameter.
    parameter_key str
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    parameter_value str
    The input value associated with the parameter.
    parameterKey String
    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
    parameterValue String
    The input value associated with the parameter.

    StackSetPermissionModel, StackSetPermissionModelArgs

    ServiceManaged
    SERVICE_MANAGED
    SelfManaged
    SELF_MANAGED
    StackSetPermissionModelServiceManaged
    SERVICE_MANAGED
    StackSetPermissionModelSelfManaged
    SELF_MANAGED
    ServiceManaged
    SERVICE_MANAGED
    SelfManaged
    SELF_MANAGED
    ServiceManaged
    SERVICE_MANAGED
    SelfManaged
    SELF_MANAGED
    SERVICE_MANAGED
    SERVICE_MANAGED
    SELF_MANAGED
    SELF_MANAGED
    "SERVICE_MANAGED"
    SERVICE_MANAGED
    "SELF_MANAGED"
    SELF_MANAGED

    StackSetRegionConcurrencyType, StackSetRegionConcurrencyTypeArgs

    Sequential
    SEQUENTIAL
    Parallel
    PARALLEL
    StackSetRegionConcurrencyTypeSequential
    SEQUENTIAL
    StackSetRegionConcurrencyTypeParallel
    PARALLEL
    Sequential
    SEQUENTIAL
    Parallel
    PARALLEL
    Sequential
    SEQUENTIAL
    Parallel
    PARALLEL
    SEQUENTIAL
    SEQUENTIAL
    PARALLEL
    PARALLEL
    "SEQUENTIAL"
    SEQUENTIAL
    "PARALLEL"
    PARALLEL

    StackSetStackInstances, StackSetStackInstancesArgs

    DeploymentTargets Pulumi.AwsNative.CloudFormation.Inputs.StackSetDeploymentTargets
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    Regions List<string>
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    ParameterOverrides List<Pulumi.AwsNative.CloudFormation.Inputs.StackSetParameter>
    A list of stack set parameters whose values you want to override in the selected stack instances.
    DeploymentTargets StackSetDeploymentTargets
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    Regions []string
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    ParameterOverrides []StackSetParameter
    A list of stack set parameters whose values you want to override in the selected stack instances.
    deploymentTargets StackSetDeploymentTargets
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    regions List<String>
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    parameterOverrides List<StackSetParameter>
    A list of stack set parameters whose values you want to override in the selected stack instances.
    deploymentTargets StackSetDeploymentTargets
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    regions string[]
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    parameterOverrides StackSetParameter[]
    A list of stack set parameters whose values you want to override in the selected stack instances.
    deployment_targets StackSetDeploymentTargets
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    regions Sequence[str]
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    parameter_overrides Sequence[StackSetParameter]
    A list of stack set parameters whose values you want to override in the selected stack instances.
    deploymentTargets Property Map
    The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
    regions List<String>
    The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
    parameterOverrides List<Property Map>
    A list of stack set parameters whose values you want to override in the selected stack instances.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi