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(value="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 AWS 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 and Description
static interface	Scope.Builder

Method Summary

Modifier and Type	Method and Description
static Scope.Builder	builder()
String	complianceResourceId() The ID of the only AWS resource that you want to trigger an evaluation for the rule.
List<String>	complianceResourceTypes() The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComplianceResourceTypes() Returns true if the ComplianceResourceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Scope.Builder>	serializableBuilderClass()
String	tagKey() The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
String	tagValue() The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.
Scope.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasComplianceResourceTypes

public boolean hasComplianceResourceTypes()

Returns true if the ComplianceResourceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

complianceResourceTypes

public List<String> complianceResourceTypes()

The resource types of only those AWS 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.

You can use hasComplianceResourceTypes() to see if a value was sent in this field.

Returns:

The resource types of only those AWS 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 String tagKey()

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

Returns:

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

tagValue

public String tagValue()

The tag value applied to only those AWS 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 AWS 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 String complianceResourceId()

The ID of the only AWS 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 AWS 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()

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 interface ToCopyableBuilder<Scope.Builder,Scope>

Returns:

a builder for type T

builder

public static Scope.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.