@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ConfigRule extends Object implements Serializable, Cloneable, StructuredPojo
An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function 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()
The maximum frequency with which AWS Config runs evaluations for a rule.
|
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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)
The maximum frequency with which AWS Config runs evaluations for a rule.
|
void |
setMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which AWS Config runs evaluations for a rule.
|
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)
The maximum frequency with which AWS Config runs evaluations for a rule.
|
ConfigRule |
withMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which AWS Config runs evaluations for a rule.
|
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)
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.
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.
MaximumExecutionFrequency
public String getMaximumExecutionFrequency()
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.
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.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(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.
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.
MaximumExecutionFrequency
public void setMaximumExecutionFrequency(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.
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.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(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.
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.
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()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.