networkfirewall/aws.sdk.kotlin.services.networkfirewall.model/RuleGroupResponse/Builder

Builder

Properties

var analysisResults: List<AnalysisResult>?

The list of analysis results for AnalyzeRuleGroup. If you set AnalyzeRuleGroup to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.

capacity

var capacity: Int?

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

consumedCapacity

var consumedCapacity: Int?

The number of capacity units currently consumed by the rule group rules.

description

var description: String?

A description of the rule group.

encryptionConfiguration

var encryptionConfiguration: EncryptionConfiguration?

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

lastModifiedTime

var lastModifiedTime: Instant?

The last time that the rule group was changed.

numberOfAssociations

var numberOfAssociations: Int?

The number of firewall policies that use this rule group.

ruleGroupArn

var ruleGroupArn: String?

The Amazon Resource Name (ARN) of the rule group.

ruleGroupId

var ruleGroupId: String?

The unique identifier for the rule group.

ruleGroupName

var ruleGroupName: String?

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

ruleGroupStatus

var ruleGroupStatus: ResourceStatus?

Detailed information about the current status of a rule group.

snsTopic

var snsTopic: String?

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..

sourceMetadata

var sourceMetadata: SourceMetadata?

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

summaryConfiguration

var summaryConfiguration: SummaryConfiguration?

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary.

Functions

encryptionConfiguration

fun encryptionConfiguration(block: EncryptionConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.networkfirewall.model.EncryptionConfiguration inside the given block

sourceMetadata

fun sourceMetadata(block: SourceMetadata.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.networkfirewall.model.SourceMetadata inside the given block

summaryConfiguration

fun summaryConfiguration(block: SummaryConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.networkfirewall.model.SummaryConfiguration inside the given block