1.204.0

interface CfnConfigurationRecorderProps

LanguageType name
.NETAmazon.CDK.AWS.Config.CfnConfigurationRecorderProps
Javasoftware.amazon.awscdk.services.config.CfnConfigurationRecorderProps
Pythonaws_cdk.aws_config.CfnConfigurationRecorderProps
TypeScript @aws-cdk/aws-config » CfnConfigurationRecorderProps

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 * as config from '@aws-cdk/aws-config';
const cfnConfigurationRecorderProps: config.CfnConfigurationRecorderProps = {
  roleArn: 'roleArn',

  // the properties below are optional
  name: 'name',
  recordingGroup: {
    allSupported: false,
    includeGlobalResourceTypes: false,
    resourceTypes: ['resourceTypes'],
  },
};

Properties

NameTypeDescription
roleArnstringThe Amazon Resource Name (ARN) of the IAM (IAM) role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources.
name?stringA name for the configuration recorder.
recordingGroup?IResolvable | RecordingGroupPropertyIndicates whether to record configurations for all supported resources or for a list of resource types.

roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM (IAM) role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources.

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

name?

Type: string (optional)

A name for the configuration recorder.

If you don't specify a name, AWS CloudFormation CloudFormation generates a unique physical ID and uses that ID for the configuration recorder name. For more information, see Name Type .

After you create a configuration recorder, you cannot rename it. If you don't want a name that AWS CloudFormation generates, specify a value for this property.

Updates are not supported.

recordingGroup?

Type: IResolvable | RecordingGroupProperty (optional)

Indicates whether to record configurations for all supported resources or for a list of resource types.

The resource types that you list must be supported by AWS Config .

← PreviousNext →