Interface AwsApiGatewayMethodSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsApiGatewayMethodSettings.Builder,
,AwsApiGatewayMethodSettings> SdkBuilder<AwsApiGatewayMethodSettings.Builder,
,AwsApiGatewayMethodSettings> SdkPojo
- Enclosing class:
AwsApiGatewayMethodSettings
-
Method Summary
Modifier and TypeMethodDescriptioncacheDataEncrypted
(Boolean cacheDataEncrypted) Indicates whether the cached responses are encrypted.cacheTtlInSeconds
(Integer cacheTtlInSeconds) Specifies the time to live (TTL), in seconds, for cached responses.cachingEnabled
(Boolean cachingEnabled) Indicates whether responses are cached and returned for requests.dataTraceEnabled
(Boolean dataTraceEnabled) Indicates whether data trace logging is enabled for the method.httpMethod
(String httpMethod) The HTTP method.loggingLevel
(String loggingLevel) The logging level for this method.metricsEnabled
(Boolean metricsEnabled) Indicates whether CloudWatch metrics are enabled for the method.requireAuthorizationForCacheControl
(Boolean requireAuthorizationForCacheControl) Indicates whether authorization is required for a cache invalidation request.resourcePath
(String resourcePath) The resource path for this method.throttlingBurstLimit
(Integer throttlingBurstLimit) The throttling burst limit for the method.throttlingRateLimit
(Double throttlingRateLimit) The throttling rate limit for the method.unauthorizedCacheControlHeaderStrategy
(String unauthorizedCacheControlHeaderStrategy) Indicates how to handle unauthorized requests for cache invalidation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 bothERROR
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 bothERROR
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
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
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
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
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
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
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
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
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.
-