Package software.amazon.awscdk.services.config

Class CustomRule.Builder

java.lang.Object
software.amazon.awscdk.services.config.CustomRule.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CustomRule>
Enclosing class:
CustomRule
@Stability(Stable) public static final class CustomRule.Builder extends Object implements software.amazon.jsii.Builder<CustomRule>
A fluent builder for CustomRule.

  • Method Details

    • create

      @Stability(Stable) public static CustomRule.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of CustomRule.Builder.

    • configRuleName

      @Stability(Stable) public CustomRule.Builder configRuleName(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

      @Stability(Stable) public CustomRule.Builder description(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

      @Stability(Stable) public CustomRule.Builder inputParameters(Map<String,? extends 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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public CustomRule.Builder configurationChanges(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

      @Stability(Stable) public CustomRule.Builder periodic(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

      @Stability(Stable) public CustomRule build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CustomRule>
      Returns:
      a newly built instance of CustomRule.