Interface ICfnConfigRuleProps

Properties for defining a CfnConfigRule.

Namespace: Amazon.CDK.AWS.Config

Assembly: Amazon.CDK.AWS.Config.dll

Syntax (csharp)

public interface ICfnConfigRuleProps

Syntax (vb)

Public Interface ICfnConfigRuleProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html

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 inputParameters;

CfnConfigRuleProps cfnConfigRuleProps = new CfnConfigRuleProps {
    Source = new SourceProperty {
        Owner = "owner",
        SourceIdentifier = "sourceIdentifier",

        // the properties below are optional
        SourceDetails = new [] { new SourceDetailProperty {
            EventSource = "eventSource",
            MessageType = "messageType",

            // the properties below are optional
            MaximumExecutionFrequency = "maximumExecutionFrequency"
        } }
    },

    // the properties below are optional
    ConfigRuleName = "configRuleName",
    Description = "description",
    InputParameters = inputParameters,
    MaximumExecutionFrequency = "maximumExecutionFrequency",
    Scope = new ScopeProperty {
        ComplianceResourceId = "complianceResourceId",
        ComplianceResourceTypes = new [] { "complianceResourceTypes" },
        TagKey = "tagKey",
        TagValue = "tagValue"
    }
};

Synopsis

Properties

ConfigRuleName	A name for the AWS Config rule.
Description	The description that you provide for the AWS Config rule.
InputParameters	A string, in JSON format, that is passed to the AWS Config rule Lambda function.
MaximumExecutionFrequency	The maximum frequency with which AWS Config runs evaluations for a rule.
Scope	Defines which resources can trigger an evaluation for the rule.
Source	Provides the rule owner ( AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

Properties

ConfigRuleName

A name for the AWS Config rule.

virtual string ConfigRuleName { get; }

Property Value

System.String

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-configrulename

Description

The description that you provide for the AWS Config rule.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-description

InputParameters

A string, in JSON format, that is passed to the AWS Config rule Lambda function.

virtual object InputParameters { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-inputparameters

MaximumExecutionFrequency

The maximum frequency with which AWS Config runs evaluations for a rule.

virtual string MaximumExecutionFrequency { get; }

Property Value

System.String

Remarks

You can specify a value for MaximumExecutionFrequency when:

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-maximumexecutionfrequency

Scope

Defines which resources can trigger an evaluation for the rule.

virtual object Scope { get; }

Property Value

System.Object

Remarks

The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-scope

Source

Provides the rule owner ( AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

object Source { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-source