Class CfnConfigRule.SourceProperty
Provides the CustomPolicyDetails, 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 events that cause the evaluation of your AWS resources.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SourceProperty : Object, CfnConfigRule.ISourceProperty
Syntax (vb)
Public Class SourceProperty
Inherits Object
Implements CfnConfigRule.ISourceProperty
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 sourceProperty = 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"
};
Synopsis
Constructors
Source |
Properties
Custom |
Provides the runtime system, policy definition, and whether debug logging is enabled. |
Owner | Indicates whether AWS or the customer owns and manages the AWS Config rule. |
Source |
Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule. |
Source |
For AWS Config Managed rules, a predefined identifier from a list. |
Constructors
SourceProperty()
public SourceProperty()
Properties
CustomPolicyDetails
Provides the runtime system, policy definition, and whether debug logging is enabled.
public object CustomPolicyDetails { get; set; }
Property Value
System.
Remarks
Required when owner is set to CUSTOM_POLICY
.
Owner
Indicates whether AWS or the customer owns and manages the AWS Config rule.
public string Owner { get; set; }
Property Value
System.
Remarks
AWS Config Managed Rules are predefined rules owned by AWS . For more information, see AWS Config Managed Rules in the AWS Config developer guide .
AWS Config Custom Rules are rules that you can develop either with Guard ( CUSTOM_POLICY
) or AWS Lambda ( CUSTOM_LAMBDA
). For more information, see AWS Config Custom Rules in the AWS Config developer guide .
SourceDetails
Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule.
public object SourceDetails { get; set; }
Property Value
System.
Remarks
It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.
If the owner is set to CUSTOM_POLICY
, the only acceptable values for the AWS Config rule trigger message type are ConfigurationItemChangeNotification
and OversizedConfigurationItemChangeNotification
.
SourceIdentifier
For AWS Config Managed rules, a predefined identifier from a list.
public string SourceIdentifier { get; set; }
Property Value
System.
Remarks
For example, IAM_PASSWORD_POLICY
is a managed rule. To reference a managed rule, see List of AWS Config Managed Rules .
For AWS Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name
.
For AWS Config Custom Policy rules, this field will be ignored.