awscc.cloudformation_stackset

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - cloudformation:DeleteStackSet, cloudformation:DeleteStackInstances, cloudformation:DescribeStackSetOperation, cloudformation:UntagResource

update

Parent base class for filters and actions.

definitions:
  Account:
    description: AWS account that you want to create stack instances in the specified
      Region(s) for.
    pattern: ^[0-9]{12}$
    type: string
  Active:
    description: When true, StackSets performs non-conflicting operations concurrently
      and queues conflicting operations. After conflicting operations finish, StackSets
      starts queued operations in request order.
    type: boolean
  AutoDeployment:
    additionalProperties: false
    properties:
      Enabled:
        description: 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.
        type: boolean
      RetainStacksOnAccountRemoval:
        description: 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.
        type: boolean
    type: object
  Capability:
    enum:
    - CAPABILITY_IAM
    - CAPABILITY_NAMED_IAM
    - CAPABILITY_AUTO_EXPAND
    type: string
  DeploymentTargets:
    additionalProperties: false
    description: ' The AWS OrganizationalUnitIds or Accounts for which to create stack
      instances in the specified Regions.'
    properties:
      Accounts:
        description: AWS accounts that you want to create stack instances in the specified
          Region(s) for.
        insertionOrder: false
        items:
          description: AWS account that you want to create stack instances in the
            specified Region(s) for.
          pattern: ^[0-9]{12}$
          type: string
        minItems: 1
        type: array
        uniqueItems: true
      OrganizationalUnitIds:
        description: The organization root ID or organizational unit (OU) IDs to which
          StackSets deploys.
        insertionOrder: false
        items:
          pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$
          type: string
        minItems: 1
        type: array
        uniqueItems: true
    type: object
  OperationPreferences:
    additionalProperties: false
    description: The user-specified preferences for how AWS CloudFormation performs
      a stack set operation.
    properties:
      FailureToleranceCount:
        minimum: 0
        type: integer
      FailureTolerancePercentage:
        maximum: 100
        minimum: 0
        type: integer
      MaxConcurrentCount:
        minimum: 1
        type: integer
      MaxConcurrentPercentage:
        maximum: 100
        minimum: 0
        type: integer
      RegionConcurrencyType:
        description: The concurrency type of deploying StackSets operations in regions,
          could be in parallel or one region at a time
        enum:
        - SEQUENTIAL
        - PARALLEL
        type: string
      RegionOrder:
        items:
          pattern: ^[a-zA-Z0-9-]{1,128}$
          type: string
        type: array
    type: object
  OrganizationalUnitId:
    pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$
    type: string
  Parameter:
    additionalProperties: false
    properties:
      ParameterKey:
        description: 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.
        type: string
      ParameterValue:
        description: The input value associated with the parameter.
        type: string
    required:
    - ParameterKey
    - ParameterValue
    type: object
  Region:
    pattern: ^[a-zA-Z0-9-]{1,128}$
    type: string
  RegionConcurrencyType:
    description: The concurrency type of deploying StackSets operations in regions,
      could be in parallel or one region at a time
    enum:
    - SEQUENTIAL
    - PARALLEL
    type: string
  StackInstances:
    additionalProperties: false
    description: Stack instances in some specific accounts and Regions.
    properties:
      DeploymentTargets:
        additionalProperties: false
        description: ' The AWS OrganizationalUnitIds or Accounts for which to create
          stack instances in the specified Regions.'
        properties:
          Accounts:
            description: AWS accounts that you want to create stack instances in the
              specified Region(s) for.
            insertionOrder: false
            items:
              description: AWS account that you want to create stack instances in
                the specified Region(s) for.
              pattern: ^[0-9]{12}$
              type: string
            minItems: 1
            type: array
            uniqueItems: true
          OrganizationalUnitIds:
            description: The organization root ID or organizational unit (OU) IDs
              to which StackSets deploys.
            insertionOrder: false
            items:
              pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$
              type: string
            minItems: 1
            type: array
            uniqueItems: true
        type: object
      ParameterOverrides:
        description: A list of stack set parameters whose values you want to override
          in the selected stack instances.
        insertionOrder: false
        items:
          additionalProperties: false
          properties:
            ParameterKey:
              description: 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.
              type: string
            ParameterValue:
              description: The input value associated with the parameter.
              type: string
          required:
          - ParameterKey
          - ParameterValue
          type: object
        type: array
        uniqueItems: true
      Regions:
        description: The names of one or more Regions where you want to create stack
          instances using the specified AWS account(s).
        insertionOrder: false
        items:
          pattern: ^[a-zA-Z0-9-]{1,128}$
          type: string
        minItems: 1
        type: array
        uniqueItems: true
    required:
    - DeploymentTargets
    - Regions
    type: object
  Tag:
    additionalProperties: false
    description: Tag type enables you to specify a key-value pair that can be used
      to store information about an AWS CloudFormation StackSet.
    properties:
      Key:
        description: A string used to identify this tag. You can specify a maximum
          of 127 characters for a tag key.
        maxLength: 128
        minLength: 1
        pattern: ^(?!aws:.*)[a-zA-Z0-9\s\:\_\.\/\=\+\-]+$
        type: string
      Value:
        description: A string containing the value for this tag. You can specify a
          maximum of 256 characters for a tag value.
        maxLength: 256
        minLength: 1
        type: string
    required:
    - Key
    - Value
    type: object
properties:
  AdministrationRoleARN:
    description: 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.
    maxLength: 2048
    minLength: 20
    type: string
  AutoDeployment:
    additionalProperties: false
    properties:
      Enabled:
        description: 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.
        type: boolean
      RetainStacksOnAccountRemoval:
        description: 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.
        type: boolean
    type: object
  CallAs:
    description: 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.
    enum:
    - SELF
    - DELEGATED_ADMIN
    type: string
  Capabilities:
    description: 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.
    insertionOrder: false
    items:
      enum:
      - CAPABILITY_IAM
      - CAPABILITY_NAMED_IAM
      - CAPABILITY_AUTO_EXPAND
      type: string
    type: array
    uniqueItems: true
  Description:
    description: A description of the stack set. You can use the description to identify
      the stack set's purpose or other important information.
    maxLength: 1024
    minLength: 1
    type: string
  ExecutionRoleName:
    description: 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.
    maxLength: 64
    minLength: 1
    type: string
  ManagedExecution:
    additionalProperties: false
    description: Describes whether StackSets performs non-conflicting operations concurrently
      and queues conflicting operations.
    properties:
      Active:
        description: When true, StackSets performs non-conflicting operations concurrently
          and queues conflicting operations. After conflicting operations finish,
          StackSets starts queued operations in request order.
        type: boolean
    type: object
  OperationPreferences:
    additionalProperties: false
    description: The user-specified preferences for how AWS CloudFormation performs
      a stack set operation.
    properties:
      FailureToleranceCount:
        minimum: 0
        type: integer
      FailureTolerancePercentage:
        maximum: 100
        minimum: 0
        type: integer
      MaxConcurrentCount:
        minimum: 1
        type: integer
      MaxConcurrentPercentage:
        maximum: 100
        minimum: 0
        type: integer
      RegionConcurrencyType:
        description: The concurrency type of deploying StackSets operations in regions,
          could be in parallel or one region at a time
        enum:
        - SEQUENTIAL
        - PARALLEL
        type: string
      RegionOrder:
        items:
          pattern: ^[a-zA-Z0-9-]{1,128}$
          type: string
        type: array
    type: object
  Parameters:
    description: The input parameters for the stack set template.
    insertionOrder: false
    items:
      additionalProperties: false
      properties:
        ParameterKey:
          description: 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.
          type: string
        ParameterValue:
          description: The input value associated with the parameter.
          type: string
      required:
      - ParameterKey
      - ParameterValue
      type: object
    type: array
    uniqueItems: true
  StackInstancesGroup:
    description: A group of stack instances with parameters in some specific accounts
      and regions.
    insertionOrder: false
    items:
      additionalProperties: false
      description: Stack instances in some specific accounts and Regions.
      properties:
        DeploymentTargets:
          additionalProperties: false
          description: ' The AWS OrganizationalUnitIds or Accounts for which to create
            stack instances in the specified Regions.'
          properties:
            Accounts:
              description: AWS accounts that you want to create stack instances in
                the specified Region(s) for.
              insertionOrder: false
              items:
                description: AWS account that you want to create stack instances in
                  the specified Region(s) for.
                pattern: ^[0-9]{12}$
                type: string
              minItems: 1
              type: array
              uniqueItems: true
            OrganizationalUnitIds:
              description: The organization root ID or organizational unit (OU) IDs
                to which StackSets deploys.
              insertionOrder: false
              items:
                pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$
                type: string
              minItems: 1
              type: array
              uniqueItems: true
          type: object
        ParameterOverrides:
          description: A list of stack set parameters whose values you want to override
            in the selected stack instances.
          insertionOrder: false
          items:
            additionalProperties: false
            properties:
              ParameterKey:
                description: 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.
                type: string
              ParameterValue:
                description: The input value associated with the parameter.
                type: string
            required:
            - ParameterKey
            - ParameterValue
            type: object
          type: array
          uniqueItems: true
        Regions:
          description: The names of one or more Regions where you want to create stack
            instances using the specified AWS account(s).
          insertionOrder: false
          items:
            pattern: ^[a-zA-Z0-9-]{1,128}$
            type: string
          minItems: 1
          type: array
          uniqueItems: true
      required:
      - DeploymentTargets
      - Regions
      type: object
    type: array
    uniqueItems: true
  Tags:
    description: 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.
    insertionOrder: false
    items:
      additionalProperties: false
      description: Tag type enables you to specify a key-value pair that can be used
        to store information about an AWS CloudFormation StackSet.
      properties:
        Key:
          description: A string used to identify this tag. You can specify a maximum
            of 127 characters for a tag key.
          maxLength: 128
          minLength: 1
          pattern: ^(?!aws:.*)[a-zA-Z0-9\s\:\_\.\/\=\+\-]+$
          type: string
        Value:
          description: A string containing the value for this tag. You can specify
            a maximum of 256 characters for a tag value.
          maxLength: 256
          minLength: 1
          type: string
      required:
      - Key
      - Value
      type: object
    maxItems: 50
    type: array
    uniqueItems: true
  TemplateBody:
    description: The structure that contains the template body, with a minimum length
      of 1 byte and a maximum length of 51,200 bytes.
    maxLength: 51200
    minLength: 1
    type: string
  TemplateURL:
    description: '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.'
    maxLength: 1024
    minLength: 1
    type: string
  type:
    enum:
    - update

Permissions - cloudformation:GetTemplateSummary, cloudformation:UpdateStackSet, cloudformation:CreateStackInstances, cloudformation:DeleteStackInstances, cloudformation:UpdateStackInstances, cloudformation:DescribeStackSetOperation, cloudformation:TagResource, cloudformation:UntagResource