Interface ConfigRule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ConfigRule.Builder,
,ConfigRule> SdkBuilder<ConfigRule.Builder,
,ConfigRule> SdkPojo
- Enclosing class:
ConfigRule
-
Method Summary
Modifier and TypeMethodDescriptionconfigRuleArn
(String configRuleArn) The Amazon Resource Name (ARN) of the Config rule.configRuleId
(String configRuleId) The ID of the Config rule.configRuleName
(String configRuleName) The name that you assign to the Config rule.configRuleState
(String configRuleState) Indicates whether the Config rule is active or is currently being deleted by Config.configRuleState
(ConfigRuleState configRuleState) Indicates whether the Config rule is active or is currently being deleted by Config.Service principal name of the service that created the rule.description
(String description) The description that you provide for the Config rule.evaluationModes
(Collection<EvaluationModeConfiguration> evaluationModes) The modes the Config rule can be evaluated in.evaluationModes
(Consumer<EvaluationModeConfiguration.Builder>... evaluationModes) The modes the Config rule can be evaluated in.evaluationModes
(EvaluationModeConfiguration... evaluationModes) The modes the Config rule can be evaluated in.inputParameters
(String inputParameters) A string, in JSON format, that is passed to the Config rule Lambda function.maximumExecutionFrequency
(String maximumExecutionFrequency) The maximum frequency with which Config runs evaluations for a rule.maximumExecutionFrequency
(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency with which Config runs evaluations for a rule.default ConfigRule.Builder
scope
(Consumer<Scope.Builder> scope) Defines which resources can trigger an evaluation for the rule.Defines which resources can trigger an evaluation for the rule.default ConfigRule.Builder
source
(Consumer<Source.Builder> source) Provides the rule owner (Amazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.Provides the rule owner (Amazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
configRuleName
The name that you assign to the Config rule. The name is required if you are adding a new rule.
- Parameters:
configRuleName
- The name that you assign to the 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
The Amazon Resource Name (ARN) of the Config rule.
- Parameters:
configRuleArn
- The Amazon Resource Name (ARN) of the Config rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configRuleId
The ID of the Config rule.
- Parameters:
configRuleId
- The ID of the Config rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description that you provide for the Config rule.
- Parameters:
description
- The description that you provide for the Config rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
Scope.Builder
avoiding the need to create one manually viaScope.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscope(Scope)
.- Parameters:
scope
- a consumer that will call methods onScope.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
source
Provides the rule owner (
Amazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.- Parameters:
source
- Provides the rule owner (Amazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
source
Provides the rule owner (
This is a convenience method that creates an instance of theAmazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.Source.Builder
avoiding the need to create one manually viaSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosource(Source)
.- Parameters:
source
- a consumer that will call methods onSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
inputParameters
A string, in JSON format, that is passed to the Config rule Lambda function.
- Parameters:
inputParameters
- A string, in JSON format, that is passed to the Config rule Lambda function.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maximumExecutionFrequency
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when 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 Config runs evaluations for a rule. You can specify a value forMaximumExecutionFrequency
when:-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when 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
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when 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 Config runs evaluations for a rule. You can specify a value forMaximumExecutionFrequency
when:-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when 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:
-
-
configRuleState
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to
EVALUATING
temporarily after you use theStartConfigRulesEvaluation
request to evaluate your resources against the Config rule.Config sets the state of the rule to
DELETING_RESULTS
temporarily after you use theDeleteEvaluationResults
request to delete the current evaluation results for the Config rule.Config temporarily sets the state of a rule to
DELETING
after you use theDeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.- Parameters:
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.Config sets the state of the rule to
EVALUATING
temporarily after you use theStartConfigRulesEvaluation
request to evaluate your resources against the Config rule.Config sets the state of the rule to
DELETING_RESULTS
temporarily after you use theDeleteEvaluationResults
request to delete the current evaluation results for the Config rule.Config temporarily sets the state of a rule to
DELETING
after you use theDeleteConfigRule
request to delete the rule. After 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
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to
EVALUATING
temporarily after you use theStartConfigRulesEvaluation
request to evaluate your resources against the Config rule.Config sets the state of the rule to
DELETING_RESULTS
temporarily after you use theDeleteEvaluationResults
request to delete the current evaluation results for the Config rule.Config temporarily sets the state of a rule to
DELETING
after you use theDeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.- Parameters:
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.Config sets the state of the rule to
EVALUATING
temporarily after you use theStartConfigRulesEvaluation
request to evaluate your resources against the Config rule.Config sets the state of the rule to
DELETING_RESULTS
temporarily after you use theDeleteEvaluationResults
request to delete the current evaluation results for the Config rule.Config temporarily sets the state of a rule to
DELETING
after you use theDeleteConfigRule
request to delete the rule. After 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:
-
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.
-
evaluationModes
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
- Parameters:
evaluationModes
- The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationModes
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
- Parameters:
evaluationModes
- The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationModes
ConfigRule.Builder evaluationModes(Consumer<EvaluationModeConfiguration.Builder>... evaluationModes) The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
This is a convenience method that creates an instance of theEvaluationModeConfiguration.Builder
avoiding the need to create one manually viaEvaluationModeConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toevaluationModes(List<EvaluationModeConfiguration>)
.- Parameters:
evaluationModes
- a consumer that will call methods onEvaluationModeConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-