Class CfnConfigurationRecorder

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnConfigurationRecorder
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConfigurationRecorder : CfnResource, IInspectable
Syntax (vb)
Public Class CfnConfigurationRecorder
    Inherits CfnResource
    Implements IInspectable
Remarks

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 SNS 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html

CloudformationResource: AWS::Config::ConfigurationRecorder

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Config;

var cfnConfigurationRecorder = new CfnConfigurationRecorder(this, "MyCfnConfigurationRecorder", new CfnConfigurationRecorderProps {
    RoleArn = "roleArn",

    // the properties below are optional
    Name = "name",
    RecordingGroup = new RecordingGroupProperty {
        AllSupported = false,
        ExclusionByResourceTypes = new ExclusionByResourceTypesProperty {
            ResourceTypes = new [] { "resourceTypes" }
        },
        IncludeGlobalResourceTypes = false,
        RecordingStrategy = new RecordingStrategyProperty {
            UseOnly = "useOnly"
        },
        ResourceTypes = new [] { "resourceTypes" }
    },
    RecordingMode = new RecordingModeProperty {
        RecordingFrequency = "recordingFrequency",

        // the properties below are optional
        RecordingModeOverrides = new [] { new RecordingModeOverrideProperty {
            RecordingFrequency = "recordingFrequency",
            ResourceTypes = new [] { "resourceTypes" },

            // the properties below are optional
            Description = "description"
        } }
    }
});

Synopsis

Constructors

CfnConfigurationRecorder(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnConfigurationRecorder(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnConfigurationRecorder(Construct, String, ICfnConfigurationRecorderProps)

Properties

AttrId
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Name

The name of the configuration recorder.
RecordingGroup

Specifies which resource types AWS Config records for configuration changes.
RecordingMode

Specifies the default recording frequency for the configuration recorder.
RoleArn

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnConfigurationRecorder(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnConfigurationRecorder(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnConfigurationRecorder(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnConfigurationRecorder(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnConfigurationRecorder(Construct, String, ICfnConfigurationRecorderProps)

public CfnConfigurationRecorder(Construct scope, string id, ICfnConfigurationRecorderProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnConfigurationRecorderProps

Resource properties.

Properties

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Name

The name of the configuration recorder.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

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

RecordingGroup

Specifies which resource types AWS Config records for configuration changes.

public virtual object RecordingGroup { get; set; }
Property Value

System.Object

RecordingMode

Specifies the default recording frequency for the configuration recorder.

public virtual object RecordingMode { get; set; }
Property Value

System.Object

Remarks

AWS Config supports Continuous recording and Daily recording .

RoleArn

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

public virtual string RoleArn { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements