Interface IMethodDeploymentOptions

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IMethodDeploymentOptions

Syntax (vb)

Public Interface IMethodDeploymentOptions

Remarks

ExampleMetadata: infused

Examples

var api = new RestApi(this, "books");
var deployment = new Deployment(this, "my-deployment", new DeploymentProps { Api = api });
var stage = new Stage(this, "my-stage", new StageProps {
    Deployment = deployment,
    MethodOptions = new Dictionary<string, MethodDeploymentOptions> {
        { "/*/*", new MethodDeploymentOptions {  // This special path applies to all resource paths and all HTTP methods
            ThrottlingRateLimit = 100,
            ThrottlingBurstLimit = 200 } }
    }
});

Synopsis

Properties

CacheDataEncrypted	Indicates whether the cached responses are encrypted.
CacheTtl	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.
LoggingLevel	Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
MetricsEnabled	Specifies whether Amazon CloudWatch metrics are enabled for this method.
ThrottlingBurstLimit	Specifies the throttling burst limit.
ThrottlingRateLimit	Specifies the throttling rate limit.

Properties

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

virtual Nullable<bool> CacheDataEncrypted { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

CacheTtl

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

virtual Duration CacheTtl { get; }

Property Value

Duration

Remarks

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

Default: Duration.minutes(5)

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

CachingEnabled

Specifies whether responses should be cached and returned for requests.

virtual Nullable<bool> CachingEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: - Caching is Disabled.

DataTraceEnabled

Specifies whether data trace logging is enabled for this method.

virtual Nullable<bool> DataTraceEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.

Default: false

LoggingLevel

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

virtual Nullable<MethodLoggingLevel> LoggingLevel { get; }

Property Value

System.Nullable<MethodLoggingLevel>

Remarks

Default: - Off

MetricsEnabled

Specifies whether Amazon CloudWatch metrics are enabled for this method.

virtual Nullable<bool> MetricsEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

ThrottlingBurstLimit

Specifies the throttling burst limit.

virtual Nullable<double> ThrottlingBurstLimit { get; }

Property Value

System.Nullable<System.Double>

Remarks

The total rate of all requests in your AWS account is limited to 5,000 requests.

Default: - No additional restriction.

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

ThrottlingRateLimit

Specifies the throttling rate limit.

virtual Nullable<double> ThrottlingRateLimit { get; }

Property Value

System.Nullable<System.Double>

Remarks

The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).

Default: - No additional restriction.

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html