StackSet ¶

class StackSet(TypedDict, closed=True):
    stack_set_name: NotRequired["capo_cloudformation.types.stack_set_name.StackSetName"]
    """<p>The name that's associated with the StackSet.</p>"""
    stack_set_id: NotRequired["capo_cloudformation.types.stack_set_id.StackSetId"]
    """<p>The ID of the StackSet.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>A description of the StackSet that you specify when the StackSet is created or updated.</p>"""
    status: NotRequired["capo_cloudformation.types.stack_set_status.StackSetStatus"]
    """<p>The status of the StackSet.</p>"""
    template_body: NotRequired["capo_cloudformation.types.template_body.TemplateBody"]
    """<p>The structure that contains the body of the template that was used to create or update the StackSet.</p>"""
    parameters: NotRequired["capo_cloudformation.types.parameters.Parameters"]
    """<p>A list of input parameters for a StackSet.</p>"""
    capabilities: NotRequired["capo_cloudformation.types.capabilities.Capabilities"]
    """<p>The capabilities that are allowed in the StackSet. Some StackSet templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>"""
    tags: NotRequired["capo_cloudformation.types.tags.Tags"]
    """<p>A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.</p>"""
    stack_set_arn: NotRequired["capo_cloudformation.types.stack_set_arn.StackSetARN"]
    """<p>The Amazon Resource Name (ARN) of the StackSet.</p>"""
    administration_role_arn: NotRequired["capo_cloudformation.types.role_arn.RoleARN"]
    """<p>The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites for using CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>"""
    execution_role_name: NotRequired[
        "capo_cloudformation.types.execution_role_name.ExecutionRoleName"
    ]
    """<p>The name of the IAM execution role used to create or update the StackSet.</p> <p>Use customized execution roles to control which stack resources users and groups can include in their StackSets.</p>"""
    stack_set_drift_detection_details: NotRequired[
        "capo_cloudformation.types.stack_set_drift_detection_details.StackSetDriftDetectionDetails"
    ]
    """<p>Detailed information about the drift status of the StackSet.</p> <p>For StackSets, contains information about the last <i>completed</i> drift operation performed on the StackSet. Information about drift operations currently in progress isn't included.</p>"""
    auto_deployment: NotRequired[
        "capo_cloudformation.types.auto_deployment.AutoDeployment"
    ]
    """<p>Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). Valid only if the StackSet uses service-managed permissions.</p>"""
    permission_model: NotRequired[
        "capo_cloudformation.types.permission_models.PermissionModels"
    ]
    """<p>Describes how the IAM roles required for StackSet operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html">Activate trusted access for StackSets with Organizations</a>.</p> </li> </ul>"""
    organizational_unit_ids: NotRequired[
        "capo_cloudformation.types.organizational_unit_id_list.OrganizationalUnitIdList"
    ]
    """<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>"""
    managed_execution: NotRequired[
        "capo_cloudformation.types.managed_execution.ManagedExecution"
    ]
    """<p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.</p>"""
    regions: NotRequired["capo_cloudformation.types.region_list.RegionList"]
    """<p>Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.</p>"""