Package software.amazon.awscdk.services.config

Interface CfnConfigRule.SourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigRule.SourceProperty.Jsii$Proxy

Enclosing class:

CfnConfigRule

@Stability(Stable)
public static interface CfnConfigRule.SourceProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 SourceProperty sourceProperty = SourceProperty.builder()
         .owner("owner")
         // the properties below are optional
         .customPolicyDetails(CustomPolicyDetailsProperty.builder()
                 .enableDebugLogDelivery(false)
                 .policyRuntime("policyRuntime")
                 .policyText("policyText")
                 .build())
         .sourceDetails(List.of(SourceDetailProperty.builder()
                 .eventSource("eventSource")
                 .messageType("messageType")
                 // the properties below are optional
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .build()))
         .sourceIdentifier("sourceIdentifier")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigRule.SourceProperty.Builder	A builder for CfnConfigRule.SourceProperty
static final class	CfnConfigRule.SourceProperty.Jsii$Proxy	An implementation for CfnConfigRule.SourceProperty

Method Summary

Modifier and Type	Method	Description
static CfnConfigRule.SourceProperty.Builder	builder()
default Object	getCustomPolicyDetails()	Provides the runtime system, policy definition, and whether debug logging is enabled.
String	getOwner()	Indicates whether AWS or the customer owns and manages the AWS Config rule.
default Object	getSourceDetails()	Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule.
default String	getSourceIdentifier()	For AWS Config Managed rules, a predefined identifier from a list.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOwner

@Stability(Stable)
@NotNull
String getOwner()

Indicates whether AWS or the customer owns and manages the AWS Config rule.

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 .

getCustomPolicyDetails

@Stability(Stable)
@Nullable
default Object getCustomPolicyDetails()

Provides the runtime system, policy definition, and whether debug logging is enabled.

Required when owner is set to CUSTOM_POLICY .

getSourceDetails

@Stability(Stable)
@Nullable
default Object getSourceDetails()

Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule.

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 .

getSourceIdentifier

@Stability(Stable)
@Nullable
default String getSourceIdentifier()

For AWS Config Managed rules, a predefined identifier from a list.

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.

builder

@Stability(Stable)
static CfnConfigRule.SourceProperty.Builder builder()

Returns:

a CfnConfigRule.SourceProperty.Builder of CfnConfigRule.SourceProperty