CloudFormation / Client / describe_stack_set

describe_stack_set¶

CloudFormation.Client.describe_stack_set(**kwargs)¶

Returns the description of the specified StackSet.

Note

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Request Syntax

response = client.describe_stack_set(
    StackSetName='string',
    CallAs='SELF'|'DELEGATED_ADMIN'
)

Parameters:

StackSetName (string) –
[REQUIRED]

The name or unique ID of the StackSet whose description you want.
CallAs (string) –
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.
- If you are signed in to the management account, specify SELF.
- If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'StackSet': {
        'StackSetName': 'string',
        'StackSetId': 'string',
        'Description': 'string',
        'Status': 'ACTIVE'|'DELETED',
        'TemplateBody': 'string',
        'Parameters': [
            {
                'ParameterKey': 'string',
                'ParameterValue': 'string',
                'UsePreviousValue': True|False,
                'ResolvedValue': 'string'
            },
        ],
        'Capabilities': [
            'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'StackSetARN': 'string',
        'AdministrationRoleARN': 'string',
        'ExecutionRoleName': 'string',
        'StackSetDriftDetectionDetails': {
            'DriftStatus': 'DRIFTED'|'IN_SYNC'|'NOT_CHECKED',
            'DriftDetectionStatus': 'COMPLETED'|'FAILED'|'PARTIAL_SUCCESS'|'IN_PROGRESS'|'STOPPED',
            'LastDriftCheckTimestamp': datetime(2015, 1, 1),
            'TotalStackInstancesCount': 123,
            'DriftedStackInstancesCount': 123,
            'InSyncStackInstancesCount': 123,
            'InProgressStackInstancesCount': 123,
            'FailedStackInstancesCount': 123
        },
        'AutoDeployment': {
            'Enabled': True|False,
            'RetainStacksOnAccountRemoval': True|False
        },
        'PermissionModel': 'SERVICE_MANAGED'|'SELF_MANAGED',
        'OrganizationalUnitIds': [
            'string',
        ],
        'ManagedExecution': {
            'Active': True|False
        },
        'Regions': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- StackSet (dict) –
  
  The specified StackSet.
  - StackSetName (string) –
    
    The name that’s associated with the StackSet.
  - StackSetId (string) –
    
    The ID of the StackSet.
  - Description (string) –
    
    A description of the StackSet that you specify when the StackSet is created or updated.
  - Status (string) –
    
    The status of the StackSet.
  - TemplateBody (string) –
    
    The structure that contains the body of the template that was used to create or update the StackSet.
  - Parameters (list) –
    
    A list of input parameters for a StackSet.
    - (dict) –
      
      The Parameter data type.
      - ParameterKey (string) –
        
        The key associated with the parameter. If you don’t specify a key and value for a particular parameter, CloudFormation uses the default value that’s specified in your template.
      - ParameterValue (string) –
        
        The input value associated with the parameter.
      - UsePreviousValue (boolean) –
        
        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
      - ResolvedValue (string) –
        
        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Specify existing resources at runtime with CloudFormation-supplied parameter types in the CloudFormation User Guide.
  - Capabilities (list) –
    
    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 Acknowledging IAM resources in CloudFormation templates.
    - (string) –
  - Tags (list) –
    
    A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.
    - (dict) –
      
      The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
      - Key (string) –
        
        Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix: aws:.
      - Value (string) –
        
        Required. A string that contains the value for this tag. You can specify a maximum of 256 characters for a tag value.
  - StackSetARN (string) –
    
    The Amazon Resource Name (ARN) of the StackSet.
  - AdministrationRoleARN (string) –
    
    The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
    
    Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the CloudFormation User Guide.
  - ExecutionRoleName (string) –
    
    The name of the IAM execution role used to create or update the StackSet.
    
    Use customized execution roles to control which stack resources users and groups can include in their StackSets.
  - StackSetDriftDetectionDetails (dict) –
    
    Detailed information about the drift status of the StackSet.
    
    For StackSets, contains information about the last completed drift operation performed on the StackSet. Information about drift operations currently in progress isn’t included.
    - DriftStatus (string) –
      
      Status of the StackSet’s actual configuration compared to its expected template and parameter configuration.
      - DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
      - NOT_CHECKED: CloudFormation hasn’t checked the StackSet for drift.
      - IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.
    - DriftDetectionStatus (string) –
      
      The status of the StackSet drift detection operation.
      - COMPLETED: The drift detection operation completed without failing on any stack instances.
      - FAILED: The drift detection operation exceeded the specified failure tolerance.
      - PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.
      - IN_PROGRESS: The drift detection operation is currently being performed.
      - STOPPED: The user has canceled the drift detection operation.
    - LastDriftCheckTimestamp (datetime) –
      
      Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn’t yet been performed on.
    - TotalStackInstancesCount (integer) –
      
      The total number of stack instances belonging to this StackSet.
      
      The total number of stack instances is equal to the total of:
      - Stack instances that match the StackSet configuration.
      - Stack instances that have drifted from the StackSet configuration.
      - Stack instances where the drift detection operation has failed.
      - Stack instances currently being checked for drift.
    - DriftedStackInstancesCount (integer) –
      
      The number of stack instances that have drifted from the expected template and parameter configuration of the StackSet. A stack instance is considered to have drifted if one or more of the resources in the associated stack don’t match their expected configuration.
    - InSyncStackInstancesCount (integer) –
      
      The number of stack instances which match the expected template and parameter configuration of the StackSet.
    - InProgressStackInstancesCount (integer) –
      
      The number of stack instances that are currently being checked for drift.
    - FailedStackInstancesCount (integer) –
      
      The number of stack instances for which the drift detection operation failed.
  - AutoDeployment (dict) –
    
    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.
    - Enabled (boolean) –
      
      If set to true, StackSets automatically deploys additional stack instances to 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.
  - PermissionModel (string) –
    
    Describes how the IAM roles required for StackSet operations are created.
    - With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions.
    - With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
  - OrganizationalUnitIds (list) –
    
    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
    - (string) –
  - ManagedExecution (dict) –
    
    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
    - Active (boolean) –
      
      When true, CloudFormation performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, CloudFormation starts queued operations in request order.
      
      Note
      If there are already running or queued operations, CloudFormation queues all incoming operations even if they are non-conflicting.
      
      You can’t modify your StackSet’s execution configuration while there are running or queued operations for that StackSet.
      
      When false (default), StackSets performs one operation at a time in request order.
  - Regions (list) –
    
    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.
    - (string) –

Exceptions

CloudFormation.Client.exceptions.StackSetNotFoundException