java.lang.Object
- software.amazon.awssdk.services.backup.model.ControlScope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ControlScope.Builder,ControlScope>
```
@Generated("software.amazon.awssdk:codegen")
public final class ControlScope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ControlScope.Builder,ControlScope>
```
A framework consists of one or more controls. Each control has its own control scope. The control 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. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ControlScope.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ControlScope.Builder`	`builder()`
`List<String>`	`complianceResourceIds()`	The ID of the only Amazon Web Services resource that you want your control scope to contain.
`List<String>`	`complianceResourceTypes()`	Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasComplianceResourceIds()`	For responses, this returns true if the service returned a value for the ComplianceResourceIds property.
`boolean`	`hasComplianceResourceTypes()`	For responses, this returns true if the service returned a value for the ComplianceResourceTypes property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ControlScope.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule.
`ControlScope.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
  - hasComplianceResourceIds
```
public final boolean hasComplianceResourceIds()
```
    For responses, this returns true if the service returned a value for the ComplianceResourceIds 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.
  - complianceResourceIds
```
public final List<String> complianceResourceIds()
```
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    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 hasComplianceResourceIds() method.
    
    Returns:
    
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
  - 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()
```
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    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:
    
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].
    
    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 hasTags() method.
    
    Returns:
    
    The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].
  - toBuilder
```
public ControlScope.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ControlScope.Builder,ControlScope>
  - builder
```
public static ControlScope.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ControlScope.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

Class ControlScope

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasComplianceResourceIds

complianceResourceIds

hasComplianceResourceTypes

complianceResourceTypes

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields