Class ListStackInstancesRequest

    • Method Detail

      • stackSetName

        public final String stackSetName()

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

        Returns:
        The name or unique ID of the StackSet that you want to list stack instances for.
      • nextToken

        public final String nextToken()

        The token for the next set of items to return. (You received this token from a previous call.)

        Returns:
        The token for the next set of items to return. (You received this token from a previous call.)
      • 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()
        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 the isEmpty() 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

        public final List<StackInstanceFilter> 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

        public final String 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

        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 StackSets 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 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 StackSets 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
      • 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 StackSets 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 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 StackSets 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
      • 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