Package software.amazon.awssdk.services.cloudformation.model

Class ListStackInstanceResourceDriftsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListStackInstanceResourceDriftsRequest.Builder,ListStackInstanceResourceDriftsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListStackInstanceResourceDriftsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListStackInstanceResourceDriftsRequest.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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStackInstanceResourceDriftStatuses()	For responses, this returns true if the service returned a value for the StackInstanceResourceDriftStatuses property.
Integer	maxResults()	The maximum number of results to be returned with a single call.
String	nextToken()	If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
String	operationId()	The unique ID of the drift operation.
List<SdkField<?>>	sdkFields()
static Class<? extends ListStackInstanceResourceDriftsRequest.Builder>	serializableBuilderClass()
String	stackInstanceAccount()	The name of the Amazon Web Services account that you want to list resource drifts for.
String	stackInstanceRegion()	The name of the Region where you want to list resource drifts.
List<StackResourceDriftStatus>	stackInstanceResourceDriftStatuses()	The resource drift status of the stack instance.
List<String>	stackInstanceResourceDriftStatusesAsStrings()	The resource drift status of the stack instance.
String	stackSetName()	The name or unique ID of the stack set that you want to list drifted resources for.
ListStackInstanceResourceDriftsRequest.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 drifted resources for.

Returns:

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

nextToken

public final String nextToken()

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action 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 paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action 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.

stackInstanceResourceDriftStatuses

public final List<StackResourceDriftStatus> stackInstanceResourceDriftStatuses()

The resource drift status of the stack instance.

• DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

• MODIFIED: One or more resource properties differ from their expected template values.

• IN_SYNC: The resource's actual configuration matches its expected template configuration.

• NOT_CHECKED: CloudFormation doesn't currently return this value.

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 hasStackInstanceResourceDriftStatuses() method.

Returns:

The resource drift status of the stack instance.

• DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

• MODIFIED: One or more resource properties differ from their expected template values.

• IN_SYNC: The resource's actual configuration matches its expected template configuration.

• NOT_CHECKED: CloudFormation doesn't currently return this value.

hasStackInstanceResourceDriftStatuses

public final boolean hasStackInstanceResourceDriftStatuses()

For responses, this returns true if the service returned a value for the StackInstanceResourceDriftStatuses 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.

stackInstanceResourceDriftStatusesAsStrings

public final List<String> stackInstanceResourceDriftStatusesAsStrings()

The resource drift status of the stack instance.

• DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

• MODIFIED: One or more resource properties differ from their expected template values.

• IN_SYNC: The resource's actual configuration matches its expected template configuration.

• NOT_CHECKED: CloudFormation doesn't currently return this value.

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 hasStackInstanceResourceDriftStatuses() method.

Returns:

The resource drift status of the stack instance.

• DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

• MODIFIED: One or more resource properties differ from their expected template values.

• IN_SYNC: The resource's actual configuration matches its expected template configuration.

• NOT_CHECKED: CloudFormation doesn't currently return this value.

stackInstanceAccount

public final String stackInstanceAccount()

The name of the Amazon Web Services account that you want to list resource drifts for.

Returns:

The name of the Amazon Web Services account that you want to list resource drifts for.

stackInstanceRegion

public final String stackInstanceRegion()

The name of the Region where you want to list resource drifts.

Returns:

The name of the Region where you want to list resource drifts.

operationId

public final String operationId()

The unique ID of the drift operation.

Returns:

The unique ID of the drift operation.

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

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

toBuilder

public ListStackInstanceResourceDriftsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListStackInstanceResourceDriftsRequest.Builder,ListStackInstanceResourceDriftsRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static ListStackInstanceResourceDriftsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListStackInstanceResourceDriftsRequest.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