@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ConfigRule extends Object implements Serializable, Cloneable, StructuredPojo
An Config rule represents an Lambda function that you create for a custom rule or a predefined function for an Config managed rule. The function evaluates configuration items to assess whether your Amazon Web Services resources comply with your desired configurations. This function can run when Config detects a configuration change to an Amazon Web Services resource and at a periodic frequency that you choose (for example, every 24 hours).
You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the 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 Config rule.
|
String |
getConfigRuleId()
The ID of the Config rule.
|
String |
getConfigRuleName()
The name that you assign to the Config rule.
|
String |
getConfigRuleState()
Indicates whether the Config rule is active or is currently being deleted by Config.
|
String |
getCreatedBy()
Service principal name of the service that created the rule.
|
String |
getDescription()
The description that you provide for the Config rule.
|
String |
getInputParameters()
A string, in JSON format, that is passed to the Config rule Lambda function.
|
String |
getMaximumExecutionFrequency()
The maximum frequency with which Config runs evaluations for a rule.
|
Scope |
getScope()
Defines which resources can trigger an evaluation for the rule.
|
Source |
getSource()
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause
the function to evaluate your Amazon Web Services 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 Config rule.
|
void |
setConfigRuleId(String configRuleId)
The ID of the Config rule.
|
void |
setConfigRuleName(String configRuleName)
The name that you assign to the Config rule.
|
void |
setConfigRuleState(ConfigRuleState configRuleState)
Indicates whether the Config rule is active or is currently being deleted by Config.
|
void |
setConfigRuleState(String configRuleState)
Indicates whether the Config rule is active or is currently being deleted by Config.
|
void |
setCreatedBy(String createdBy)
Service principal name of the service that created the rule.
|
void |
setDescription(String description)
The description that you provide for the Config rule.
|
void |
setInputParameters(String inputParameters)
A string, in JSON format, that is passed to the Config rule Lambda function.
|
void |
setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule.
|
void |
setMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which 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 (Amazon Web Services or customer), the rule identifier, and the notifications that cause
the function to evaluate your Amazon Web Services resources.
|
String |
toString()
Returns a string representation of this object.
|
ConfigRule |
withConfigRuleArn(String configRuleArn)
The Amazon Resource Name (ARN) of the Config rule.
|
ConfigRule |
withConfigRuleId(String configRuleId)
The ID of the Config rule.
|
ConfigRule |
withConfigRuleName(String configRuleName)
The name that you assign to the Config rule.
|
ConfigRule |
withConfigRuleState(ConfigRuleState configRuleState)
Indicates whether the Config rule is active or is currently being deleted by Config.
|
ConfigRule |
withConfigRuleState(String configRuleState)
Indicates whether the Config rule is active or is currently being deleted by Config.
|
ConfigRule |
withCreatedBy(String createdBy)
Service principal name of the service that created the rule.
|
ConfigRule |
withDescription(String description)
The description that you provide for the Config rule.
|
ConfigRule |
withInputParameters(String inputParameters)
A string, in JSON format, that is passed to the Config rule Lambda function.
|
ConfigRule |
withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule.
|
ConfigRule |
withMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which 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 (Amazon Web Services or customer), the rule identifier, and the notifications that cause
the function to evaluate your Amazon Web Services resources.
|
public void setConfigRuleName(String configRuleName)
The name that you assign to the Config rule. The name is required if you are adding a new rule.
configRuleName
- The name that you assign to the Config rule. The name is required if you are adding a new rule.public String getConfigRuleName()
The name that you assign to the 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 Config rule. The name is required if you are adding a new rule.
configRuleName
- The name that you assign to the 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 Config rule.
configRuleArn
- The Amazon Resource Name (ARN) of the Config rule.public String getConfigRuleArn()
The Amazon Resource Name (ARN) of the Config rule.
public ConfigRule withConfigRuleArn(String configRuleArn)
The Amazon Resource Name (ARN) of the Config rule.
configRuleArn
- The Amazon Resource Name (ARN) of the Config rule.public void setConfigRuleId(String configRuleId)
The ID of the Config rule.
configRuleId
- The ID of the Config rule.public String getConfigRuleId()
The ID of the Config rule.
public ConfigRule withConfigRuleId(String configRuleId)
The ID of the Config rule.
configRuleId
- The ID of the Config rule.public void setDescription(String description)
The description that you provide for the Config rule.
description
- The description that you provide for the Config rule.public String getDescription()
The description that you provide for the Config rule.
public ConfigRule withDescription(String description)
The description that you provide for the Config rule.
description
- The description that you provide for the 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.
The scope can be empty.
scope
- Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource
types, a combination of one resource type and one resource ID, or a combination of a tag key and value.
Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not
specify a scope, evaluations are triggered when any resource in the recording group changes. The scope can be empty.
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.
The scope can be empty.
The scope can be empty.
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.
The scope can be empty.
scope
- Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource
types, a combination of one resource type and one resource ID, or a combination of a tag key and value.
Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not
specify a scope, evaluations are triggered when any resource in the recording group changes. The scope can be empty.
public void setSource(Source source)
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
source
- Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that
cause the function to evaluate your Amazon Web Services resources.public Source getSource()
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
public ConfigRule withSource(Source source)
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
source
- Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that
cause the function to evaluate your Amazon Web Services resources.public void setInputParameters(String inputParameters)
A string, in JSON format, that is passed to the Config rule Lambda function.
inputParameters
- A string, in JSON format, that is passed to the Config rule Lambda function.public String getInputParameters()
A string, in JSON format, that is passed to the Config rule Lambda function.
public ConfigRule withInputParameters(String inputParameters)
A string, in JSON format, that is passed to the Config rule Lambda function.
inputParameters
- A string, in JSON format, that is passed to the Config rule Lambda function.public void setMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
value for the MaximumExecutionFrequency
parameter.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
valid value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
public String getMaximumExecutionFrequency()
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify
a valid value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(String maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
value for the MaximumExecutionFrequency
parameter.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
valid value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
value for the MaximumExecutionFrequency
parameter.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
valid value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
value for the MaximumExecutionFrequency
parameter.
maximumExecutionFrequency
- The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:
You are using an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a
valid value for the MaximumExecutionFrequency
parameter.
MaximumExecutionFrequency
public void setConfigRuleState(String configRuleState)
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its
evaluations are erased and are no longer available.
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate
the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After 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 Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its
evaluations are erased and are no longer available.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After 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 Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its
evaluations are erased and are no longer available.
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate
the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After 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 Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its
evaluations are erased and are no longer available.
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate
the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After 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 Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its
evaluations are erased and are no longer available.
configRuleState
- Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate
the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the
StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
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.
Config temporarily sets the state of a rule to DELETING
after you use the
DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all
of its evaluations are erased and are no longer available.
ConfigRuleState
public void setCreatedBy(String createdBy)
Service principal name of the service that created the rule.
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
createdBy
- Service principal name of the service that created the rule. The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
public String getCreatedBy()
Service principal name of the service that created the rule.
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
public ConfigRule withCreatedBy(String createdBy)
Service principal name of the service that created the rule.
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
createdBy
- Service principal name of the service that created the rule. The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
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.