software.amazon.awssdk.services.networkfirewall.model

Interface DescribeRuleGroupMetadataResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>, NetworkFirewallResponse.Builder, SdkBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeRuleGroupMetadataResponse

public static interface DescribeRuleGroupMetadataResponse.Builder
extends NetworkFirewallResponse.Builder, SdkPojo, CopyableBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>

Method Summary

Modifier and Type	Method and Description
DescribeRuleGroupMetadataResponse.Builder	capacity(Integer capacity) The maximum operating resources that this rule group can use.
DescribeRuleGroupMetadataResponse.Builder	description(String description) Returns the metadata objects for the specified rule group.
DescribeRuleGroupMetadataResponse.Builder	lastModifiedTime(Instant lastModifiedTime) The last time that the rule group was changed.
DescribeRuleGroupMetadataResponse.Builder	ruleGroupArn(String ruleGroupArn) The descriptive name of the rule group.
DescribeRuleGroupMetadataResponse.Builder	ruleGroupName(String ruleGroupName) The descriptive name of the rule group.
default DescribeRuleGroupMetadataResponse.Builder	statefulRuleOptions(Consumer<StatefulRuleOptions.Builder> statefulRuleOptions) Sets the value of the StatefulRuleOptions property for this object.
DescribeRuleGroupMetadataResponse.Builder	statefulRuleOptions(StatefulRuleOptions statefulRuleOptions) Sets the value of the StatefulRuleOptions property for this object.
DescribeRuleGroupMetadataResponse.Builder	type(RuleGroupType type) Indicates whether the rule group is stateless or stateful.
DescribeRuleGroupMetadataResponse.Builder	type(String type) Indicates whether the rule group is stateless or stateful.

Methods inherited from interface software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

ruleGroupArn

DescribeRuleGroupMetadataResponse.Builder ruleGroupArn(String ruleGroupArn)

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

You must specify the ARN or the name, and you can specify both.

Parameters:

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

You must specify the ARN or the name, and you can specify both.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleGroupName

DescribeRuleGroupMetadataResponse.Builder ruleGroupName(String ruleGroupName)

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

You must specify the ARN or the name, and you can specify both.

Parameters:

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

You must specify the ARN or the name, and you can specify both.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

DescribeRuleGroupMetadataResponse.Builder description(String description)

Returns the metadata objects for the specified rule group.

Parameters:

description - Returns the metadata objects for the specified rule group.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

DescribeRuleGroupMetadataResponse.Builder type(String type)

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

Parameters:

type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleGroupType, RuleGroupType

type

DescribeRuleGroupMetadataResponse.Builder type(RuleGroupType type)

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

Parameters:

type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleGroupType, RuleGroupType

capacity

DescribeRuleGroupMetadataResponse.Builder capacity(Integer capacity)

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.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Parameters:

capacity - 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.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Returns:

Returns a reference to this object so that method calls can be chained together.

statefulRuleOptions

DescribeRuleGroupMetadataResponse.Builder statefulRuleOptions(StatefulRuleOptions statefulRuleOptions)

Sets the value of the StatefulRuleOptions property for this object.

Parameters:

statefulRuleOptions - The new value for the StatefulRuleOptions property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

statefulRuleOptions

default DescribeRuleGroupMetadataResponse.Builder statefulRuleOptions(Consumer<StatefulRuleOptions.Builder> statefulRuleOptions)

Sets the value of the StatefulRuleOptions property for this object. This is a convenience method that creates an instance of the StatefulRuleOptions.Builder avoiding the need to create one manually via StatefulRuleOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statefulRuleOptions(StatefulRuleOptions).

Parameters:

statefulRuleOptions - a consumer that will call methods on StatefulRuleOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

statefulRuleOptions(StatefulRuleOptions)

lastModifiedTime

DescribeRuleGroupMetadataResponse.Builder lastModifiedTime(Instant lastModifiedTime)

The last time that the rule group was changed.

Parameters:

lastModifiedTime - The last time that the rule group was changed.

Returns:

Returns a reference to this object so that method calls can be chained together.