Class ConfigRule
- All Implemented Interfaces:
Serializable
,Cloneable
An AWS Lambda function that evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource, or when it delivers a configuration snapshot of the resources in the account.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The Amazon Resource Name (ARN) of the AWS Config rule.The ID of the AWS Config rule.The name that you assign to the AWS Config rule.Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.The description that you provide for the AWS Config rule.A string in JSON format that is passed to the AWS Config rule Lambda function.The maximum frequency at which the AWS Config rule runs evaluations.getScope()
Defines which resources can trigger an evaluation for the rule.Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.int
hashCode()
void
setConfigRuleArn
(String configRuleArn) The Amazon Resource Name (ARN) of the AWS Config rule.void
setConfigRuleId
(String configRuleId) The ID of the AWS Config rule.void
setConfigRuleName
(String configRuleName) The name that you assign to the AWS Config rule.void
setConfigRuleState
(ConfigRuleState configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.void
setConfigRuleState
(String configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.void
setDescription
(String description) The description that you provide for the AWS Config rule.void
setInputParameters
(String inputParameters) A string in JSON format that is passed to the AWS Config rule Lambda function.void
setMaximumExecutionFrequency
(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.void
setMaximumExecutionFrequency
(String maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.void
Defines which resources can trigger an evaluation for the rule.void
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.toString()
Returns a string representation of this object; useful for testing and debugging.withConfigRuleArn
(String configRuleArn) The Amazon Resource Name (ARN) of the AWS Config rule.withConfigRuleId
(String configRuleId) The ID of the AWS Config rule.withConfigRuleName
(String configRuleName) The name that you assign to the AWS Config rule.withConfigRuleState
(ConfigRuleState configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.withConfigRuleState
(String configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.withDescription
(String description) The description that you provide for the AWS Config rule.withInputParameters
(String inputParameters) A string in JSON format that is passed to the AWS Config rule Lambda function.withMaximumExecutionFrequency
(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.withMaximumExecutionFrequency
(String maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.Defines which resources can trigger an evaluation for the rule.withSource
(Source source) Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
-
Constructor Details
-
ConfigRule
public ConfigRule()
-
-
Method Details
-
setConfigRuleName
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.
-
getConfigRuleName
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
- Returns:
- The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
-
withConfigRuleName
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.
-
setConfigRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
- Parameters:
configRuleArn
- The Amazon Resource Name (ARN) of the AWS Config rule.
-
getConfigRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
- Returns:
- The Amazon Resource Name (ARN) of the AWS Config rule.
-
withConfigRuleArn
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.
-
setConfigRuleId
The ID of the AWS Config rule.
- Parameters:
configRuleId
- The ID of the AWS Config rule.
-
getConfigRuleId
The ID of the AWS Config rule.
- Returns:
- The ID of the AWS Config rule.
-
withConfigRuleId
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.
-
setDescription
The description that you provide for the AWS Config rule.
- Parameters:
description
- The description that you provide for the AWS Config rule.
-
getDescription
The description that you provide for the AWS Config rule.
- Returns:
- The description that you provide for the AWS Config rule.
-
withDescription
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.
-
setScope
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.
-
getScope
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:
- 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.
-
withScope
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.
-
setSource
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
- Parameters:
source
- Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
-
getSource
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
- Returns:
- Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
-
withSource
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
- Parameters:
source
- Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInputParameters
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.
-
getInputParameters
A string in JSON format that is passed to the AWS Config rule Lambda function.
- Returns:
- A string in JSON format that is passed to the AWS Config rule Lambda function.
-
withInputParameters
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.
-
setMaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Parameters:
maximumExecutionFrequency
- The maximum frequency at which the AWS Config rule runs evaluations.If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- See Also:
-
getMaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Returns:
- The maximum frequency at which the AWS Config rule runs
evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action. - See Also:
-
withMaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Parameters:
maximumExecutionFrequency
- The maximum frequency at which the AWS Config rule runs evaluations.If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setMaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Parameters:
maximumExecutionFrequency
- The maximum frequency at which the AWS Config rule runs evaluations.If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- See Also:
-
withMaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Parameters:
maximumExecutionFrequency
- The maximum frequency at which the AWS Config rule runs evaluations.If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the
MaximumExecutionFrequency
key to be equal to or greater than the value of thedeliveryFrequency
key, which is part ofConfigSnapshotDeliveryProperties
. To update the frequency with which AWS Config delivers your snapshots, use thePutDeliveryChannel
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setConfigRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Parameters:
configRuleState
- Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- See Also:
-
getConfigRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Returns:
- Indicates whether the AWS Config rule is active or currently
being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request. - See Also:
-
withConfigRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Parameters:
configRuleState
- Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setConfigRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Parameters:
configRuleState
- Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- See Also:
-
withConfigRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Parameters:
configRuleState
- Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.AWS Config sets the state of a rule to
DELETING
temporarily after you use theDeleteConfigRule
request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.You cannot add a rule to AWS Config that has the state set to
DELETING
. If you want to delete a rule, you must use theDeleteConfigRule
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-