Class Scope
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Scope.Builder
builder()
final String
The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule.The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ComplianceResourceTypes property.final int
hashCode()
static Class
<? extends Scope.Builder> 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.final String
tagValue()
The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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 forTagKey
.- 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 forTagKey
.
-
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
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 interfaceToCopyableBuilder<Scope.Builder,
Scope> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-