Class ListStackInstancesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListStackInstancesRequest.Builder,
ListStackInstancesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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.final String
[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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<StackInstanceFilter> filters()
The filter to apply to stack instancesfinal <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Integer
The maximum number of results to be returned with a single call.final String
If the previous request didn't return all the remaining results, the response'sNextToken
parameter value is set to a token.static Class
<? extends ListStackInstancesRequest.Builder> final String
The name of the Amazon Web Services account that you want to list stack instances for.final String
The name of the Region where you want to list stack instances.final String
The name or unique ID of the stack set that you want to list stack instances for.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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, callListStackInstances
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.- 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, callListStackInstances
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.
-
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 theNextToken
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 theNextToken
request parameter to get the next set of results.
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
filters
The filter to apply to stack instances
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- The filter to apply to stack instances
-
stackInstanceAccount
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.
-
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
[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. UseSELF
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.
If the service returns an enum value that is not available in the current SDK version,
callAs
will returnCallAs.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcallAsAsString()
.- 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. UseSELF
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:
-
-
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. UseSELF
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.
If the service returns an enum value that is not available in the current SDK version,
callAs
will returnCallAs.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcallAsAsString()
.- 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. UseSELF
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:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListStackInstancesRequest.Builder,
ListStackInstancesRequest> - Specified by:
toBuilder
in classCloudFormationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-