Interface CfnStage.IMethodSettingProperty

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

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IMethodSettingProperty

Syntax (vb)

Public Interface 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

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.

Properties

CacheDataEncrypted

Specifies whether the cached responses are encrypted.

virtual object CacheDataEncrypted { get; }

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.

virtual Nullable<double> CacheTtlInSeconds { get; }

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.

virtual object CachingEnabled { get; }

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.

virtual object DataTraceEnabled { get; }

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.

virtual string HttpMethod { get; }

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.

virtual string LoggingLevel { get; }

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.

virtual object MetricsEnabled { get; }

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.

virtual string ResourcePath { get; }

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.

virtual Nullable<double> ThrottlingBurstLimit { get; }

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.

virtual Nullable<double> ThrottlingRateLimit { get; }

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