@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.
Modifier and Type | Class and Description |
---|---|
static interface |
Scope.Builder |
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.
|
copy
public final boolean hasComplianceResourceTypes()
public final 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.
ComplianceResourceId
.public final String tagKey()
The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
public final 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
.
TagValue
, you must also specify a value for TagKey
.public final 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
.
ComplianceResourceTypes
.public Scope.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Scope.Builder,Scope>
public static Scope.Builder builder()
public static Class<? extends Scope.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.