Package software.amazon.awssdk.services.shield.model

Interface CreateProtectionGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>, SdkBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>, SdkPojo, SdkRequest.Builder, ShieldRequest.Builder
Enclosing class:
CreateProtectionGroupRequest
public static interface CreateProtectionGroupRequest.Builder extends ShieldRequest.Builder, SdkPojo, CopyableBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>

  • Method Details

    • protectionGroupId

      CreateProtectionGroupRequest.Builder protectionGroupId(String protectionGroupId)

      The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

      Parameters:
      protectionGroupId - The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aggregation

      CreateProtectionGroupRequest.Builder aggregation(String aggregation)

      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

      Parameters:
      aggregation - Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

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

    • aggregation

      CreateProtectionGroupRequest.Builder aggregation(ProtectionGroupAggregation aggregation)

      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

      Parameters:
      aggregation - Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

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

    • pattern

      CreateProtectionGroupRequest.Builder pattern(String pattern)

      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

      Parameters:
      pattern - The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pattern

      CreateProtectionGroupRequest.Builder pattern(ProtectionGroupPattern pattern)

      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

      Parameters:
      pattern - The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      CreateProtectionGroupRequest.Builder resourceType(String resourceType)

      The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

      Parameters:
      resourceType - The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      CreateProtectionGroupRequest.Builder resourceType(ProtectedResourceType resourceType)

      The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

      Parameters:
      resourceType - The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • members

      CreateProtectionGroupRequest.Builder members(Collection<String> members)

      The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

      Parameters:
      members - The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • members

      CreateProtectionGroupRequest.Builder members(String... members)

      The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

      Parameters:
      members - The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateProtectionGroupRequest.Builder tags(Collection<Tag> tags)

      One or more tag key-value pairs for the protection group.

      Parameters:
      tags - One or more tag key-value pairs for the protection group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateProtectionGroupRequest.Builder tags(Tag... tags)

      One or more tag key-value pairs for the protection group.

      Parameters:
      tags - One or more tag key-value pairs for the protection group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      One or more tag key-value pairs for the protection group.

      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:

    • overrideConfiguration

      CreateProtectionGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateProtectionGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.