Package software.amazon.awscdk.services.apigateway

Interface CfnStage.MethodSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.MethodSettingProperty.Jsii$Proxy

Enclosing class:

CfnStage

@Stability(Stable)
public static interface CfnStage.MethodSettingProperty
extends software.amazon.jsii.JsiiSerializable

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

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 MethodSettingProperty methodSettingProperty = MethodSettingProperty.builder()
         .cacheDataEncrypted(false)
         .cacheTtlInSeconds(123)
         .cachingEnabled(false)
         .dataTraceEnabled(false)
         .httpMethod("httpMethod")
         .loggingLevel("loggingLevel")
         .metricsEnabled(false)
         .resourcePath("resourcePath")
         .throttlingBurstLimit(123)
         .throttlingRateLimit(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStage.MethodSettingProperty.Builder	A builder for CfnStage.MethodSettingProperty
static final class	CfnStage.MethodSettingProperty.Jsii$Proxy	An implementation for CfnStage.MethodSettingProperty

Method Summary

Modifier and Type	Method	Description
static CfnStage.MethodSettingProperty.Builder	builder()
default Object	getCacheDataEncrypted()	Specifies whether the cached responses are encrypted.
default Number	getCacheTtlInSeconds()	Specifies the time to live (TTL), in seconds, for cached responses.
default Object	getCachingEnabled()	Specifies whether responses should be cached and returned for requests.
default Object	getDataTraceEnabled()	Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
default String	getHttpMethod()	The HTTP method.
default String	getLoggingLevel()	Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
default Object	getMetricsEnabled()	Specifies whether Amazon CloudWatch metrics are enabled for this method.
default String	getResourcePath()	The resource path for this method.
default Number	getThrottlingBurstLimit()	Specifies the throttling burst limit.
default Number	getThrottlingRateLimit()	Specifies the throttling rate limit.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCacheDataEncrypted

@Stability(Stable)
@Nullable
default Object getCacheDataEncrypted()

Specifies whether the cached responses are encrypted.

See Also:

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

getCacheTtlInSeconds

@Stability(Stable)
@Nullable
default Number getCacheTtlInSeconds()

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

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

See Also:

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

getCachingEnabled

@Stability(Stable)
@Nullable
default Object getCachingEnabled()

Specifies whether responses should be cached and returned for requests.

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

See Also:

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

getDataTraceEnabled

@Stability(Stable)
@Nullable
default Object getDataTraceEnabled()

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

This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

See Also:

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

getHttpMethod

@Stability(Stable)
@Nullable
default String getHttpMethod()

The HTTP method.

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 .

See Also:

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

getLoggingLevel

@Stability(Stable)
@Nullable
default String getLoggingLevel()

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

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.

See Also:

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

getMetricsEnabled

@Stability(Stable)
@Nullable
default Object getMetricsEnabled()

Specifies whether Amazon CloudWatch metrics are enabled for this method.

See Also:

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

getResourcePath

@Stability(Stable)
@Nullable
default String getResourcePath()

The resource path for this method.

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 .

See Also:

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

getThrottlingBurstLimit

@Stability(Stable)
@Nullable
default Number getThrottlingBurstLimit()

Specifies the throttling burst limit.

See Also:

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

getThrottlingRateLimit

@Stability(Stable)
@Nullable
default Number getThrottlingRateLimit()

Specifies the throttling rate limit.

See Also:

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

builder

@Stability(Stable)
static CfnStage.MethodSettingProperty.Builder builder()

Returns:

a CfnStage.MethodSettingProperty.Builder of CfnStage.MethodSettingProperty