public class ConfigRule
extends java.lang.Object
implements java.io.Serializable, java.lang.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.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
configRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
|
private java.lang.String |
configRuleId
The ID of the AWS Config rule.
|
private java.lang.String |
configRuleName
The name that you assign to the AWS Config rule.
|
private java.lang.String |
configRuleState
Indicates whether the AWS Config rule is active or currently being
deleted by AWS Config.
|
private java.lang.String |
description
The description that you provide for the AWS Config rule.
|
private java.lang.String |
inputParameters
A string in JSON format that is passed to the AWS Config rule Lambda
function.
|
private java.lang.String |
maximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
|
private Scope |
scope
Defines which resources can trigger an evaluation for the rule.
|
private 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 and Description |
---|
ConfigRule() |
Modifier and Type | Method and Description |
---|---|
ConfigRule |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getConfigRuleArn()
The Amazon Resource Name (ARN) of the AWS Config rule.
|
java.lang.String |
getConfigRuleId()
The ID of the AWS Config rule.
|
java.lang.String |
getConfigRuleName()
The name that you assign to the AWS Config rule.
|
java.lang.String |
getConfigRuleState()
Indicates whether the AWS Config rule is active or currently being
deleted by AWS Config.
|
java.lang.String |
getDescription()
The description that you provide for the AWS Config rule.
|
java.lang.String |
getInputParameters()
A string in JSON format that is passed to the AWS Config rule Lambda
function.
|
java.lang.String |
getMaximumExecutionFrequency()
The maximum frequency at which the AWS Config rule runs evaluations.
|
Scope |
getScope()
Defines which resources can trigger an evaluation for the rule.
|
Source |
getSource()
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(java.lang.String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
|
void |
setConfigRuleId(java.lang.String configRuleId)
The ID of the AWS Config rule.
|
void |
setConfigRuleName(java.lang.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(java.lang.String configRuleState)
Indicates whether the AWS Config rule is active or currently being
deleted by AWS Config.
|
void |
setDescription(java.lang.String description)
The description that you provide for the AWS Config rule.
|
void |
setInputParameters(java.lang.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(java.lang.String maximumExecutionFrequency)
The maximum frequency at which the AWS Config rule runs evaluations.
|
void |
setScope(Scope scope)
Defines which resources can trigger an evaluation for the rule.
|
void |
setSource(Source source)
Provides the rule owner (AWS or customer), the rule identifier, and the
events that cause the function to evaluate your AWS resources.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfigRule |
withConfigRuleArn(java.lang.String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
|
ConfigRule |
withConfigRuleId(java.lang.String configRuleId)
The ID of the AWS Config rule.
|
ConfigRule |
withConfigRuleName(java.lang.String configRuleName)
The name that you assign to the AWS Config rule.
|
ConfigRule |
withConfigRuleState(ConfigRuleState configRuleState)
Indicates whether the AWS Config rule is active or currently being
deleted by AWS Config.
|
ConfigRule |
withConfigRuleState(java.lang.String configRuleState)
Indicates whether the AWS Config rule is active or currently being
deleted by AWS Config.
|
ConfigRule |
withDescription(java.lang.String description)
The description that you provide for the AWS Config rule.
|
ConfigRule |
withInputParameters(java.lang.String inputParameters)
A string in JSON format that is passed to the AWS Config rule Lambda
function.
|
ConfigRule |
withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency at which the AWS Config rule runs evaluations.
|
ConfigRule |
withMaximumExecutionFrequency(java.lang.String maximumExecutionFrequency)
The maximum frequency at which the AWS Config rule runs evaluations.
|
ConfigRule |
withScope(Scope scope)
Defines which resources can trigger an evaluation for the rule.
|
ConfigRule |
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.
|
private java.lang.String configRuleName
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
private java.lang.String configRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
private java.lang.String configRuleId
The ID of the AWS Config rule.
private java.lang.String description
The description that you provide for the AWS Config rule.
private 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.
private Source source
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
private java.lang.String inputParameters
A string in JSON format that is passed to the AWS Config rule Lambda function.
private java.lang.String 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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
private java.lang.String 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
public void setConfigRuleName(java.lang.String configRuleName)
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
configRuleName
- The name that you assign to the AWS Config rule. The name is
required if you are adding a new rule.public java.lang.String getConfigRuleName()
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
public ConfigRule withConfigRuleName(java.lang.String configRuleName)
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
configRuleName
- The name that you assign to the AWS Config rule. The name is
required if you are adding a new rule.public void setConfigRuleArn(java.lang.String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
configRuleArn
- The Amazon Resource Name (ARN) of the AWS Config rule.public java.lang.String getConfigRuleArn()
The Amazon Resource Name (ARN) of the AWS Config rule.
public ConfigRule withConfigRuleArn(java.lang.String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
configRuleArn
- The Amazon Resource Name (ARN) of the AWS Config rule.public void setConfigRuleId(java.lang.String configRuleId)
The ID of the AWS Config rule.
configRuleId
- The ID of the AWS Config rule.public java.lang.String getConfigRuleId()
The ID of the AWS Config rule.
public ConfigRule withConfigRuleId(java.lang.String configRuleId)
The ID of the AWS Config rule.
configRuleId
- The ID of the AWS Config rule.public void setDescription(java.lang.String description)
The description that you provide for the AWS Config rule.
description
- The description that you provide for the AWS Config rule.public java.lang.String getDescription()
The description that you provide for the AWS Config rule.
public ConfigRule withDescription(java.lang.String description)
The description that you provide for the AWS Config rule.
description
- The description that you provide for the AWS Config rule.public void setScope(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.
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.public Scope 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.
public ConfigRule withScope(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.
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.public void setSource(Source source)
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
source
- Provides the rule owner (AWS or customer), the rule identifier,
and the events that cause the function to evaluate your AWS
resources.public Source getSource()
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
public ConfigRule 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.
source
- Provides the rule owner (AWS or customer), the rule identifier,
and the events that cause the function to evaluate your AWS
resources.public void setInputParameters(java.lang.String inputParameters)
A string in JSON format that is passed to the AWS Config rule Lambda function.
inputParameters
- A string in JSON format that is passed to the AWS Config rule
Lambda function.public java.lang.String getInputParameters()
A string in JSON format that is passed to the AWS Config rule Lambda function.
public ConfigRule withInputParameters(java.lang.String inputParameters)
A string in JSON format that is passed to the AWS Config rule Lambda function.
inputParameters
- A string in JSON format that is passed to the AWS Config rule
Lambda function.public void setMaximumExecutionFrequency(java.lang.String 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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
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 the deliveryFrequency
key,
which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your
snapshots, use the PutDeliveryChannel
action.
MaximumExecutionFrequency
public java.lang.String 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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
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 the deliveryFrequency
key,
which is part of ConfigSnapshotDeliveryProperties
.
To update the frequency with which AWS Config delivers your
snapshots, use the PutDeliveryChannel
action.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(java.lang.String 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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
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 the deliveryFrequency
key,
which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your
snapshots, use the PutDeliveryChannel
action.
MaximumExecutionFrequency
public void setMaximumExecutionFrequency(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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
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 the deliveryFrequency
key,
which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your
snapshots, use the PutDeliveryChannel
action.
MaximumExecutionFrequency
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 the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel
action.
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 the deliveryFrequency
key,
which is part of ConfigSnapshotDeliveryProperties
. To
update the frequency with which AWS Config delivers your
snapshots, use the PutDeliveryChannel
action.
MaximumExecutionFrequency
public void setConfigRuleState(java.lang.String 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
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 the DeleteConfigRule
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
the DeleteConfigRule
request.
ConfigRuleState
public java.lang.String 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
AWS Config sets the state of a rule to DELETING
temporarily after you use the DeleteConfigRule
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
the DeleteConfigRule
request.
ConfigRuleState
public ConfigRule withConfigRuleState(java.lang.String 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
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 the DeleteConfigRule
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
the DeleteConfigRule
request.
ConfigRuleState
public void setConfigRuleState(ConfigRuleState 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
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 the DeleteConfigRule
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
the DeleteConfigRule
request.
ConfigRuleState
public ConfigRule withConfigRuleState(ConfigRuleState 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 the DeleteConfigRule
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 the
DeleteConfigRule
request.
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 the DeleteConfigRule
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
the DeleteConfigRule
request.
ConfigRuleState
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ConfigRule clone()
clone
in class java.lang.Object