software.amazon.awscdk.services.config

Class CloudFormationStackDriftDetectionCheck.Builder

java.lang.Object

software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck.Builder

Enclosing class:

CloudFormationStackDriftDetectionCheck

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

A fluent builder for CloudFormationStackDriftDetectionCheck.

Method Summary

Modifier and Type	Method and Description
CloudFormationStackDriftDetectionCheck	build()
CloudFormationStackDriftDetectionCheck.Builder	configRuleName(java.lang.String configRuleName) A name for the AWS Config rule.
static CloudFormationStackDriftDetectionCheck.Builder	create(software.constructs.Construct scope, java.lang.String id)
CloudFormationStackDriftDetectionCheck.Builder	description(java.lang.String description) A description about this AWS Config rule.
CloudFormationStackDriftDetectionCheck.Builder	inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters) Input parameter values that are passed to the AWS Config rule.
CloudFormationStackDriftDetectionCheck.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
CloudFormationStackDriftDetectionCheck.Builder	ownStackOnly(java.lang.Boolean ownStackOnly) Whether to check only the stack where this rule is deployed.
CloudFormationStackDriftDetectionCheck.Builder	role(IRole role) The IAM role to use for this rule.
CloudFormationStackDriftDetectionCheck.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 CloudFormationStackDriftDetectionCheck.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 CloudFormationStackDriftDetectionCheck.Builder.

configRuleName

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

ownStackOnly

public CloudFormationStackDriftDetectionCheck.Builder ownStackOnly(java.lang.Boolean ownStackOnly)

Whether to check only the stack where this rule is deployed.

Default: false

Parameters:

ownStackOnly - Whether to check only the stack where this rule is deployed. This parameter is required.

Returns:

this

role

public CloudFormationStackDriftDetectionCheck.Builder role(IRole role)

The IAM role to use for this rule.

It must have permissions to detect drift for AWS CloudFormation stacks. Ensure to attach config.amazonaws.com trusted permissions and ReadOnlyAccess policy permissions. For specific policy permissions, refer to https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html.

Default: - A role will be created

Parameters:

role - The IAM role to use for this rule. This parameter is required.

Returns:

this

build

public CloudFormationStackDriftDetectionCheck build()