Interface RuleGroupResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RuleGroupResponse.Builder,RuleGroupResponse>, SdkBuilder<RuleGroupResponse.Builder,RuleGroupResponse>, SdkPojo
Enclosing class:
RuleGroupResponse
@Mutable @NotThreadSafe public static interface RuleGroupResponse.Builder extends SdkPojo, CopyableBuilder<RuleGroupResponse.Builder,RuleGroupResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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<Tag>).

      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:

    • 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:

    • 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:

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

    • analysisResults

      RuleGroupResponse.Builder analysisResults(Collection<AnalysisResult> analysisResults)

      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.

      Parameters:
      analysisResults - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisResults

      RuleGroupResponse.Builder analysisResults(AnalysisResult... analysisResults)

      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.

      Parameters:
      analysisResults - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisResults

      RuleGroupResponse.Builder analysisResults(Consumer<AnalysisResult.Builder>... analysisResults)

      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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analysisResults(List<AnalysisResult>).

      Parameters:
      analysisResults - a consumer that will call methods on AnalysisResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • summaryConfiguration

      RuleGroupResponse.Builder summaryConfiguration(SummaryConfiguration summaryConfiguration)

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

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

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

    • summaryConfiguration

      default RuleGroupResponse.Builder summaryConfiguration(Consumer<SummaryConfiguration.Builder> summaryConfiguration)

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

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

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

      Parameters:
      summaryConfiguration - a consumer that will call methods on SummaryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: