Interface WaRestApiProps

Well Architected Rest Api properties

Hierarchy

Properties

stageOptions? waAlwaysAddDefaultAlarms? waDoNotAddDefaultAlarms? waDoNotCreateDefaultApiKey? waDoNotDeploy? waDoNotEnableDefaultAccessLog?

Properties

Optional Readonly stageOptions

stageOptions?: StageOptions

Stage options

Optional Readonly waAlwaysAddDefaultAlarms

waAlwaysAddDefaultAlarms?: boolean

This flag is used to always add the default alarms irrespective of the environment the stack is deployed.

Optional Readonly waDoNotAddDefaultAlarms

waDoNotAddDefaultAlarms?: boolean

This flag is used to skip the default alarms irrespective of the environment the stack is deployed.

Optional Readonly waDoNotCreateDefaultApiKey

waDoNotCreateDefaultApiKey?: boolean

WaRestApi automatically creates a default ApiKey with a corresponding default Usage Plan, unless the deployment is intentionally disabled by setting the deploy property to false. The default ApiKey is required for all method invocations by default. The default Usage Plan has no throttling and the quota is also not set. Set this flag to true if such a default ApiKey / Usage Plan is not desired.

Default Value

false

Optional Readonly waDoNotDeploy

waDoNotDeploy?: boolean

Flag to control if api should be deployed or not.

Optional Readonly waDoNotEnableDefaultAccessLog

waDoNotEnableDefaultAccessLog?: boolean

WaRestApi automatically enables access logs using the destination of a specific CloudWatch LogGroup based on the name DefaultRestApiAccessLogGroup. The log entry format is the CDK default Common Log Format. Set this flag to true if such a default access log enablement is not desired.

Default Value

false

Settings

Member Visibility

Theme

Generated using TypeDoc