GetConfigRuleResult

data class GetConfigRuleResult(val arn: String? = null, val compliance: ComplianceProperties? = null, val configRuleId: String? = null, val description: String? = null, val evaluationModes: List<ConfigRuleEvaluationModeConfiguration>? = null, val inputParameters: Any? = null, val maximumExecutionFrequency: String? = null, val scope: ConfigRuleScope? = null, val source: ConfigRuleSource? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, compliance: ComplianceProperties? = null, configRuleId: String? = null, description: String? = null, evaluationModes: List<ConfigRuleEvaluationModeConfiguration>? = null, inputParameters: Any? = null, maximumExecutionFrequency: String? = null, scope: ConfigRuleScope? = null, source: ConfigRuleSource? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the AWS Config rule, such as arn:aws:config:us-east-1:123456789012:config-rule/config-rule-a1bzhi .

Link copied to clipboard

Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.

Link copied to clipboard
val configRuleId: String? = null

The ID of the AWS Config rule, such as config-rule-a1bzhi .

Link copied to clipboard
val description: String? = null

The description that you provide for the CC rule.

Link copied to clipboard

The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

Link copied to clipboard
val inputParameters: Any? = null

A string, in JSON format, that is passed to the CC rule Lambda function. Search the CloudFormation User Guide for AWS::Config::ConfigRule for more information about the expected schema for this property.

Link copied to clipboard

The maximum frequency with which CC runs evaluations for a rule. You can specify a value for `MaximumExecutionFrequency` when:

Link copied to clipboard
val scope: ConfigRuleScope? = null

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.

Link copied to clipboard

Provides the rule owner (```` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.