Package software.amazon.awscdk.services.config

Class CloudFormationStackDriftDetectionCheck.Builder

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

  • Method Details

    • create

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

    • configRuleName

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

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

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

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

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