ControlScope (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.ControlScope

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ControlScope
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A framework consists of one or more controls. Each control has its own control scope. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ControlScope()

Constructors
Constructor and Description
`ControlScope()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ControlScope`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ControlScope`	`clearTagsEntries()` Removes all the entries added into Tags.
`ControlScope`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getComplianceResourceIds()` The ID of the only Amazon Web Services resource that you want your control scope to contain.
`List<String>`	`getComplianceResourceTypes()` Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
`Map<String,String>`	`getTags()` Describes whether the control scope includes resources with one or more tags.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComplianceResourceIds(Collection<String> complianceResourceIds)` The ID of the only Amazon Web Services resource that you want your control scope to contain.
`void`	`setComplianceResourceTypes(Collection<String> complianceResourceTypes)` Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
`void`	`setTags(Map<String,String> tags)` Describes whether the control scope includes resources with one or more tags.
`String`	`toString()` Returns a string representation of this object.
`ControlScope`	`withComplianceResourceIds(Collection<String> complianceResourceIds)` The ID of the only Amazon Web Services resource that you want your control scope to contain.
`ControlScope`	`withComplianceResourceIds(String... complianceResourceIds)` The ID of the only Amazon Web Services resource that you want your control scope to contain.
`ControlScope`	`withComplianceResourceTypes(Collection<String> complianceResourceTypes)` Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
`ControlScope`	`withComplianceResourceTypes(String... complianceResourceTypes)` Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
`ControlScope`	`withTags(Map<String,String> tags)` Describes whether the control scope includes resources with one or more tags.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ControlScope
```
public ControlScope()
```
- Method Detail
  - getComplianceResourceIds
```
public List<String> getComplianceResourceIds()
```
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    Returns:
    
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
  - setComplianceResourceIds
```
public void setComplianceResourceIds(Collection<String> complianceResourceIds)
```
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    Parameters:
    
    complianceResourceIds - The ID of the only Amazon Web Services resource that you want your control scope to contain.
  - withComplianceResourceIds
```
public ControlScope withComplianceResourceIds(String... complianceResourceIds)
```
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    NOTE: This method appends the values to the existing list (if any). Use setComplianceResourceIds(java.util.Collection) or withComplianceResourceIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    complianceResourceIds - The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withComplianceResourceIds
```
public ControlScope withComplianceResourceIds(Collection<String> complianceResourceIds)
```
    The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    Parameters:
    
    complianceResourceIds - The ID of the only Amazon Web Services resource that you want your control scope to contain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getComplianceResourceTypes
```
public List<String> getComplianceResourceTypes()
```
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    Returns:
    
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
  - setComplianceResourceTypes
```
public void setComplianceResourceTypes(Collection<String> complianceResourceTypes)
```
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    Parameters:
    
    complianceResourceTypes - Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
  - withComplianceResourceTypes
```
public ControlScope withComplianceResourceTypes(String... complianceResourceTypes)
```
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    NOTE: This method appends the values to the existing list (if any). Use setComplianceResourceTypes(java.util.Collection) or withComplianceResourceTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    complianceResourceTypes - Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withComplianceResourceTypes
```
public ControlScope withComplianceResourceTypes(Collection<String> complianceResourceTypes)
```
    Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    Parameters:
    
    complianceResourceTypes - Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
    
    Returns:
    
    Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
    
    Parameters:
    
    tags - Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
  - withTags
```
public ControlScope withTags(Map<String,String> tags)
```
    Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
    
    Parameters:
    
    tags - Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ControlScope addTagsEntry(String key,
                                 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ControlScope clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ControlScope clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ControlScope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ControlScope

Method Detail

getComplianceResourceIds

setComplianceResourceIds

withComplianceResourceIds

withComplianceResourceIds

getComplianceResourceTypes

setComplianceResourceTypes

withComplianceResourceTypes

withComplianceResourceTypes

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall