Class CfnStage.MethodSettingProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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

public class CfnStage.MethodSettingProperty : CfnStage.IMethodSettingProperty

Inheritance

object

CfnStage.MethodSettingProperty

Implements

CfnStage.IMethodSettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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
             };

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

Constructors

MethodSettingProperty()

public MethodSettingProperty()

Properties

CacheDataEncrypted

Specifies whether the cached responses are encrypted.

public object? CacheDataEncrypted { get; set; }

Property Value

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 double? CacheTtlInSeconds { get; set; }

Property Value

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

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

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

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

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

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

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 double? ThrottlingBurstLimit { get; set; }

Property Value

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 double? ThrottlingRateLimit { get; set; }

Property Value

double?

Remarks

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