Interface AwsApiGatewayMethodSettings.Builder

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

  • Method Details

    • metricsEnabled

      AwsApiGatewayMethodSettings.Builder metricsEnabled(Boolean metricsEnabled)

      Indicates whether CloudWatch metrics are enabled for the method.

      Parameters:
      metricsEnabled - Indicates whether CloudWatch metrics are enabled for the method.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingLevel

      AwsApiGatewayMethodSettings.Builder loggingLevel(String loggingLevel)

      The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

      If the logging level is ERROR, then the logs only include error-level entries.

      If the logging level is INFO, then the logs include both ERROR events and extra informational events.

      Valid values: OFF | ERROR | INFO

      Parameters:
      loggingLevel - The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

      If the logging level is ERROR, then the logs only include error-level entries.

      If the logging level is INFO, then the logs include both ERROR events and extra informational events.

      Valid values: OFF | ERROR | INFO

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

    • dataTraceEnabled

      AwsApiGatewayMethodSettings.Builder dataTraceEnabled(Boolean dataTraceEnabled)

      Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

      Parameters:
      dataTraceEnabled - Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throttlingBurstLimit

      AwsApiGatewayMethodSettings.Builder throttlingBurstLimit(Integer throttlingBurstLimit)

      The throttling burst limit for the method.

      Parameters:
      throttlingBurstLimit - The throttling burst limit for the method.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throttlingRateLimit

      AwsApiGatewayMethodSettings.Builder throttlingRateLimit(Double throttlingRateLimit)

      The throttling rate limit for the method.

      Parameters:
      throttlingRateLimit - The throttling rate limit for the method.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cachingEnabled

      AwsApiGatewayMethodSettings.Builder cachingEnabled(Boolean cachingEnabled)

      Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

      Parameters:
      cachingEnabled - Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheTtlInSeconds

      AwsApiGatewayMethodSettings.Builder cacheTtlInSeconds(Integer cacheTtlInSeconds)

      Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

      Parameters:
      cacheTtlInSeconds - Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheDataEncrypted

      AwsApiGatewayMethodSettings.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)

      Indicates whether the cached responses are encrypted.

      Parameters:
      cacheDataEncrypted - Indicates whether the cached responses are encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requireAuthorizationForCacheControl

      AwsApiGatewayMethodSettings.Builder requireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)

      Indicates whether authorization is required for a cache invalidation request.

      Parameters:
      requireAuthorizationForCacheControl - Indicates whether authorization is required for a cache invalidation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unauthorizedCacheControlHeaderStrategy

      AwsApiGatewayMethodSettings.Builder unauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)

      Indicates how to handle unauthorized requests for cache invalidation.

      Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

      Parameters:
      unauthorizedCacheControlHeaderStrategy - Indicates how to handle unauthorized requests for cache invalidation.

      Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

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

    • httpMethod

      AwsApiGatewayMethodSettings.Builder httpMethod(String httpMethod)

      The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

      Parameters:
      httpMethod - The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourcePath

      AwsApiGatewayMethodSettings.Builder resourcePath(String resourcePath)

      The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

      For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

      To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

      Parameters:
      resourcePath - The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

      For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

      To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

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