Class: Aws::CloudFormation::Types::ListStackInstancesInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass ListStackInstancesInput data as a hash:

{
  stack_set_name: "StackSetName", # required
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "DETAILED_STATUS", # accepts DETAILED_STATUS
      values: "StackInstanceFilterValues",
    },
  ],
  stack_instance_account: "Account",
  stack_instance_region: "Region",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#call_asString

[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 stack sets 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][1

    in the *CloudFormation

    User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html

Returns:

  • (String)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::StackInstanceFilter>

The status that stack instances are filtered by.

Returns:


4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.

Returns:

  • (Integer)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the previous request didn't return all of the remaining results, the response's `NextToken` parameter value is set to a token. To retrieve the next set of results, call `ListStackInstances` again and assign that token to the request object's `NextToken` parameter. If there are no remaining results, the previous response object's `NextToken` parameter is set to `null`.

Returns:

  • (String)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_instance_accountString

The name of the Amazon Web Services account that you want to list stack instances for.

Returns:

  • (String)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_instance_regionString

The name of the Region where you want to list stack instances.

Returns:

  • (String)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_nameString

The name or unique ID of the stack set that you want to list stack instances for.

Returns:

  • (String)

4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/aws-sdk-cloudformation/types.rb', line 4517

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end