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

Class CfnConfigurationRecorderPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConfigurationRecorderPropsMixin>

Enclosing class:

CfnConfigurationRecorderPropsMixin

@Stability(Stable)
public static final class CfnConfigurationRecorderPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnConfigurationRecorderPropsMixin>

A fluent builder for CfnConfigurationRecorderPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnConfigurationRecorderPropsMixin	build()
static CfnConfigurationRecorderPropsMixin.Builder	create()
static CfnConfigurationRecorderPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnConfigurationRecorderPropsMixin.Builder	name(String name)	The name of the configuration recorder.
CfnConfigurationRecorderPropsMixin.Builder	recordingGroup(CfnConfigurationRecorderPropsMixin.RecordingGroupProperty recordingGroup)	Specifies which resource types AWS Config records for configuration changes.
CfnConfigurationRecorderPropsMixin.Builder	recordingGroup(IResolvable recordingGroup)	Specifies which resource types AWS Config records for configuration changes.
CfnConfigurationRecorderPropsMixin.Builder	recordingMode(CfnConfigurationRecorderPropsMixin.RecordingModeProperty recordingMode)	Specifies the default recording frequency for the configuration recorder.
CfnConfigurationRecorderPropsMixin.Builder	recordingMode(IResolvable recordingMode)	Specifies the default recording frequency for the configuration recorder.
CfnConfigurationRecorderPropsMixin.Builder	roleArn(String roleArn)	Amazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder.
CfnConfigurationRecorderPropsMixin.Builder	startedOnCreate(Boolean startedOnCreate)	Defaults to 'true'.
CfnConfigurationRecorderPropsMixin.Builder	startedOnCreate(IResolvable startedOnCreate)	Defaults to 'true'.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnConfigurationRecorderPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnConfigurationRecorderPropsMixin.Builder.

create

@Stability(Stable)
public static CfnConfigurationRecorderPropsMixin.Builder create()

Returns:

a new instance of CfnConfigurationRecorderPropsMixin.Builder.

name

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder name(String name)

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.

Parameters:

name - The name of the configuration recorder. AWS Config automatically assigns the name of "default" when creating the configuration recorder. This parameter is required.

Returns:

this

See Also:

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

recordingGroup

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder recordingGroup(IResolvable recordingGroup)

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.

Parameters:

recordingGroup - Specifies which resource types AWS Config records for configuration changes. This parameter is required.

Returns:

this

See Also:

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

recordingGroup

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder recordingGroup(CfnConfigurationRecorderPropsMixin.RecordingGroupProperty recordingGroup)

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.

Parameters:

recordingGroup - Specifies which resource types AWS Config records for configuration changes. This parameter is required.

Returns:

this

See Also:

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

recordingMode

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder recordingMode(IResolvable recordingMode)

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.

Parameters:

recordingMode - Specifies the default recording frequency for the configuration recorder. AWS Config supports Continuous recording and Daily recording . This parameter is required.

Returns:

this

See Also:

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

recordingMode

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder recordingMode(CfnConfigurationRecorderPropsMixin.RecordingModeProperty recordingMode)

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.

Parameters:

recordingMode - Specifies the default recording frequency for the configuration recorder. AWS Config supports Continuous recording and Daily recording . This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder roleArn(String roleArn)

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 .

Parameters:

roleArn - Amazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder. This parameter is required.

Returns:

this

See Also:

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

startedOnCreate

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder startedOnCreate(Boolean startedOnCreate)

Defaults to 'true'.

Controls whether the recorder starts recording after the create operation. Set this to 'false' for development and testing purposes.

Default: - true

Parameters:

startedOnCreate - Defaults to 'true'. This parameter is required.

Returns:

this

See Also:

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

startedOnCreate

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin.Builder startedOnCreate(IResolvable startedOnCreate)

Defaults to 'true'.

Controls whether the recorder starts recording after the create operation. Set this to 'false' for development and testing purposes.

Default: - true

Parameters:

startedOnCreate - Defaults to 'true'. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnConfigurationRecorderPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnConfigurationRecorderPropsMixin>

Returns:

a newly built instance of CfnConfigurationRecorderPropsMixin.