software.amazon.awssdk.services.config.model

Interface ConfigRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConfigRule.Builder,ConfigRule>, SdkBuilder<ConfigRule.Builder,ConfigRule>, SdkPojo

Enclosing class:

ConfigRule

public static interface ConfigRule.Builder
extends SdkPojo, CopyableBuilder<ConfigRule.Builder,ConfigRule>

Method Summary

Modifier and Type	Method and Description
ConfigRule.Builder	configRuleArn(String configRuleArn) The Amazon Resource Name (ARN) of the AWS Config rule.
ConfigRule.Builder	configRuleId(String configRuleId) The ID of the AWS Config rule.
ConfigRule.Builder	configRuleName(String configRuleName) The name that you assign to the AWS Config rule.
ConfigRule.Builder	configRuleState(ConfigRuleState configRuleState) Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config.
ConfigRule.Builder	configRuleState(String configRuleState) Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config.
ConfigRule.Builder	createdBy(String createdBy) Service principal name of the service that created the rule.
ConfigRule.Builder	description(String description) The description that you provide for the AWS Config rule.
ConfigRule.Builder	inputParameters(String inputParameters) A string, in JSON format, that is passed to the AWS Config rule Lambda function.
ConfigRule.Builder	maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency with which AWS Config runs evaluations for a rule.
ConfigRule.Builder	maximumExecutionFrequency(String maximumExecutionFrequency) The maximum frequency with which AWS Config runs evaluations for a rule.
default ConfigRule.Builder	scope(Consumer<Scope.Builder> scope) Defines which resources can trigger an evaluation for the rule.
ConfigRule.Builder	scope(Scope scope) Defines which resources can trigger an evaluation for the rule.
default ConfigRule.Builder	source(Consumer<Source.Builder> source) Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
ConfigRule.Builder	source(Source source) Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

configRuleName

ConfigRule.Builder configRuleName(String configRuleName)

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Parameters:

configRuleName - The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

configRuleArn

ConfigRule.Builder configRuleArn(String configRuleArn)

The Amazon Resource Name (ARN) of the AWS Config rule.

Parameters:

configRuleArn - The Amazon Resource Name (ARN) of the AWS Config rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

configRuleId

ConfigRule.Builder configRuleId(String configRuleId)

The ID of the AWS Config rule.

Parameters:

configRuleId - The ID of the AWS Config rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ConfigRule.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scope

ConfigRule.Builder scope(Scope 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scope

default ConfigRule.Builder scope(Consumer<Scope.Builder> 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.

This is a convenience that creates an instance of the Scope.Builder avoiding the need to create one manually via Scope.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scope(Scope).

Parameters:

scope - a consumer that will call methods on Scope.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

scope(Scope)

source

ConfigRule.Builder source(Source source)

Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

Parameters:

source - Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default ConfigRule.Builder source(Consumer<Source.Builder> source)

Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

This is a convenience that creates an instance of the Source.Builder avoiding the need to create one manually via Source.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(Source).

Parameters:

source - a consumer that will call methods on Source.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

source(Source)

inputParameters

ConfigRule.Builder inputParameters(String 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maximumExecutionFrequency

ConfigRule.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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MaximumExecutionFrequency, MaximumExecutionFrequency

maximumExecutionFrequency

ConfigRule.Builder maximumExecutionFrequency(MaximumExecutionFrequency 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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MaximumExecutionFrequency, MaximumExecutionFrequency

configRuleState

ConfigRule.Builder configRuleState(String configRuleState)

Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigRuleState, ConfigRuleState

configRuleState

ConfigRule.Builder configRuleState(ConfigRuleState configRuleState)

Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigRuleState, ConfigRuleState

createdBy

ConfigRule.Builder createdBy(String createdBy)

Service principal name of the service that created the rule.

The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.

Parameters:

createdBy - Service principal name of the service that created the rule.

The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.

Returns:

Returns a reference to this object so that method calls can be chained together.