Interface ICfnConfigRuleProps
Properties for defining a CfnConfigRule
.
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConfigRuleProps
Syntax (vb)
Public Interface ICfnConfigRuleProps
Remarks
See: 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;
var cfnConfigRuleProps = new CfnConfigRuleProps {
Source = new SourceProperty {
Owner = "owner",
// the properties below are optional
CustomPolicyDetails = new CustomPolicyDetailsProperty {
EnableDebugLogDelivery = false,
PolicyRuntime = "policyRuntime",
PolicyText = "policyText"
},
SourceDetails = new [] { new SourceDetailProperty {
EventSource = "eventSource",
MessageType = "messageType",
// the properties below are optional
MaximumExecutionFrequency = "maximumExecutionFrequency"
} },
SourceIdentifier = "sourceIdentifier"
},
// the properties below are optional
Compliance = new ComplianceProperty {
Type = "type"
},
ConfigRuleName = "configRuleName",
Description = "description",
EvaluationModes = new [] { new EvaluationModeConfigurationProperty {
Mode = "mode"
} },
InputParameters = inputParameters,
MaximumExecutionFrequency = "maximumExecutionFrequency",
Scope = new ScopeProperty {
ComplianceResourceId = "complianceResourceId",
ComplianceResourceTypes = new [] { "complianceResourceTypes" },
TagKey = "tagKey",
TagValue = "tagValue"
}
};
Synopsis
Properties
Compliance | Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance. |
ConfigRuleName | A name for the AWS Config rule. |
Description | The description that you provide for the AWS Config rule. |
EvaluationModes | The modes the AWS Config rule can be evaluated in. |
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 ( |
Properties
Compliance
Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.
virtual object Compliance { get; }
Property Value
System.Object
Remarks
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 .
Description
The description that you provide for the AWS Config rule.
virtual string Description { get; }
Property Value
System.String
Remarks
EvaluationModes
The modes the AWS Config rule can be evaluated in.
virtual object EvaluationModes { get; }
Property Value
System.Object
Remarks
The valid values are distinct objects. By default, the value is Detective evaluation mode only.
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
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.
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.
Source
Provides the rule owner ( AWS
for managed rules, CUSTOM_POLICY
for Custom Policy rules, and CUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
object Source { get; }
Property Value
System.Object