Package software.amazon.awssdk.services.config.model

Class Scope

java.lang.Object

software.amazon.awssdk.services.config.model.Scope

All Implemented Interfaces:

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

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

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Scope.Builder

Method Summary

Modifier and Type	Method	Description
static Scope.Builder	builder()
String	complianceResourceId()	The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule.
List<String>	complianceResourceTypes()	The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComplianceResourceTypes()	For responses, this returns true if the service returned a value for the ComplianceResourceTypes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Scope.Builder>	serializableBuilderClass()
String	tagKey()	The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
String	tagValue()	The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
Scope.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasComplianceResourceTypes

public final boolean hasComplianceResourceTypes()

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

complianceResourceTypes

public final List<String> complianceResourceTypes()

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

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

Returns:

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

tagKey

public final String tagKey()

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

Returns:

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

tagValue

public final String tagValue()

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Returns:

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

complianceResourceId

public final String complianceResourceId()

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

Returns:

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

toBuilder

public Scope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Scope.Builder,Scope>

builder

public static Scope.Builder builder()

serializableBuilderClass

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