software.amazon.awscdk.services.config

Class CfnConfigurationAggregator

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.config.CfnConfigurationAggregator

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.728Z")
public class CfnConfigurationAggregator
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Config::ConfigurationAggregator`.

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 CfnConfigurationAggregator cfnConfigurationAggregator = CfnConfigurationAggregator.Builder.create(this, "MyCfnConfigurationAggregator")
         .accountAggregationSources(List.of(AccountAggregationSourceProperty.builder()
                 .accountIds(List.of("accountIds"))
                 // the properties below are optional
                 .allAwsRegions(false)
                 .awsRegions(List.of("awsRegions"))
                 .build()))
         .configurationAggregatorName("configurationAggregatorName")
         .organizationAggregationSource(OrganizationAggregationSourceProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .allAwsRegions(false)
                 .awsRegions(List.of("awsRegions"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConfigurationAggregator.AccountAggregationSourceProperty A collection of accounts and regions.
static class	CfnConfigurationAggregator.Builder A fluent builder for CfnConfigurationAggregator.
static interface	CfnConfigurationAggregator.OrganizationAggregationSourceProperty This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigurationAggregator(Construct scope, java.lang.String id) Create a new `AWS::Config::ConfigurationAggregator`.
	CfnConfigurationAggregator(Construct scope, java.lang.String id, CfnConfigurationAggregatorProps props) Create a new `AWS::Config::ConfigurationAggregator`.
protected	CfnConfigurationAggregator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationAggregator(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAccountAggregationSources() Provides a list of source accounts and regions to be aggregated.
java.lang.String	getAttrConfigurationAggregatorArn() The Amazon Resource Name (ARN) of the aggregator.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConfigurationAggregatorName() The name of the aggregator.
java.lang.Object	getOrganizationAggregationSource() Provides an organization and list of regions to be aggregated.
TagManager	getTags() An array of tag object.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccountAggregationSources(IResolvable value) Provides a list of source accounts and regions to be aggregated.
void	setAccountAggregationSources(java.util.List<java.lang.Object> value) Provides a list of source accounts and regions to be aggregated.
void	setConfigurationAggregatorName(java.lang.String value) The name of the aggregator.
void	setOrganizationAggregationSource(CfnConfigurationAggregator.OrganizationAggregationSourceProperty value) Provides an organization and list of regions to be aggregated.
void	setOrganizationAggregationSource(IResolvable value) Provides an organization and list of regions to be aggregated.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfigurationAggregator

protected CfnConfigurationAggregator(software.amazon.jsii.JsiiObjectRef objRef)

CfnConfigurationAggregator

protected CfnConfigurationAggregator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConfigurationAggregator

public CfnConfigurationAggregator(Construct scope,
                                  java.lang.String id,
                                  CfnConfigurationAggregatorProps props)

Create a new `AWS::Config::ConfigurationAggregator`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnConfigurationAggregator

public CfnConfigurationAggregator(Construct scope,
                                  java.lang.String id)

Create a new `AWS::Config::ConfigurationAggregator`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConfigurationAggregatorArn

public java.lang.String getAttrConfigurationAggregatorArn()

The Amazon Resource Name (ARN) of the aggregator.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of tag object.

getAccountAggregationSources

public java.lang.Object getAccountAggregationSources()

Provides a list of source accounts and regions to be aggregated.

setAccountAggregationSources

public void setAccountAggregationSources(IResolvable value)

Provides a list of source accounts and regions to be aggregated.

setAccountAggregationSources

public void setAccountAggregationSources(java.util.List<java.lang.Object> value)

Provides a list of source accounts and regions to be aggregated.

getConfigurationAggregatorName

public java.lang.String getConfigurationAggregatorName()

The name of the aggregator.

setConfigurationAggregatorName

public void setConfigurationAggregatorName(java.lang.String value)

The name of the aggregator.

getOrganizationAggregationSource

public java.lang.Object getOrganizationAggregationSource()

Provides an organization and list of regions to be aggregated.

setOrganizationAggregationSource

public void setOrganizationAggregationSource(IResolvable value)

Provides an organization and list of regions to be aggregated.

setOrganizationAggregationSource

public void setOrganizationAggregationSource(CfnConfigurationAggregator.OrganizationAggregationSourceProperty value)

Provides an organization and list of regions to be aggregated.