Class CfnConfigurationRecorder

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConfigurationRecorder

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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(Construct, string, ICfnConfigurationRecorderProps)

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

Properties

AttrId	The AWS::Config::ConfigurationRecorder resource type describes the AWS resource types that AWS Config records for configuration changes.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Config::ConfigurationRecorder resource type describes the AWS resource types that AWS Config records for configuration changes.
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>)	The AWS::Config::ConfigurationRecorder resource type describes the AWS resource types that AWS Config records for configuration changes.

Constructors

CfnConfigurationRecorder(Construct, string, ICfnConfigurationRecorderProps)

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

public CfnConfigurationRecorder(Construct scope, string id, ICfnConfigurationRecorderProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnConfigurationRecorderProps

Resource properties.

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

Properties

AttrId

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

public virtual string AttrId { get; }

Property Value

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

string

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

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

Name

The name of the configuration recorder.

public virtual string? Name { get; set; }

Property Value

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

object

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

RecordingMode

Specifies the default recording frequency for the configuration recorder.

public virtual object? RecordingMode { get; set; }

Property Value

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

string

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

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.

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable