software.amazon.awscdk.services.config

Class ManagedRule.Builder

java.lang.Object

software.amazon.awscdk.services.config.ManagedRule.Builder

Enclosing class:

ManagedRule

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

A fluent builder for ManagedRule.

Method Summary

Modifier and Type	Method and Description
ManagedRule	build()
ManagedRule.Builder	configRuleName(java.lang.String configRuleName) A name for the AWS Config rule.
static ManagedRule.Builder	create(software.constructs.Construct scope, java.lang.String id)
ManagedRule.Builder	description(java.lang.String description) A description about this AWS Config rule.
ManagedRule.Builder	identifier(java.lang.String identifier) The identifier of the AWS managed rule.
ManagedRule.Builder	inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters) Input parameter values that are passed to the AWS Config rule.
ManagedRule.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
ManagedRule.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 ManagedRule.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 ManagedRule.Builder.

configRuleName

public ManagedRule.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 ManagedRule.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 ManagedRule.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 ManagedRule.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 ManagedRule.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

identifier

public ManagedRule.Builder identifier(java.lang.String identifier)

The identifier of the AWS managed rule.

Parameters:

identifier - The identifier of the AWS managed rule. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html

build

public ManagedRule build()