Class CfnStage.MethodSettingProperty

The MethodSetting property type configures settings for all methods in a stage.

Inheritance
System.Object
CfnStage.MethodSettingProperty
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class MethodSettingProperty : Object, CfnStage.IMethodSettingProperty
Syntax (vb)
Public Class MethodSettingProperty
    Inherits Object
    Implements CfnStage.IMethodSettingProperty
Remarks

The MethodSettings property of the AWS::ApiGateway::Stage resource contains a list of MethodSetting property types.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;

var methodSettingProperty = new MethodSettingProperty {
    CacheDataEncrypted = false,
    CacheTtlInSeconds = 123,
    CachingEnabled = false,
    DataTraceEnabled = false,
    HttpMethod = "httpMethod",
    LoggingLevel = "loggingLevel",
    MetricsEnabled = false,
    ResourcePath = "resourcePath",
    ThrottlingBurstLimit = 123,
    ThrottlingRateLimit = 123
};

Synopsis

Constructors

MethodSettingProperty()

Properties

CacheDataEncrypted

Specifies whether the cached responses are encrypted.
CacheTtlInSeconds

Specifies the time to live (TTL), in seconds, for cached responses.
CachingEnabled

Specifies whether responses should be cached and returned for requests.
DataTraceEnabled

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
HttpMethod

The HTTP method.
LoggingLevel

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
MetricsEnabled

Specifies whether Amazon CloudWatch metrics are enabled for this method.
ResourcePath

The resource path for this method.
ThrottlingBurstLimit

Specifies the throttling burst limit.
ThrottlingRateLimit

Specifies the throttling rate limit.

Constructors

MethodSettingProperty()

public MethodSettingProperty()

Properties

CacheDataEncrypted

Specifies whether the cached responses are encrypted.

public object CacheDataEncrypted { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted

CacheTtlInSeconds

Specifies the time to live (TTL), in seconds, for cached responses.

public Nullable<double> CacheTtlInSeconds { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

The higher the TTL, the longer the response will be cached.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds

CachingEnabled

Specifies whether responses should be cached and returned for requests.

public object CachingEnabled { get; set; }
Property Value

System.Object

Remarks

A cache cluster must be enabled on the stage for responses to be cached.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled

DataTraceEnabled

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

public object DataTraceEnabled { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled

HttpMethod

The HTTP method.

public string HttpMethod { get; set; }
Property Value

System.String

Remarks

To apply settings to multiple resources and methods, specify an asterisk ( ) for the HttpMethod and / for the ResourcePath . This parameter is required when you specify a MethodSetting .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod

LoggingLevel

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

public string LoggingLevel { get; set; }
Property Value

System.String

Remarks

Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel

MetricsEnabled

Specifies whether Amazon CloudWatch metrics are enabled for this method.

public object MetricsEnabled { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled

ResourcePath

The resource path for this method.

public string ResourcePath { get; set; }
Property Value

System.String

Remarks

Forward slashes ( / ) are encoded as ~1 and 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 ( / ). To apply settings to multiple resources and methods, specify an asterisk ( ) for the HttpMethod and / for the ResourcePath . This parameter is required when you specify a MethodSetting .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath

ThrottlingBurstLimit

Specifies the throttling burst limit.

public Nullable<double> ThrottlingBurstLimit { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit

ThrottlingRateLimit

Specifies the throttling rate limit.

public Nullable<double> ThrottlingRateLimit { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit

Implements