Interface CcRestApiProps

CloudKitect Rest Api component properties

interface CcRestApiProps {
    ccAlwaysAddDefaultAlarms?: boolean;
    ccApiGatewaySecret?: Secret;
    ccDoNotAddDefaultAlarms?: boolean;
    ccDoNotAddWaf?: boolean;
    ccDoNotCreateDefaultApiKey?: boolean;
    ccDoNotDeploy?: boolean;
    ccDoNotEnableDefaultAccessLog?: boolean;
    stageOptions?: StageOptions;
}

Hierarchy

Properties

ccAlwaysAddDefaultAlarms? ccApiGatewaySecret? ccDoNotAddDefaultAlarms? ccDoNotAddWaf? ccDoNotCreateDefaultApiKey? ccDoNotDeploy? ccDoNotEnableDefaultAccessLog? stageOptions?

Properties

Optional Readonly ccAlwaysAddDefaultAlarms

ccAlwaysAddDefaultAlarms?: boolean

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

Optional Readonly ccApiGatewaySecret

ccApiGatewaySecret?: Secret

API Gateway secret needed to communicate with end points

Optional Readonly ccDoNotAddDefaultAlarms

ccDoNotAddDefaultAlarms?: boolean

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

Optional Readonly ccDoNotAddWaf

ccDoNotAddWaf?: boolean

Enable enhanced security options,

Default Value

For production like environments the enhanced security is automatically enabled.

Optional Readonly ccDoNotCreateDefaultApiKey

ccDoNotCreateDefaultApiKey?: boolean

CcRestapi automatically creates a default ApiKey with a corresponding default Usage Plan, unless the deployment is intentionally disabled by setting the deploy property to false. By default, the ApiKey is required for all method invocations. 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 ccDoNotDeploy

ccDoNotDeploy?: boolean

Flag to control if api should be deployed or not.

Default Value

false

Optional Readonly ccDoNotEnableDefaultAccessLog

ccDoNotEnableDefaultAccessLog?: boolean

CcRestapi 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

Optional Readonly stageOptions

stageOptions?: StageOptions

Stage options

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc