software.amazon.awssdk.services.cloudformation.model

Class ListStackInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListStackInstancesRequest.Builder,ListStackInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListStackInstancesRequest
extends CloudFormationRequest
implements ToCopyableBuilder<ListStackInstancesRequest.Builder,ListStackInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListStackInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListStackInstancesRequest.Builder	builder()
CallAs	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.
String	callAsAsString() [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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<StackInstanceFilter>	filters() The status that stack instances are filtered by.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	maxResults() The maximum number of results to be returned with a single call.
String	nextToken() If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListStackInstancesRequest.Builder>	serializableBuilderClass()
String	stackInstanceAccount() The name of the AWS account that you want to list stack instances for.
String	stackInstanceRegion() The name of the Region where you want to list stack instances.
String	stackSetName() The name or unique ID of the stack set that you want to list stack instances for.
ListStackInstancesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackSetName

public final String stackSetName()

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

Returns:

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

nextToken

public final String nextToken()

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:

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.

maxResults

public final Integer maxResults()

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:

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.

hasFilters

public final boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public final List<StackInstanceFilter> filters()

The status that stack instances are filtered by.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

The status that stack instances are filtered by.

stackInstanceAccount

public final String stackInstanceAccount()

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

Returns:

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

stackInstanceRegion

public final String stackInstanceRegion()

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

Returns:

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

callAs

public final CallAs 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 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

Returns:

[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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

See Also:

CallAs

callAsAsString

public final String callAsAsString()

[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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

Returns:

[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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

See Also:

CallAs

toBuilder

public ListStackInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListStackInstancesRequest.Builder,ListStackInstancesRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static ListStackInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListStackInstancesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo