Package software.amazon.awscdk.services.config

Class CfnConfigRule.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnConfigRule.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnConfigRule.Builder.

    • source

      @Stability(Stable) public CfnConfigRule.Builder source(CfnConfigRule.SourceProperty source)
      Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

      Parameters:
      source - Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. This parameter is required.
      Returns:
      this

    • source

      @Stability(Stable) public CfnConfigRule.Builder source(IResolvable source)
      Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

      Parameters:
      source - Provides the rule owner ( AWS for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. This parameter is required.
      Returns:
      this

    • configRuleName

      @Stability(Stable) public CfnConfigRule.Builder configRuleName(String configRuleName)
      A name for the AWS Config rule.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type .

      Parameters:
      configRuleName - A name for the AWS Config rule. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnConfigRule.Builder description(String description)
      The description that you provide for the AWS Config rule.

      Parameters:
      description - The description that you provide for the AWS Config rule. This parameter is required.
      Returns:
      this

    • inputParameters

      @Stability(Stable) public CfnConfigRule.Builder inputParameters(Object inputParameters)
      A string, in JSON format, that is passed to the AWS Config rule Lambda function.

      Parameters:
      inputParameters - A string, in JSON format, that is passed to the AWS Config rule Lambda function. This parameter is required.
      Returns:
      this

    • maximumExecutionFrequency

      @Stability(Stable) public CfnConfigRule.Builder maximumExecutionFrequency(String maximumExecutionFrequency)
      The maximum frequency with which AWS Config runs evaluations for a rule.

      You can specify a value for MaximumExecutionFrequency when:

      • You are using an AWS managed rule that is triggered at a periodic frequency.
      • Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .

      By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

      Parameters:
      maximumExecutionFrequency - The maximum frequency with which AWS Config runs evaluations for a rule. This parameter is required.
      Returns:
      this

    • scope

      @Stability(Stable) public CfnConfigRule.Builder scope(IResolvable scope)
      Defines which resources can trigger an evaluation for the rule.

      The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

      The scope can be empty.

      Parameters:
      scope - Defines which resources can trigger an evaluation for the rule. This parameter is required.
      Returns:
      this

    • scope

      @Stability(Stable) public CfnConfigRule.Builder scope(CfnConfigRule.ScopeProperty scope)
      Defines which resources can trigger an evaluation for the rule.

      The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

      The scope can be empty.

      Parameters:
      scope - Defines which resources can trigger an evaluation for the rule. This parameter is required.
      Returns:
      this

    • build

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