Package software.amazon.awscdk.services.config

Class CfnConfigurationAggregator

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.536Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationAggregator

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

    • CfnConfigurationAggregator

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

    • CfnConfigurationAggregator

      @Stability(Stable) public CfnConfigurationAggregator(@NotNull 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(Stable) public CfnConfigurationAggregator(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrConfigurationAggregatorArn()
      The Amazon Resource Name (ARN) of the aggregator.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of tag object.

    • getAccountAggregationSources

      @Stability(Stable) @Nullable public Object getAccountAggregationSources()
      Provides a list of source accounts and regions to be aggregated.

    • setAccountAggregationSources

      @Stability(Stable) public void setAccountAggregationSources(@Nullable IResolvable value)
      Provides a list of source accounts and regions to be aggregated.

    • setAccountAggregationSources

      @Stability(Stable) public void setAccountAggregationSources(@Nullable List<Object> value)
      Provides a list of source accounts and regions to be aggregated.

    • getConfigurationAggregatorName

      @Stability(Stable) @Nullable public String getConfigurationAggregatorName()
      The name of the aggregator.

    • setConfigurationAggregatorName

      @Stability(Stable) public void setConfigurationAggregatorName(@Nullable String value)
      The name of the aggregator.

    • getOrganizationAggregationSource

      @Stability(Stable) @Nullable public Object getOrganizationAggregationSource()
      Provides an organization and list of regions to be aggregated.

    • setOrganizationAggregationSource

      @Stability(Stable) public void setOrganizationAggregationSource(@Nullable IResolvable value)
      Provides an organization and list of regions to be aggregated.

    • setOrganizationAggregationSource

      @Stability(Stable) public void setOrganizationAggregationSource(@Nullable CfnConfigurationAggregator.OrganizationAggregationSourceProperty value)
      Provides an organization and list of regions to be aggregated.