public static interface AwsApiGatewayMethodSettings.Builder extends SdkPojo, CopyableBuilder<AwsApiGatewayMethodSettings.Builder,AwsApiGatewayMethodSettings>
Modifier and Type | Method and Description |
---|---|
AwsApiGatewayMethodSettings.Builder |
cacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
|
AwsApiGatewayMethodSettings.Builder |
cacheTtlInSeconds(Integer cacheTtlInSeconds)
Specifies the time to live (TTL), in seconds, for cached responses.
|
AwsApiGatewayMethodSettings.Builder |
cachingEnabled(Boolean cachingEnabled)
Indicates whether responses are cached and returned for requests.
|
AwsApiGatewayMethodSettings.Builder |
dataTraceEnabled(Boolean dataTraceEnabled)
Indicates whether data trace logging is enabled for the method.
|
AwsApiGatewayMethodSettings.Builder |
httpMethod(String httpMethod)
The HTTP method.
|
AwsApiGatewayMethodSettings.Builder |
loggingLevel(String loggingLevel)
The logging level for this method.
|
AwsApiGatewayMethodSettings.Builder |
metricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
|
AwsApiGatewayMethodSettings.Builder |
requireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
|
AwsApiGatewayMethodSettings.Builder |
resourcePath(String resourcePath)
The resource path for this method.
|
AwsApiGatewayMethodSettings.Builder |
throttlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
|
AwsApiGatewayMethodSettings.Builder |
throttlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
|
AwsApiGatewayMethodSettings.Builder |
unauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)
Indicates how to handle unauthorized requests for cache invalidation.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
AwsApiGatewayMethodSettings.Builder metricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
metricsEnabled
- Indicates whether CloudWatch metrics are enabled for the method.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
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
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.
dataTraceEnabled
- Indicates whether data trace logging is enabled for the method. Data trace logging affects the log
entries that are pushed to CloudWatch Logs.AwsApiGatewayMethodSettings.Builder throttlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
throttlingBurstLimit
- The throttling burst limit for the method.AwsApiGatewayMethodSettings.Builder throttlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
throttlingRateLimit
- The throttling rate limit for the method.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.
cachingEnabled
- Indicates whether responses are cached and returned for requests. For responses to be cached, a cache
cluster must be enabled on the stage.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.
cacheTtlInSeconds
- Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the
response is cached.AwsApiGatewayMethodSettings.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.AwsApiGatewayMethodSettings.Builder requireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
requireAuthorizationForCacheControl
- Indicates whether authorization is required for a cache invalidation request.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
unauthorizedCacheControlHeaderStrategy
- Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
AwsApiGatewayMethodSettings.Builder httpMethod(String httpMethod)
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
httpMethod
- The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple
methods.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.
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.
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.