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

Class ScanFilter

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ScanFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScanFilter.Builder,ScanFilter>

@Generated("software.amazon.awssdk:codegen")
public final class ScanFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScanFilter.Builder,ScanFilter>

A filter that is used to specify which resource types to scan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanFilter.Builder

Method Summary

Modifier and Type	Method	Description
static ScanFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTypes()	For responses, this returns true if the service returned a value for the Types property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ScanFilter.Builder>	serializableBuilderClass()
ScanFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	types()	An array of strings where each string represents an Amazon Web Services resource type you want to scan.

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

hasTypes

public final boolean hasTypes()

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

types

public final List<String> types()

An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format AWS::ServiceName::ResourceType, for example, AWS::DynamoDB::Table. For the full list of supported resource types, see the Resource type support table in the CloudFormation User Guide.

To scan all resource types within a service, you can use a wildcard, represented by an asterisk (*). You can place an asterisk at only the end of the string, for example, AWS::S3::*.

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

Returns:

An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format AWS::ServiceName::ResourceType, for example, AWS::DynamoDB::Table. For the full list of supported resource types, see the Resource type support table in the CloudFormation User Guide.

To scan all resource types within a service, you can use a wildcard, represented by an asterisk ( *). You can place an asterisk at only the end of the string, for example, AWS::S3::*.

toBuilder

public ScanFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScanFilter.Builder,ScanFilter>

builder

public static ScanFilter.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo