Class CfnConfigurationRecorder
A CloudFormation AWS::Config::ConfigurationRecorder
.
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.AWS.Config.dll
Syntax (csharp)
public class CfnConfigurationRecorder : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnConfigurationRecorder
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Config::ConfigurationRecorder resource describes the AWS resource types for which AWS Config records configuration changes. The configuration recorder stores the configurations of the supported 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.
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,
IncludeGlobalResourceTypes = false,
ResourceTypes = new [] { "resourceTypes" }
}
});
Synopsis
Constructors
CfnConfigurationRecorder(Construct, String, ICfnConfigurationRecorderProps) | Create a new |
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 |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | A name for the configuration recorder. |
RecordingGroup | Indicates whether to record configurations for all supported resources or for a list of resource types. |
RoleArn | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConfigurationRecorder(Construct, String, ICfnConfigurationRecorderProps)
Create a new AWS::Config::ConfigurationRecorder
.
public CfnConfigurationRecorder(Construct scope, string id, ICfnConfigurationRecorderProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnConfigurationRecorderProps
- resource properties.
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
Properties
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
A name for the configuration recorder.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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
Indicates whether to record configurations for all supported resources or for a list of resource types.
public virtual object RecordingGroup { get; set; }
Property Value
System.Object
Remarks
The resource types that you list must be supported by AWS Config .
RoleArn
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.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
For more information, see Permissions for the IAM Role Assigned to AWS Config in the AWS Config Developer Guide.
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>