public class ConfigRule extends Object implements 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 and at a periodic frequency that you choose (for example, every 24 hours).
You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
Constructor and Description |
---|
ConfigRule() |
Modifier and Type | Method and Description |
---|---|
ConfigRule |
clone() |
boolean |
equals(Object obj) |
String |
getConfigRuleArn()
The Amazon Resource Name (ARN) of the AWS Config rule.
|
String |
getConfigRuleId()
The ID of the AWS Config rule.
|
String |
getConfigRuleName()
The name that you assign to the AWS Config rule.
|
String |
getConfigRuleState()
Indicates whether the AWS Config rule is active or is currently being
deleted by AWS Config.
|
String |
getDescription()
The description that you provide for the AWS Config rule.
|
String |
getInputParameters()
A string in JSON format that is passed to the AWS Config rule Lambda
function.
|
String |
getMaximumExecutionFrequency()
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency parameter in the
SourceDetail object. |
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
notifications 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 is currently being
deleted by AWS Config.
|
void |
setConfigRuleState(String configRuleState)
Indicates whether the AWS Config rule is active or is 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)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency parameter in the
SourceDetail object. |
void |
setMaximumExecutionFrequency(String maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency parameter in the
SourceDetail object. |
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
notifications that cause the function to evaluate your AWS resources.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfigRule |
withConfigRuleArn(String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
|
ConfigRule |
withConfigRuleId(String configRuleId)
The ID of the AWS Config rule.
|
ConfigRule |
withConfigRuleName(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 is currently being
deleted by AWS Config.
|
ConfigRule |
withConfigRuleState(String configRuleState)
Indicates whether the AWS Config rule is active or is currently being
deleted by AWS Config.
|
ConfigRule |
withDescription(String description)
The description that you provide for the AWS Config rule.
|
ConfigRule |
withInputParameters(String inputParameters)
A string in JSON format that is passed to the AWS Config rule Lambda
function.
|
ConfigRule |
withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency parameter in the
SourceDetail object. |
ConfigRule |
withMaximumExecutionFrequency(String maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency parameter in the
SourceDetail object. |
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
notifications that cause the function to evaluate your AWS resources.
|
public void setConfigRuleName(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 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(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(String configRuleArn)
The Amazon Resource Name (ARN) of the AWS Config rule.
configRuleArn
- The Amazon Resource Name (ARN) of the AWS Config rule.public String getConfigRuleArn()
The Amazon Resource Name (ARN) of the AWS Config rule.
public ConfigRule withConfigRuleArn(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(String configRuleId)
The ID of the AWS Config rule.
configRuleId
- The ID of the AWS Config rule.public String getConfigRuleId()
The ID of the AWS Config rule.
public ConfigRule withConfigRuleId(String configRuleId)
The ID of the AWS Config rule.
configRuleId
- The ID of the AWS Config rule.public void setDescription(String description)
The description that you provide for the AWS Config rule.
description
- The description that you provide for the AWS Config rule.public String getDescription()
The description that you provide for the AWS Config rule.
public ConfigRule withDescription(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 notifications that cause the function to evaluate your AWS resources.
source
- Provides the rule owner (AWS or customer), the rule identifier,
and the notifications that cause the function to evaluate your AWS
resources.public Source getSource()
Provides the rule owner (AWS or customer), the rule identifier, and the notifications 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 notifications that cause the function to evaluate your AWS resources.
source
- Provides the rule owner (AWS or customer), the rule identifier,
and the notifications that cause the function to evaluate your AWS
resources.public void setInputParameters(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 String getInputParameters()
A string in JSON format that is passed to the AWS Config rule Lambda function.
public ConfigRule withInputParameters(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(String maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object.
If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a configuration
snapshot cannot run evaluations more frequently than AWS Config delivers
the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater than the
value of the deliveryFrequency
key, which is part of
ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a
configuration snapshot cannot run evaluations more frequently than
AWS Config delivers the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater
than the value of the deliveryFrequency
key, which is
part of ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public String getMaximumExecutionFrequency()
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object.
If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a configuration
snapshot cannot run evaluations more frequently than AWS Config delivers
the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater than the
value of the deliveryFrequency
key, which is part of
ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
parameter in the
SourceDetail object. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a
configuration snapshot cannot run evaluations more frequently
than AWS Config delivers the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater
than the value of the deliveryFrequency
key, which
is part of ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(String maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object.
If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a configuration
snapshot cannot run evaluations more frequently than AWS Config delivers
the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater than the
value of the deliveryFrequency
key, which is part of
ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a
configuration snapshot cannot run evaluations more frequently than
AWS Config delivers the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater
than the value of the deliveryFrequency
key, which is
part of ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object.
If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a configuration
snapshot cannot run evaluations more frequently than AWS Config delivers
the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater than the
value of the deliveryFrequency
key, which is part of
ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a
configuration snapshot cannot run evaluations more frequently than
AWS Config delivers the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater
than the value of the deliveryFrequency
key, which is
part of ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object.
If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a configuration
snapshot cannot run evaluations more frequently than AWS Config delivers
the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater than the
value of the deliveryFrequency
key, which is part of
ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
maximumExecutionFrequency
- If you want to create a rule that evaluates at a frequency that is
independent of the configuration snapshot delivery, use the
MaximumExecutionFrequency
parameter in the
SourceDetail object. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
A rule that runs an evaluation when AWS Config delivers a
configuration snapshot cannot run evaluations more frequently than
AWS Config delivers the snapshots. Set the value of the
MaximumExecutionFrequency
to be equal to or greater
than the value of the deliveryFrequency
key, which is
part of ConfigSnapshotDeliveryProperties
.
For more information, see ConfigSnapshotDeliveryProperties.
MaximumExecutionFrequency
public void setConfigRuleState(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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily
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.
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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily 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.
ConfigRuleState
public String getConfigRuleState()
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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily
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.
AWS Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your
resources against the 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily 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.
ConfigRuleState
public ConfigRule withConfigRuleState(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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily
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.
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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily 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.
ConfigRuleState
public void setConfigRuleState(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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily
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.
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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily 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.
ConfigRuleState
public ConfigRule withConfigRuleState(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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily
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.
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 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 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 Config rule.
AWS Config sets the state of a rule to DELETING
temporarily 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.
ConfigRuleState
public String toString()
toString
in class Object
Object.toString()
public ConfigRule clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.