ConfigRule class

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). For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

Constructors

ConfigRule({required Source source, String? configRuleArn, String? configRuleId, String? configRuleName, ConfigRuleState? configRuleState, String? createdBy, String? description, String? inputParameters, MaximumExecutionFrequency? maximumExecutionFrequency, Scope? scope})

ConfigRule.fromJson(Map<String, dynamic> json)

factory

Properties

configRuleArn → String?

The Amazon Resource Name (ARN) of the AWS Config rule.

final

configRuleId → String?

The ID of the AWS Config rule.

final

configRuleName → String?

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

final

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 AWS Config rule.

final

createdBy → String?

Service principal name of the service that created the rule.

final

description → String?

The description that you provide for the AWS Config rule.

final

hashCode → int

The hash code for this object.

no setter, inherited

inputParameters → String?

A string, in JSON format, that is passed to the AWS Config rule Lambda function.

final

maximumExecutionFrequency → MaximumExecutionFrequency?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

final

source → Source

Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited