com.amazonaws.services.cloudformation.model

Class ListStackInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.ListStackInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListStackInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListStackInstancesRequest()

Method Summary

Modifier and Type	Method and Description
ListStackInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCallAs() [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.
List<StackInstanceFilter>	getFilters() The filter to apply to stack instances
Integer	getMaxResults() The maximum number of results to be returned with a single call.
String	getNextToken() If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token.
String	getStackInstanceAccount() The name of the Amazon Web Services account that you want to list stack instances for.
String	getStackInstanceRegion() The name of the Region where you want to list stack instances.
String	getStackSetName() The name or unique ID of the stack set that you want to list stack instances for.
int	hashCode()
void	setCallAs(String 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.
void	setFilters(Collection<StackInstanceFilter> filters) The filter to apply to stack instances
void	setMaxResults(Integer maxResults) The maximum number of results to be returned with a single call.
void	setNextToken(String nextToken) If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token.
void	setStackInstanceAccount(String stackInstanceAccount) The name of the Amazon Web Services account that you want to list stack instances for.
void	setStackInstanceRegion(String stackInstanceRegion) The name of the Region where you want to list stack instances.
void	setStackSetName(String stackSetName) The name or unique ID of the stack set that you want to list stack instances for.
String	toString() Returns a string representation of this object.
ListStackInstancesRequest	withCallAs(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.
ListStackInstancesRequest	withCallAs(String 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.
ListStackInstancesRequest	withFilters(Collection<StackInstanceFilter> filters) The filter to apply to stack instances
ListStackInstancesRequest	withFilters(StackInstanceFilter... filters) The filter to apply to stack instances
ListStackInstancesRequest	withMaxResults(Integer maxResults) The maximum number of results to be returned with a single call.
ListStackInstancesRequest	withNextToken(String nextToken) If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token.
ListStackInstancesRequest	withStackInstanceAccount(String stackInstanceAccount) The name of the Amazon Web Services account that you want to list stack instances for.
ListStackInstancesRequest	withStackInstanceRegion(String stackInstanceRegion) The name of the Region where you want to list stack instances.
ListStackInstancesRequest	withStackSetName(String stackSetName) The name or unique ID of the stack set that you want to list stack instances for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListStackInstancesRequest

public ListStackInstancesRequest()

Method Detail

setStackSetName

public void setStackSetName(String stackSetName)

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

Parameters:

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

getStackSetName

public String getStackSetName()

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.

withStackSetName

public ListStackInstancesRequest withStackSetName(String stackSetName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

If the previous request didn't return all 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.

Parameters:

nextToken - If the previous request didn't return all 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.

getNextToken

public String getNextToken()

If the previous request didn't return all 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 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.

withNextToken

public ListStackInstancesRequest withNextToken(String nextToken)

If the previous request didn't return all 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.

Parameters:

nextToken - If the previous request didn't return all 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:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListStackInstancesRequest withMaxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<StackInstanceFilter> getFilters()

The filter to apply to stack instances

Returns:

The filter to apply to stack instances

setFilters

public void setFilters(Collection<StackInstanceFilter> filters)

The filter to apply to stack instances

Parameters:

filters - The filter to apply to stack instances

withFilters

public ListStackInstancesRequest withFilters(StackInstanceFilter... filters)

The filter to apply to stack instances

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filter to apply to stack instances

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public ListStackInstancesRequest withFilters(Collection<StackInstanceFilter> filters)

The filter to apply to stack instances

Parameters:

filters - The filter to apply to stack instances

Returns:

Returns a reference to this object so that method calls can be chained together.

setStackInstanceAccount

public void setStackInstanceAccount(String stackInstanceAccount)

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

Parameters:

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

getStackInstanceAccount

public String getStackInstanceAccount()

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

Returns:

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

withStackInstanceAccount

public ListStackInstancesRequest withStackInstanceAccount(String stackInstanceAccount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStackInstanceRegion

public void setStackInstanceRegion(String stackInstanceRegion)

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

Parameters:

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

getStackInstanceRegion

public String getStackInstanceRegion()

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.

withStackInstanceRegion

public ListStackInstancesRequest withStackInstanceRegion(String stackInstanceRegion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCallAs

public void setCallAs(String 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 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.

Parameters:

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

See Also:

CallAs

getCallAs

public String getCallAs()

[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 in the CloudFormation User Guide.

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

See Also:

CallAs

withCallAs

public ListStackInstancesRequest withCallAs(String 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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAs

withCallAs

public ListStackInstancesRequest withCallAs(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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAs

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListStackInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()