software.amazon.awscdk.services.config

Class CustomRuleProps.Builder

java.lang.Object

software.amazon.awscdk.services.config.CustomRuleProps.Builder

Enclosing interface:

CustomRuleProps

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

A builder for CustomRuleProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CustomRuleProps	build() Builds the configured instance.
CustomRuleProps.Builder	configRuleName(java.lang.String configRuleName) Sets the value of RuleProps.getConfigRuleName()
CustomRuleProps.Builder	configurationChanges(java.lang.Boolean configurationChanges) Sets the value of CustomRuleProps.getConfigurationChanges()
CustomRuleProps.Builder	description(java.lang.String description) Sets the value of RuleProps.getDescription()
CustomRuleProps.Builder	inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters) Sets the value of RuleProps.getInputParameters()
CustomRuleProps.Builder	lambdaFunction(IFunction lambdaFunction) Sets the value of CustomRuleProps.getLambdaFunction()
CustomRuleProps.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) Sets the value of RuleProps.getMaximumExecutionFrequency()
CustomRuleProps.Builder	periodic(java.lang.Boolean periodic) Sets the value of CustomRuleProps.getPeriodic()
CustomRuleProps.Builder	ruleScope(RuleScope ruleScope) Sets the value of RuleProps.getRuleScope()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

lambdaFunction

public CustomRuleProps.Builder lambdaFunction(IFunction lambdaFunction)

Sets the value of CustomRuleProps.getLambdaFunction()

Parameters:

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

Returns:

this

configurationChanges

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

Sets the value of CustomRuleProps.getConfigurationChanges()

Parameters:

configurationChanges - Whether to run the rule on configuration changes.

Returns:

this

periodic

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

Sets the value of CustomRuleProps.getPeriodic()

Parameters:

periodic - Whether to run the rule on a fixed frequency.

Returns:

this

configRuleName

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

Sets the value of RuleProps.getConfigRuleName()

Parameters:

configRuleName - A name for the AWS Config rule.

Returns:

this

description

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

Sets the value of RuleProps.getDescription()

Parameters:

description - A description about this AWS Config rule.

Returns:

this

inputParameters

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

Sets the value of RuleProps.getInputParameters()

Parameters:

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

Returns:

this

maximumExecutionFrequency

public CustomRuleProps.Builder maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)

Sets the value of RuleProps.getMaximumExecutionFrequency()

Parameters:

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

Returns:

this

ruleScope

public CustomRuleProps.Builder ruleScope(RuleScope ruleScope)

Sets the value of RuleProps.getRuleScope()

Parameters:

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

Returns:

this

build

public CustomRuleProps build()

Builds the configured instance.

Returns:

a new instance of CustomRuleProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided