software.amazon.awscdk.services.config

Class CfnConfigurationAggregator

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.config.CfnConfigurationAggregator

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.721Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigurationAggregator(software.constructs.Construct scope, String id) Create a new `AWS::Config::ConfigurationAggregator`.
	CfnConfigurationAggregator(software.constructs.Construct scope, 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
Object	getAccountAggregationSources() Provides a list of source accounts and regions to be aggregated.
String	getAttrConfigurationAggregatorArn() The Amazon Resource Name (ARN) of the aggregator.
protected Map<String,Object>	getCfnProperties()
String	getConfigurationAggregatorName() The name of the aggregator.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccountAggregationSources(IResolvable value) Provides a list of source accounts and regions to be aggregated.
void	setAccountAggregationSources(List<Object> value) Provides a list of source accounts and regions to be aggregated.
void	setConfigurationAggregatorName(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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnConfigurationAggregator(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @Nullable
                                                           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

@Stability(value=Stable)
public CfnConfigurationAggregator(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConfigurationAggregatorArn

@Stability(value=Stable)
 @NotNull
public String getAttrConfigurationAggregatorArn()

The Amazon Resource Name (ARN) of the aggregator.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of tag object.

getAccountAggregationSources

@Stability(value=Stable)
 @Nullable
public Object getAccountAggregationSources()

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

setAccountAggregationSources

@Stability(value=Stable)
public void setAccountAggregationSources(@Nullable
                                                                  IResolvable value)

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

setAccountAggregationSources

@Stability(value=Stable)
public void setAccountAggregationSources(@Nullable
                                                                  List<Object> value)

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

getConfigurationAggregatorName

@Stability(value=Stable)
 @Nullable
public String getConfigurationAggregatorName()

The name of the aggregator.

setConfigurationAggregatorName

@Stability(value=Stable)
public void setConfigurationAggregatorName(@Nullable
                                                                    String value)

The name of the aggregator.

getOrganizationAggregationSource

@Stability(value=Stable)
 @Nullable
public Object getOrganizationAggregationSource()

Provides an organization and list of regions to be aggregated.

setOrganizationAggregationSource

@Stability(value=Stable)
public void setOrganizationAggregationSource(@Nullable
                                                                      CfnConfigurationAggregator.OrganizationAggregationSourceProperty value)

Provides an organization and list of regions to be aggregated.

setOrganizationAggregationSource

@Stability(value=Stable)
public void setOrganizationAggregationSource(@Nullable
                                                                      IResolvable value)

Provides an organization and list of regions to be aggregated.