AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Specifies the method setting properties.

Inheritance Hierarchy

System.Object
  Amazon.APIGateway.Model.MethodSetting

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class MethodSetting

The MethodSetting type exposes the following members

Constructors

NameDescription
Public Method MethodSetting()

Properties

NameTypeDescription
Public Property CacheDataEncrypted System.Boolean

Gets and sets the property CacheDataEncrypted.

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

Public Property CacheTtlInSeconds System.Int32

Gets and sets the property CacheTtlInSeconds.

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

Public Property CachingEnabled System.Boolean

Gets and sets the property CachingEnabled.

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

Public Property DataTraceEnabled System.Boolean

Gets and sets the property DataTraceEnabled.

Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

Public Property LoggingLevel System.String

Gets and sets the property LoggingLevel.

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.

Public Property MetricsEnabled System.Boolean

Gets and sets the property MetricsEnabled.

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

Public Property RequireAuthorizationForCacheControl System.Boolean

Gets and sets the property RequireAuthorizationForCacheControl.

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

Public Property ThrottlingBurstLimit System.Int32

Gets and sets the property ThrottlingBurstLimit.

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Public Property ThrottlingRateLimit System.Double

Gets and sets the property ThrottlingRateLimit.

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Public Property UnauthorizedCacheControlHeaderStrategy Amazon.APIGateway.UnauthorizedCacheControlHeaderStrategy

Gets and sets the property UnauthorizedCacheControlHeaderStrategy.

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms