Interface IRuleProps
Construction properties for a new rule.
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IRuleProps
Syntax (vb)
Public Interface IRuleProps
Remarks
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;
RuleScope ruleScope;
var ruleProps = new RuleProps {
ConfigRuleName = "configRuleName",
Description = "description",
InputParameters = new Dictionary<string, object> {
{ "inputParametersKey", inputParameters }
},
MaximumExecutionFrequency = MaximumExecutionFrequency.ONE_HOUR,
RuleScope = ruleScope
};
Synopsis
Properties
ConfigRuleName | A name for the AWS Config rule. |
Description | A description about this AWS Config rule. |
InputParameters | Input parameter values that are passed to the AWS Config rule. |
MaximumExecutionFrequency | The maximum frequency at which the AWS Config rule runs evaluations. |
RuleScope | Defines which resources trigger an evaluation for an AWS Config rule. |
Properties
ConfigRuleName
A name for the AWS Config rule.
virtual string ConfigRuleName { get; }
Property Value
System.String
Remarks
Default: - CloudFormation generated name
Description
A description about this AWS Config rule.
virtual string Description { get; }
Property Value
System.String
Remarks
Default: - No description
InputParameters
Input parameter values that are passed to the AWS Config rule.
virtual IDictionary<string, object> InputParameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: - No input parameters
MaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
virtual Nullable<MaximumExecutionFrequency> MaximumExecutionFrequency { get; }
Property Value
System.Nullable<MaximumExecutionFrequency>
Remarks
Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
RuleScope
Defines which resources trigger an evaluation for an AWS Config rule.
virtual RuleScope RuleScope { get; }
Property Value
Remarks
Default: - evaluations for the rule are triggered when any resource in the recording group changes.