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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::StackInstanceFilter>

The status that stack instances are filtered by.

Returns:



3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region)
  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)


3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region)
  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)


3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

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

#stack_instance_accountString

The name of the AWS account that you want to list stack instances for.

Returns:

  • (String)


3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

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

#stack_instance_regionString

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

Returns:

  • (String)


3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

class ListStackInstancesInput < Struct.new(
  :stack_set_name,
  :next_token,
  :max_results,
  :filters,
  :stack_instance_account,
  :stack_instance_region)
  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)


3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3614

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