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

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.getStackSet

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

    Using getStackSet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStackSet(args: GetStackSetArgs, opts?: InvokeOptions): Promise<GetStackSetResult>
    function getStackSetOutput(args: GetStackSetOutputArgs, opts?: InvokeOptions): Output<GetStackSetResult>
    def get_stack_set(stack_set_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetStackSetResult
    def get_stack_set_output(stack_set_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetStackSetResult]
    func LookupStackSet(ctx *Context, args *LookupStackSetArgs, opts ...InvokeOption) (*LookupStackSetResult, error)
    func LookupStackSetOutput(ctx *Context, args *LookupStackSetOutputArgs, opts ...InvokeOption) LookupStackSetResultOutput

    > Note: This function is named LookupStackSet in the Go SDK.

    public static class GetStackSet 
    {
        public static Task<GetStackSetResult> InvokeAsync(GetStackSetArgs args, InvokeOptions? opts = null)
        public static Output<GetStackSetResult> Invoke(GetStackSetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStackSetResult> getStackSet(GetStackSetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudformation:getStackSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    StackSetId string
    The ID of the stack set that you're creating.
    StackSetId string
    The ID of the stack set that you're creating.
    stackSetId String
    The ID of the stack set that you're creating.
    stackSetId string
    The ID of the stack set that you're creating.
    stack_set_id str
    The ID of the stack set that you're creating.
    stackSetId String
    The ID of the stack set that you're creating.

    getStackSet Result

    The following output properties are available:

    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.Outputs.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.
    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.Outputs.ManagedExecutionProperties
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    Parameters List<Pulumi.AwsNative.CloudFormation.Outputs.StackSetParameter>
    The input parameters for the stack set template.
    StackSetId string
    The ID of the stack set that you're creating.
    Tags List<Pulumi.AwsNative.Outputs.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.
    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.
    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.
    Parameters []StackSetParameter
    The input parameters for the stack set template.
    StackSetId string
    The ID of the stack set that you're creating.
    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.
    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.
    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.
    parameters List<StackSetParameter>
    The input parameters for the stack set template.
    stackSetId String
    The ID of the stack set that you're creating.
    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.
    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.
    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.
    parameters StackSetParameter[]
    The input parameters for the stack set template.
    stackSetId string
    The ID of the stack set that you're creating.
    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.
    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 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.
    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 ManagedExecutionProperties
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    parameters Sequence[StackSetParameter]
    The input parameters for the stack set template.
    stack_set_id str
    The ID of the stack set that you're creating.
    tags Sequence[root_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.
    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.
    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.
    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.
    parameters List<Property Map>
    The input parameters for the stack set template.
    stackSetId String
    The ID of the stack set that you're creating.
    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.

    Supporting Types

    ManagedExecutionProperties

    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

    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.

    StackSetCapability

    StackSetParameter

    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.

    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 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