Interface CpRestApiProps

CloudKitect Rest Api Pattern Properties

interface CpRestApiProps {
    CpApiGatewayWafProps?: CcApiGatewayWafProps;
    cpAccessLogsBucket?: CcBucket;
    cpApiGatewayCachePolicy?: CachePolicy;
    cpApiGatewayOriginRequestPolicy?: OriginRequestPolicy;
    cpApiProps?: CcRestApiProps;
    cpCloudFrontSecret?: Secret;
    cpCloudfrontAllowedMethods?: AllowedMethods;
    cpCloudfrontWafProps?: CcCloudfrontWafProps;
    cpDistributionProps?: CcDistributionProps;
    cpDomainName: string;
    cpFallbackOrigin?: IOrigin;
    cpHostedZone?: IHostedZone;
    cpSubDomain?: string;
}

Properties

CpApiGatewayWafProps? cpAccessLogsBucket? cpApiGatewayCachePolicy? cpApiGatewayOriginRequestPolicy? cpApiProps? cpCloudFrontSecret? cpCloudfrontAllowedMethods? cpCloudfrontWafProps? cpDistributionProps? cpDomainName cpFallbackOrigin? cpHostedZone? cpSubDomain?

Properties

Optional Readonly CpApiGatewayWafProps

CpApiGatewayWafProps?: CcApiGatewayWafProps

Api Gateway WAF properties to override defaults

Default

A new WAF is created that checks X-Origin-Verify header

Optional Readonly cpAccessLogsBucket

cpAccessLogsBucket?: CcBucket

Access Logs Bucket to override defaults

Default

No access logs are written

Optional Readonly cpApiGatewayCachePolicy

cpApiGatewayCachePolicy?: CachePolicy

API Gateway Cache Policy to override defaults

Default

A new cache policy is generated

Optional Readonly cpApiGatewayOriginRequestPolicy

cpApiGatewayOriginRequestPolicy?: OriginRequestPolicy

API Gateway Origin Request Policy to override defaults

Default

A new request policy is generated

Optional Readonly cpApiProps

cpApiProps?: CcRestApiProps

Rest API properties to override defaults

Optional Readonly cpCloudFrontSecret

cpCloudFrontSecret?: Secret

CLoudFront secret to use with X-Origin-Verify header

Default

Secret is generated and stored in SSM

Optional Readonly cpCloudfrontAllowedMethods

cpCloudfrontAllowedMethods?: AllowedMethods

CloudFront allowed methods to override defaults

Default

AllowedMethods.ALLOW_ALL

Optional Readonly cpCloudfrontWafProps

cpCloudfrontWafProps?: CcCloudfrontWafProps

CloudFront WAF properties to override defaults

Optional Readonly cpDistributionProps

cpDistributionProps?: CcDistributionProps

CloudFront Distribution properties to override defaults

Readonly cpDomainName

cpDomainName: string

Domain name, if domain name is not provided then cpZoneName is used as domain name

Optional Readonly cpFallbackOrigin

cpFallbackOrigin?: IOrigin

Specify fallback origin

Default

https://www.domainName/error.html

Optional Readonly cpHostedZone

cpHostedZone?: IHostedZone

Optional Readonly cpSubDomain

cpSubDomain?: string

Sub domain e.g. api.

Default

api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc