Interface GetSampledRequestsRequest.Builder

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

  • Method Details

    • webAclArn

      GetSampledRequestsRequest.Builder webAclArn(String webAclArn)

      The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

      Parameters:
      webAclArn - The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleMetricName

      GetSampledRequestsRequest.Builder ruleMetricName(String ruleMetricName)

      The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.

      Parameters:
      ruleMetricName - The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      GetSampledRequestsRequest.Builder scope(String scope)

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Parameters:
      scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

    • scope

      GetSampledRequestsRequest.Builder scope(Scope scope)

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Parameters:
      scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

    • timeWindow

      GetSampledRequestsRequest.Builder timeWindow(TimeWindow timeWindow)

      The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

      Parameters:
      timeWindow - The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

      default GetSampledRequestsRequest.Builder timeWindow(Consumer<TimeWindow.Builder> timeWindow)

      The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

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

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

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

    • maxItems

      GetSampledRequestsRequest.Builder maxItems(Long maxItems)

      The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

      Parameters:
      maxItems - The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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