com.amazonaws.services.config.model

Class RecordingGroup

java.lang.Object

com.amazonaws.services.config.model.RecordingGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecordingGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies which Amazon Web Services resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or only specific types of resources.

By default, Config records the configuration changes for all supported types of regional resources that 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 Config record supported types of global resources. Global resources are not tied to a specific region and can be used in all regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies.

Global resource types onboarded to Config recording after February 2022 will only be recorded in the service's home region for the commercial partition and Amazon Web Services GovCloud (US) West for the GovCloud partition. You can view the Configuration Items for these new global resource types only in their home region and Amazon Web Services GovCloud (US) West.

Supported global resource types onboarded before February 2022 such as AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User remain unchanged, and they will continue to deliver Configuration Items in all supported regions in Config. The change will only affect new global resource types onboarded after February 2022.

To record global resource types onboarded after February 2022, enable All Supported Resource Types in the home region of the global resource type you want to record.

If you don't want 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 and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecordingGroup()

Method Summary

Modifier and Type	Method and Description
RecordingGroup	clone()
boolean	equals(Object obj)
Boolean	getAllSupported() Specifies whether Config records configuration changes for every supported type of regional resource.
Boolean	getIncludeGlobalResourceTypes() Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
List<String>	getResourceTypes() A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
int	hashCode()
Boolean	isAllSupported() Specifies whether Config records configuration changes for every supported type of regional resource.
Boolean	isIncludeGlobalResourceTypes() Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAllSupported(Boolean allSupported) Specifies whether Config records configuration changes for every supported type of regional resource.
void	setIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes) Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
void	setResourceTypes(Collection<String> resourceTypes) A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
String	toString() Returns a string representation of this object.
RecordingGroup	withAllSupported(Boolean allSupported) Specifies whether Config records configuration changes for every supported type of regional resource.
RecordingGroup	withIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes) Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
RecordingGroup	withResourceTypes(Collection<String> resourceTypes) A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
RecordingGroup	withResourceTypes(ResourceType... resourceTypes) A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
RecordingGroup	withResourceTypes(String... resourceTypes) A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordingGroup

public RecordingGroup()

Method Detail

setAllSupported

public void setAllSupported(Boolean allSupported)

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

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

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

Parameters:

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

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

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

getAllSupported

public Boolean getAllSupported()

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

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

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

Returns:

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

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

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

withAllSupported

public RecordingGroup withAllSupported(Boolean allSupported)

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

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

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

Parameters:

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

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

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 Config records configuration changes for every supported type of regional resource.

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

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

Returns:

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

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

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

setIncludeGlobalResourceTypes

public void setIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)

Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

Parameters:

includeGlobalResourceTypes - Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

getIncludeGlobalResourceTypes

public Boolean getIncludeGlobalResourceTypes()

Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

Returns:

Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

withIncludeGlobalResourceTypes

public RecordingGroup withIncludeGlobalResourceTypes(Boolean includeGlobalResourceTypes)

Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

Parameters:

includeGlobalResourceTypes - Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing 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 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

Returns:

Specifies whether 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 Config adds support for a new type of global resource, it starts recording resources of that type automatically.

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

getResourceTypes

public List<String> getResourceTypes()

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Returns:

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

See Also:

ResourceType

setResourceTypes

public void setResourceTypes(Collection<String> resourceTypes)

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Parameters:

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

See Also:

ResourceType

withResourceTypes

public RecordingGroup withResourceTypes(String... resourceTypes)

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services 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 Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail ).

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Returns:

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

See Also:

ResourceType

withResourceTypes

public RecordingGroup withResourceTypes(Collection<String> resourceTypes)

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Parameters:

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Returns:

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

See Also:

ResourceType

withResourceTypes

public RecordingGroup withResourceTypes(ResourceType... resourceTypes)

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Parameters:

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

To record all configuration changes, you must set the allSupported option to true.

If you set the AllSupported option to false and populate the ResourceTypes option with values, when 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 Amazon Web Services resource Types.

Returns:

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

See Also:

ResourceType

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 RecordingGroup 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.