public static final class CustomRule.Builder
extends java.lang.Object
CustomRule
.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.
|
public static CustomRule.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.CustomRule.Builder
.public CustomRule.Builder configRuleName(java.lang.String configRuleName)
Default: - CloudFormation generated name
configRuleName
- A name for the AWS Config rule. This parameter is required.this
public CustomRule.Builder description(java.lang.String description)
Default: - No description
description
- A description about this AWS Config rule. This parameter is required.this
public CustomRule.Builder inputParameters(java.util.Map<java.lang.String,? extends java.lang.Object> inputParameters)
Default: - No input parameters
inputParameters
- Input parameter values that are passed to the AWS Config rule. This parameter is required.this
public CustomRule.Builder maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
maximumExecutionFrequency
- The maximum frequency at which the AWS Config rule runs evaluations. This parameter is required.this
public CustomRule.Builder ruleScope(RuleScope ruleScope)
Default: - evaluations for the rule are triggered when any resource in the recording group changes.
ruleScope
- Defines which resources trigger an evaluation for an AWS Config rule. This parameter is required.this
public CustomRule.Builder lambdaFunction(IFunction lambdaFunction)
lambdaFunction
- The Lambda function to run. This parameter is required.this
public CustomRule.Builder configurationChanges(java.lang.Boolean configurationChanges)
Default: false
configurationChanges
- Whether to run the rule on configuration changes. This parameter is required.this
public CustomRule.Builder periodic(java.lang.Boolean periodic)
Default: false
periodic
- Whether to run the rule on a fixed frequency. This parameter is required.this
public CustomRule build()