View a markdown version of this page

RuleSummary - AWS Network Security Manager

RuleSummary

Summary information about a rule.

Contents

ruleArn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1010.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

Required: Yes

ruleId

The service-generated id of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z0-9]{1,64}

Required: Yes

ruleName

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][a-zA-Z0-9 _.:/=+\-@]*

Required: Yes

firewallType

The firewall type associated with the resource.

Type: String

Valid Values: WAF

Required: No

hasPublishedVersion

Specifies whether a published version of the resource exists.

Type: Boolean

Required: No

ruleType

The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

Type: String

Valid Values: CONFIGURATION | INSPECTION

Required: No

status

The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

Type: String

Valid Values: DRAFT | ACTIVE | DISABLED

Required: No

updatedAt

The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.

Type: Timestamp

Required: No

version

The version of the resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: [1-9][0-9]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: