software.amazon.awssdk.services.networkfirewall.model

Interface RuleGroupResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RuleGroupResponse.Builder,RuleGroupResponse>, SdkBuilder<RuleGroupResponse.Builder,RuleGroupResponse>, SdkPojo

Enclosing class:

RuleGroupResponse

public static interface RuleGroupResponse.Builder
extends SdkPojo, CopyableBuilder<RuleGroupResponse.Builder,RuleGroupResponse>

Method Summary

Modifier and Type	Method and Description
RuleGroupResponse.Builder	capacity(Integer capacity) The maximum operating resources that this rule group can use.
RuleGroupResponse.Builder	consumedCapacity(Integer consumedCapacity) The number of capacity units currently consumed by the rule group rules.
RuleGroupResponse.Builder	description(String description) A description of the rule group.
default RuleGroupResponse.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
RuleGroupResponse.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration) A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
RuleGroupResponse.Builder	lastModifiedTime(Instant lastModifiedTime) The last time that the rule group was changed.
RuleGroupResponse.Builder	numberOfAssociations(Integer numberOfAssociations) The number of firewall policies that use this rule group.
RuleGroupResponse.Builder	ruleGroupArn(String ruleGroupArn) The Amazon Resource Name (ARN) of the rule group.
RuleGroupResponse.Builder	ruleGroupId(String ruleGroupId) The unique identifier for the rule group.
RuleGroupResponse.Builder	ruleGroupName(String ruleGroupName) The descriptive name of the rule group.
RuleGroupResponse.Builder	ruleGroupStatus(ResourceStatus ruleGroupStatus) Detailed information about the current status of a rule group.
RuleGroupResponse.Builder	ruleGroupStatus(String ruleGroupStatus) Detailed information about the current status of a rule group.
RuleGroupResponse.Builder	snsTopic(String snsTopic) The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group.
default RuleGroupResponse.Builder	sourceMetadata(Consumer<SourceMetadata.Builder> sourceMetadata) A complex type that contains metadata about the rule group that your own rule group is copied from.
RuleGroupResponse.Builder	sourceMetadata(SourceMetadata sourceMetadata) A complex type that contains metadata about the rule group that your own rule group is copied from.
RuleGroupResponse.Builder	tags(Collection<Tag> tags) The key:value pairs to associate with the resource.
RuleGroupResponse.Builder	tags(Consumer<Tag.Builder>... tags) The key:value pairs to associate with the resource.
RuleGroupResponse.Builder	tags(Tag... tags) The key:value pairs to associate with the resource.
RuleGroupResponse.Builder	type(RuleGroupType type) Indicates whether the rule group is stateless or stateful.
RuleGroupResponse.Builder	type(String type) Indicates whether the rule group is stateless or stateful.

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

RuleGroupResponse.Builder ruleGroupArn(String ruleGroupArn)

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

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Parameters:

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

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Returns:

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

ruleGroupName

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

Parameters:

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

Returns:

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

ruleGroupId

RuleGroupResponse.Builder ruleGroupId(String ruleGroupId)

The unique identifier for the rule group.

Parameters:

ruleGroupId - The unique identifier for the rule group.

Returns:

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

description

RuleGroupResponse.Builder description(String description)

A description of the rule group.

Parameters:

description - A description of the rule group.

Returns:

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

type

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

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.

Returns:

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

See Also:

RuleGroupType, RuleGroupType

type

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

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.

Returns:

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

See Also:

RuleGroupType, RuleGroupType

capacity

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

ruleGroupStatus

RuleGroupResponse.Builder ruleGroupStatus(String ruleGroupStatus)

Detailed information about the current status of a rule group.

Parameters:

ruleGroupStatus - Detailed information about the current status of a rule group.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

ruleGroupStatus

RuleGroupResponse.Builder ruleGroupStatus(ResourceStatus ruleGroupStatus)

Detailed information about the current status of a rule group.

Parameters:

ruleGroupStatus - Detailed information about the current status of a rule group.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

tags

RuleGroupResponse.Builder tags(Collection<Tag> tags)

The key:value pairs to associate with the resource.

Parameters:

tags - The key:value pairs to associate with the resource.

Returns:

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

tags

RuleGroupResponse.Builder tags(Tag... tags)

The key:value pairs to associate with the resource.

Parameters:

tags - The key:value pairs to associate with the resource.

Returns:

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

tags

RuleGroupResponse.Builder tags(Consumer<Tag.Builder>... tags)

The key:value pairs to associate with the resource.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

consumedCapacity

RuleGroupResponse.Builder consumedCapacity(Integer consumedCapacity)

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

Parameters:

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

Returns:

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

numberOfAssociations

RuleGroupResponse.Builder numberOfAssociations(Integer numberOfAssociations)

The number of firewall policies that use this rule group.

Parameters:

numberOfAssociations - The number of firewall policies that use this rule group.

Returns:

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

encryptionConfiguration

RuleGroupResponse.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

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

Parameters:

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

Returns:

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

encryptionConfiguration

default RuleGroupResponse.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

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

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

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

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

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

See Also:

encryptionConfiguration(EncryptionConfiguration)

sourceMetadata

RuleGroupResponse.Builder sourceMetadata(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.

Parameters:

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.

Returns:

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

sourceMetadata

default RuleGroupResponse.Builder sourceMetadata(Consumer<SourceMetadata.Builder> 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.

This is a convenience method that creates an instance of the SourceMetadata.Builder avoiding the need to create one manually via SourceMetadata.builder().

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

Parameters:

sourceMetadata - a consumer that will call methods on SourceMetadata.Builder

Returns:

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

See Also:

sourceMetadata(SourceMetadata)

snsTopic

RuleGroupResponse.Builder snsTopic(String snsTopic)

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

Parameters:

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

Returns:

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

lastModifiedTime

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