Skip navigation links

Package software.amazon.awscdk.services.config

AWS Config Construct Library

See: Description

Package software.amazon.awscdk.services.config Description

AWS Config Construct Library

---

Features | Stability ---------------------------------------------------------------------------------------|------------ CFN Resources | Stable Higher level constructs for Config Rules | Stable Higher level constructs for initial set-up (delivery channel & configuration recorder) | Not Implemented

CFN Resources: All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

Stable: Higher level constructs in this module that are marked stable will not undergo any breaking changes. They will strictly follow the Semantic Versioning model.


AWS Config provides a detailed view of the configuration of AWS resources in your AWS account. This includes how the resources are related to one another and how they were configured in the past so that you can see how the configurations and relationships change over time.

This module is part of the AWS Cloud Development Kit project.

Initial Setup

Before using the constructs provided in this module, you need to set up AWS Config in the region in which it will be used. This setup includes the one-time creation of the following resources per region:

The following guides provide the steps for getting started with AWS Config:

Rules

AWS Config can evaluate the configuration settings of your AWS resources by creating AWS Config rules, which represent your ideal configuration settings.

See Evaluating Resources with AWS Config Rules to learn more about AWS Config rules.

AWS Managed Rules

AWS Config provides AWS managed rules, which are predefined, customizable rules that AWS Config uses to evaluate whether your AWS resources comply with common best practices.

For example, you could create a managed rule that checks whether active access keys are rotated within the number of days specified.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import software.amazon.awscdk.core.*;
 
 // https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
 // https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
 new ManagedRule(this, "AccessKeysRotated", new ManagedRuleProps()
         .identifier(config.ManagedRuleIdentifiers.getACCESS_KEYS_ROTATED())
         .inputParameters(Map.of(
                 "maxAccessKeyAge", 60))
         .maximumExecutionFrequency(config.MaximumExecutionFrequency.getTWELVE_HOURS()));
 

Identifiers for AWS managed rules are available through static constants in the ManagedRuleIdentifiers class. You can find supported input parameters in the List of AWS Config Managed Rules.

The following higher level constructs for AWS managed rules are available.

Access Key rotation

Checks whether your active access keys are rotated within the number of days specified.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import aws.cdk.aws.cdk.*;
 
 // compliant if access keys have been rotated within the last 90 days
 // compliant if access keys have been rotated within the last 90 days
 new AccessKeysRotated(this, "AccessKeyRotated");
 

CloudFormation Stack drift detection

Checks whether your CloudFormation stack's actual configuration differs, or has drifted, from it's expected configuration.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import aws.cdk.aws.cdk.*;
 
 // compliant if stack's status is 'IN_SYNC'
 // non-compliant if the stack's drift status is 'DRIFTED'
 // compliant if stack's status is 'IN_SYNC'
 // non-compliant if the stack's drift status is 'DRIFTED'
 new CloudFormationStackDriftDetectionCheck(stack, "Drift", new CloudFormationStackDriftDetectionCheckProps()
         .ownStackOnly(true));
 

CloudFormation Stack notifications

Checks whether your CloudFormation stacks are sending event notifications to a SNS topic.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import aws.cdk.aws.cdk.*;
 
 // topics to which CloudFormation stacks may send event notifications
 Object topic1 = new Topic(stack, "AllowedTopic1");
 Object topic2 = new Topic(stack, "AllowedTopic2");
 
 // non-compliant if CloudFormation stack does not send notifications to 'topic1' or 'topic2'
 // non-compliant if CloudFormation stack does not send notifications to 'topic1' or 'topic2'
 new CloudFormationStackNotificationCheck(this, "NotificationCheck", new CloudFormationStackNotificationCheckProps()
         .topics(asList(topic1, topic2)));
 

Custom rules

You can develop custom rules and add them to AWS Config. You associate each custom rule with an AWS Lambda function, which contains the logic that evaluates whether your AWS resources comply with the rule.

Triggers

AWS Lambda executes functions in response to events that are published by AWS Services. The function for a custom Config rule receives an event that is published by AWS Config, and is responsible for evaluating the compliance of the rule.

Evaluations can be triggered by configuration changes, periodically, or both. To create a custom rule, define a CustomRule and specify the Lambda Function to run and the trigger types.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 
 new CustomRule(this, "CustomRule", new CustomRuleProps()
         .lambdaFunction(evalComplianceFn)
         .configurationChanges(true)
         .periodic(true)
         .maximumExecutionFrequency(config.MaximumExecutionFrequency.getSIX_HOURS()));
 

When the trigger for a rule occurs, the Lambda function is invoked by publishing an event. See example events for AWS Config Rules

The AWS documentation has examples of Lambda functions for evaluations that are triggered by configuration changes and triggered periodically

Scope

By default rules are triggered by changes to all resources.

Use the RuleScope APIs (fromResource(), fromResources() or fromTag()) to restrict the scope of both managed and custom rules:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 
 ManagedRule sshRule = new ManagedRule(this, "SSH", new ManagedRuleProps()
         .identifier(config.ManagedRuleIdentifiers.getEC2_SECURITY_GROUPS_INCOMING_SSH_DISABLED())
         .ruleScope(config.RuleScope.fromResource(config.ResourceType.getEC2_SECURITY_GROUP(), "sg-1234567890abcdefgh")));
 
 CustomRule customRule = new CustomRule(this, "Lambda", new CustomRuleProps()
         .lambdaFunction(evalComplianceFn)
         .configurationChanges(true)
         .ruleScope(config.RuleScope.fromResources(asList(config.ResourceType.getCLOUDFORMATION_STACK(), config.ResourceType.getS3_BUCKET()))));
 
 CustomRule tagRule = new CustomRule(this, "CostCenterTagRule", new CustomRuleProps()
         .lambdaFunction(evalComplianceFn)
         .configurationChanges(true)
         .ruleScope(config.RuleScope.fromTag("Cost Center", "MyApp")));
 

Events

You can define Amazon EventBridge event rules which trigger when a compliance check fails or when a rule is re-evaluated.

Use the onComplianceChange() APIs to trigger an EventBridge event when a compliance check of your AWS Config Rule fails:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.events.targets.*;
 
 // Topic to which compliance notification events will be published
 Topic complianceTopic = new Topic(this, "ComplianceTopic");
 
 CloudFormationStackDriftDetectionCheck rule = new CloudFormationStackDriftDetectionCheck(this, "Drift");
 rule.onComplianceChange("TopicEvent", new OnEventOptions()
         .target(new SnsTopic(complianceTopic)));
 

Use the onReEvaluationStatus() status to trigger an EventBridge event when an AWS Config rule is re-evaluated.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.events.targets.*;
 
 // Topic to which re-evaluation notification events will be published
 Topic reEvaluationTopic = new Topic(this, "ComplianceTopic");
 rule.onReEvaluationStatus("ReEvaluationEvent", Map.of(
         "target", new SnsTopic(reEvaluationTopic)));
 

Example

The following example creates a custom rule that evaluates whether EC2 instances are compliant. Compliance events are published to an SNS topic.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.config.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.events.targets.*;
 
 // Lambda function containing logic that evaluates compliance with the rule.
 Function evalComplianceFn = new Function(this, "CustomFunction", new FunctionProps()
         .code(lambda.AssetCode.fromInline("exports.handler = (event) => console.log(event);"))
         .handler("index.handler")
         .runtime(lambda.Runtime.getNODEJS_12_X()));
 
 // A custom rule that runs on configuration changes of EC2 instances
 CustomRule customRule = new CustomRule(this, "Custom", new CustomRuleProps()
         .configurationChanges(true)
         .lambdaFunction(evalComplianceFn)
         .ruleScope(config.RuleScope.fromResource(asList(config.ResourceType.getEC2_INSTANCE()))));
 
 // A rule to detect stack drifts
 CloudFormationStackDriftDetectionCheck driftRule = new CloudFormationStackDriftDetectionCheck(this, "Drift");
 
 // Topic to which compliance notification events will be published
 Topic complianceTopic = new Topic(this, "ComplianceTopic");
 
 // Send notification on compliance change events
 driftRule.onComplianceChange("ComplianceChange", new OnEventOptions()
         .target(new SnsTopic(complianceTopic)));
 
Skip navigation links