Package software.amazon.awscdk.cfnpropertymixins.services.config

Class CfnConfigurationRecorderPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.config.CfnConfigurationRecorderPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.496Z")
@Stability(Stable)
public class CfnConfigurationRecorderPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Config::ConfigurationRecorder resource type describes the AWS resource types that AWS Config records for configuration changes.

The configuration recorder stores the configuration changes of the specified resources in your account as configuration items.

To enable AWS Config , you must create a configuration recorder and a delivery channel.

AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon topic. For more information, see AWS::Config::DeliveryChannel .

AWS CloudFormation starts the recorder as soon as the delivery channel is available.

To stop the recorder and delete it, delete the configuration recorder from your stack. To stop the recorder without deleting it, call the StopConfigurationRecorder action of the AWS Config API directly.

For more information, see Configuration Recorder in the AWS Config Developer Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.config.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnConfigurationRecorderPropsMixin cfnConfigurationRecorderPropsMixin = CfnConfigurationRecorderPropsMixin.Builder.create(CfnConfigurationRecorderMixinProps.builder()
         .name("name")
         .recordingGroup(RecordingGroupProperty.builder()
                 .allSupported(false)
                 .exclusionByResourceTypes(ExclusionByResourceTypesProperty.builder()
                         .resourceTypes(List.of("resourceTypes"))
                         .build())
                 .includeGlobalResourceTypes(false)
                 .recordingStrategy(RecordingStrategyProperty.builder()
                         .useOnly("useOnly")
                         .build())
                 .resourceTypes(List.of("resourceTypes"))
                 .build())
         .recordingMode(RecordingModeProperty.builder()
                 .recordingFrequency("recordingFrequency")
                 .recordingModeOverrides(List.of(RecordingModeOverrideProperty.builder()
                         .description("description")
                         .recordingFrequency("recordingFrequency")
                         .resourceTypes(List.of("resourceTypes"))
                         .build()))
                 .build())
         .roleArn("roleArn")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnConfigurationRecorderPropsMixin.Builder	A fluent builder for CfnConfigurationRecorderPropsMixin.
static interface	CfnConfigurationRecorderPropsMixin.ExclusionByResourceTypesProperty	Specifies whether the configuration recorder excludes certain resource types from being recorded.
static interface	CfnConfigurationRecorderPropsMixin.RecordingGroupProperty	Specifies which resource types AWS Config records for configuration changes.
static interface	CfnConfigurationRecorderPropsMixin.RecordingModeOverrideProperty	An object for you to specify your overrides for the recording mode.
static interface	CfnConfigurationRecorderPropsMixin.RecordingModeProperty	Specifies the default recording frequency that AWS Config uses to record configuration changes.
static interface	CfnConfigurationRecorderPropsMixin.RecordingStrategyProperty	Specifies the recording strategy of the configuration recorder.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnConfigurationRecorderPropsMixin(CfnConfigurationRecorderMixinProps props)	Create a mixin to apply properties to AWS::Config::ConfigurationRecorder.
	CfnConfigurationRecorderPropsMixin(CfnConfigurationRecorderMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Config::ConfigurationRecorder.
protected	CfnConfigurationRecorderPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationRecorderPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnConfigurationRecorderMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnConfigurationRecorderPropsMixin

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

CfnConfigurationRecorderPropsMixin

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

CfnConfigurationRecorderPropsMixin

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin(@NotNull
 CfnConfigurationRecorderMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Config::ConfigurationRecorder.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnConfigurationRecorderPropsMixin

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin(@NotNull
 CfnConfigurationRecorderMixinProps props)

Create a mixin to apply properties to AWS::Config::ConfigurationRecorder.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnConfigurationRecorderMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()