class CfnConfigurationRecorderPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Config.Mixins.CfnConfigurationRecorderPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsconfig/mixins#CfnConfigurationRecorderPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.config.mixins.CfnConfigurationRecorderPropsMixin
Python	aws_cdk.mixins_preview.aws_config.mixins.CfnConfigurationRecorderPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_config » mixins » CfnConfigurationRecorderPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as config_mixins } from '@aws-cdk/mixins-preview/aws-config';
const cfnConfigurationRecorderPropsMixin = new config_mixins.CfnConfigurationRecorderPropsMixin({
  name: 'name',
  recordingGroup: {
    allSupported: false,
    exclusionByResourceTypes: {
      resourceTypes: ['resourceTypes'],
    },
    includeGlobalResourceTypes: false,
    recordingStrategy: {
      useOnly: 'useOnly',
    },
    resourceTypes: ['resourceTypes'],
  },
  recordingMode: {
    recordingFrequency: 'recordingFrequency',
    recordingModeOverrides: [{
      description: 'description',
      recordingFrequency: 'recordingFrequency',
      resourceTypes: ['resourceTypes'],
    }],
  },
  roleArn: 'roleArn',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnConfigurationRecorderPropsMixin(props: CfnConfigurationRecorderMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnConfigurationRecorderMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnConfigurationRecorderMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnConfigurationRecorderMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.