software.amazon.awscdk.services.config

Class CustomRule.Builder

java.lang.Object

software.amazon.awscdk.services.config.CustomRule.Builder

Enclosing class:

CustomRule

public static final class CustomRule.Builder
extends java.lang.Object

A fluent builder for CustomRule.

Method Summary

Modifier and Type	Method and Description
CustomRule	build()
CustomRule.Builder	configRuleName(java.lang.String configRuleName) A name for the AWS Config rule.
CustomRule.Builder	configurationChanges(java.lang.Boolean configurationChanges) Whether to run the rule on configuration changes.
static CustomRule.Builder	create(software.constructs.Construct scope, java.lang.String id)
CustomRule.Builder	description(java.lang.String description) A description about this AWS Config rule.
CustomRule.Builder	inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters) Input parameter values that are passed to the AWS Config rule.
CustomRule.Builder	lambdaFunction(IFunction lambdaFunction) The Lambda function to run.
CustomRule.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
CustomRule.Builder	periodic(java.lang.Boolean periodic) Whether to run the rule on a fixed frequency.
CustomRule.Builder	ruleScope(RuleScope ruleScope) Defines which resources trigger an evaluation for an AWS Config rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CustomRule.Builder create(software.constructs.Construct scope,
                                        java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CustomRule.Builder.

configRuleName

public CustomRule.Builder configRuleName(java.lang.String configRuleName)

A name for the AWS Config rule.

Default: - CloudFormation generated name

Parameters:

configRuleName - A name for the AWS Config rule. This parameter is required.

Returns:

this

description

public CustomRule.Builder description(java.lang.String description)

A description about this AWS Config rule.

Default: - No description

Parameters:

description - A description about this AWS Config rule. This parameter is required.

Returns:

this

inputParameters

public CustomRule.Builder inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters)

Input parameter values that are passed to the AWS Config rule.

Default: - No input parameters

Parameters:

inputParameters - Input parameter values that are passed to the AWS Config rule. This parameter is required.

Returns:

this

maximumExecutionFrequency

public CustomRule.Builder maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)

The maximum frequency at which the AWS Config rule runs evaluations.

Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

Parameters:

maximumExecutionFrequency - The maximum frequency at which the AWS Config rule runs evaluations. This parameter is required.

Returns:

this

ruleScope

public CustomRule.Builder ruleScope(RuleScope ruleScope)

Defines which resources trigger an evaluation for an AWS Config rule.

Default: - evaluations for the rule are triggered when any resource in the recording group changes.

Parameters:

ruleScope - Defines which resources trigger an evaluation for an AWS Config rule. This parameter is required.

Returns:

this

lambdaFunction

public CustomRule.Builder lambdaFunction(IFunction lambdaFunction)

The Lambda function to run.

Parameters:

lambdaFunction - The Lambda function to run. This parameter is required.

Returns:

this

configurationChanges

public CustomRule.Builder configurationChanges(java.lang.Boolean configurationChanges)

Whether to run the rule on configuration changes.

Default: false

Parameters:

configurationChanges - Whether to run the rule on configuration changes. This parameter is required.

Returns:

this

periodic

public CustomRule.Builder periodic(java.lang.Boolean periodic)

Whether to run the rule on a fixed frequency.

Default: false

Parameters:

periodic - Whether to run the rule on a fixed frequency. This parameter is required.

Returns:

this

build

public CustomRule build()