Class RecordingGroup

java.lang.Object
com.amazonaws.services.config.model.RecordingGroup
All Implemented Interfaces:
Serializable, Cloneable

public class RecordingGroup extends Object implements Serializable, Cloneable

Specifies the types of AWS resource for which AWS Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.

You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter.

For a list of supported resource types, see Supported resource types.

For more information, see Selecting Which Resources AWS Config Records.

See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
     
    Specifies whether AWS Config records configuration changes for every supported type of regional resource.
    Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
    A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
    int
     
    Specifies whether AWS Config records configuration changes for every supported type of regional resource.
    Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
    void
    setAllSupported(Boolean allSupported)
    Specifies whether AWS Config records configuration changes for every supported type of regional resource.
    void
    setIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)
    Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
    void
    A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
    Returns a string representation of this object; useful for testing and debugging.
    withAllSupported(Boolean allSupported)
    Specifies whether AWS Config records configuration changes for every supported type of regional resource.
    withIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)
    Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
    withResourceTypes(ResourceType... resourceTypes)
    A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
    withResourceTypes(String... resourceTypes)
    A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
    A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • RecordingGroup

      public RecordingGroup()
  • Method Details

    • setAllSupported

      public void setAllSupported(Boolean allSupported)

      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

      Parameters:
      allSupported - Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

    • getAllSupported

      public Boolean getAllSupported()

      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

      Returns:
      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

    • withAllSupported

      public RecordingGroup withAllSupported(Boolean allSupported)

      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

      Parameters:
      allSupported - Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isAllSupported

      public Boolean isAllSupported()

      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

      Returns:
      Specifies whether AWS Config records configuration changes for every supported type of regional resource.

      If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

      If you set this option to true, you cannot enumerate a list of resourceTypes.

    • setIncludeGlobalResourceTypes

      public void setIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)

      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

      Parameters:
      includeGlobalResourceTypes - Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

    • getIncludeGlobalResourceTypes

      public Boolean getIncludeGlobalResourceTypes()

      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

      Returns:
      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

    • withIncludeGlobalResourceTypes

      public RecordingGroup withIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)

      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

      Parameters:
      includeGlobalResourceTypes - Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isIncludeGlobalResourceTypes

      public Boolean isIncludeGlobalResourceTypes()

      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

      Returns:
      Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

      Before you can set this option to true, you must set the allSupported option to true.

      If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

    • getResourceTypes

      public List<String> getResourceTypes()

      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Returns:
      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      See Also:
    • setResourceTypes

      public void setResourceTypes(Collection<String> resourceTypes)

      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Parameters:
      resourceTypes - A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      See Also:
    • withResourceTypes

      public RecordingGroup withResourceTypes(String... resourceTypes)

      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      NOTE: This method appends the values to the existing list (if any). Use setResourceTypes(java.util.Collection) or withResourceTypes(java.util.Collection) if you want to override the existing values.

      Parameters:
      resourceTypes - A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • withResourceTypes

      public RecordingGroup withResourceTypes(Collection<String> resourceTypes)

      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Parameters:
      resourceTypes - A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • withResourceTypes

      public RecordingGroup withResourceTypes(ResourceType... resourceTypes)

      A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Parameters:
      resourceTypes - A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

      Before you can set this option to true, you must set the allSupported option to false.

      If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

      For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public RecordingGroup clone()
      Overrides:
      clone in class Object