Returns the description of the specified StackSet¶

Description¶

Returns the description of the specified StackSet.

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

Usage¶

cloudformation_describe_stack_set(StackSetName, CallAs)

Arguments¶

StackSetName

[required] The name or unique ID of the StackSet whose description you want.
CallAs

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

Value¶

A list with the following syntax:

list(
  StackSet = list(
    StackSetName = "string",
    StackSetId = "string",
    Description = "string",
    Status = "ACTIVE"|"DELETED",
    TemplateBody = "string",
    Parameters = list(
      list(
        ParameterKey = "string",
        ParameterValue = "string",
        UsePreviousValue = TRUE|FALSE,
        ResolvedValue = "string"
      )
    ),
    Capabilities = list(
      "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    StackSetARN = "string",
    AdministrationRoleARN = "string",
    ExecutionRoleName = "string",
    StackSetDriftDetectionDetails = list(
      DriftStatus = "DRIFTED"|"IN_SYNC"|"NOT_CHECKED",
      DriftDetectionStatus = "COMPLETED"|"FAILED"|"PARTIAL_SUCCESS"|"IN_PROGRESS"|"STOPPED",
      LastDriftCheckTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      TotalStackInstancesCount = 123,
      DriftedStackInstancesCount = 123,
      InSyncStackInstancesCount = 123,
      InProgressStackInstancesCount = 123,
      FailedStackInstancesCount = 123
    ),
    AutoDeployment = list(
      Enabled = TRUE|FALSE,
      RetainStacksOnAccountRemoval = TRUE|FALSE,
      DependsOn = list(
        "string"
      )
    ),
    PermissionModel = "SERVICE_MANAGED"|"SELF_MANAGED",
    OrganizationalUnitIds = list(
      "string"
    ),
    ManagedExecution = list(
      Active = TRUE|FALSE
    ),
    Regions = list(
      "string"
    )
  )
)

Request syntax¶

svc$describe_stack_set(
  StackSetName = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)