Package software.amazon.awscdk.services.config

Interface CfnConfigurationRecorderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationRecorderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:07.607Z")
@Stability(Stable)
public interface CfnConfigurationRecorderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfigurationRecorder.

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.*;
 CfnConfigurationRecorderProps cfnConfigurationRecorderProps = CfnConfigurationRecorderProps.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .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")
                 // the properties below are optional
                 .recordingModeOverrides(List.of(RecordingModeOverrideProperty.builder()
                         .recordingFrequency("recordingFrequency")
                         .resourceTypes(List.of("resourceTypes"))
                         // the properties below are optional
                         .description("description")
                         .build()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationRecorderProps.Builder	A builder for CfnConfigurationRecorderProps
static final class	CfnConfigurationRecorderProps.Jsii$Proxy	An implementation for CfnConfigurationRecorderProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationRecorderProps.Builder	builder()
default String	getName()	The name of the configuration recorder.
default Object	getRecordingGroup()	Specifies which resource types AWS Config records for configuration changes.
default Object	getRecordingMode()	Specifies the default recording frequency for the configuration recorder.
String	getRoleArn()	Amazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

Amazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder.

For more information, see Permissions for the IAM Role Assigned to AWS Config in the AWS Config Developer Guide.

Pre-existing AWS Config role

If you have used an AWS service that uses AWS Config , such as AWS Security Hub CSPM or AWS Control Tower , and an AWS Config role has already been created, make sure that the IAM role that you use when setting up AWS Config keeps the same minimum permissions as the already created AWS Config role. You must do this so that the other AWS service continues to run as expected.

For example, if AWS Control Tower has an IAM role that allows AWS Config to read Amazon Simple Storage Service ( Amazon S3 ) objects, make sure that the same permissions are granted within the IAM role you use when setting up AWS Config . Otherwise, it may interfere with how AWS Control Tower operates. For more information about IAM roles for AWS Config , see Identity and Access Management for AWS Config in the AWS Config Developer Guide .

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the configuration recorder. AWS Config automatically assigns the name of "default" when creating the configuration recorder.

You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.

See Also:

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

getRecordingGroup

@Stability(Stable)
@Nullable
default Object getRecordingGroup()

Specifies which resource types AWS Config records for configuration changes.

High Number of AWS Config Evaluations

You may notice increased activity in your account during your initial month recording with AWS Config when compared to subsequent months. During the initial bootstrapping process, AWS Config runs evaluations on all the resources in your account that you have selected for AWS Config to record.

If you are running ephemeral workloads, you may see increased activity from AWS Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud ( Amazon EC2 ) Spot Instances, Amazon EMR jobs, and AWS Auto Scaling . If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with AWS Config turned off to avoid increased configuration recording and rule evaluations.

Returns union: either IResolvable or CfnConfigurationRecorder.RecordingGroupProperty

See Also:

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

getRecordingMode

@Stability(Stable)
@Nullable
default Object getRecordingMode()

Specifies the default recording frequency for the configuration recorder. AWS Config supports Continuous recording and Daily recording .

• Continuous recording allows you to record configuration changes continuously whenever a change occurs.
• Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Some resource types require continuous recording

AWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

Returns union: either IResolvable or CfnConfigurationRecorder.RecordingModeProperty

See Also:

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

builder

@Stability(Stable)
static CfnConfigurationRecorderProps.Builder builder()

Returns:

a CfnConfigurationRecorderProps.Builder of CfnConfigurationRecorderProps