Interface CpWebSiteProps

CloudKitect Website Pattern Properties

interface CpWebSiteProps {
    cpAdditionalDomainNames?: string[];
    cpBucketPolicyActions?: string[];
    cpBucketProps?: CcBucketProps;
    cpCloudFrontDistributionDefaultBehavior?: BehaviorOptions;
    cpDefaultRootObject?: string;
    cpDomainName: string;
    cpEnableCloudFrontLogging?: boolean;
    cpErrorResponsePagePath?: string;
    cpHostedZone?: IHostedZone;
    cpOriginAccessIdentity?: OriginAccessIdentity;
    cpPathToContent: string;
    cpSubdomain?: string;
}

Properties

cpAdditionalDomainNames? cpBucketPolicyActions? cpBucketProps? cpCloudFrontDistributionDefaultBehavior? cpDefaultRootObject? cpDomainName cpEnableCloudFrontLogging? cpErrorResponsePagePath? cpHostedZone? cpOriginAccessIdentity? cpPathToContent cpSubdomain?

Properties

Optional Readonly cpAdditionalDomainNames

cpAdditionalDomainNames?: string[]

Additional domain names to be included in ssl and redirect traffic to main domain

Optional Readonly cpBucketPolicyActions

cpBucketPolicyActions?: string[]

Additional bucket policy actions

Default

s3:GetObject

Optional Readonly cpBucketProps

cpBucketProps?: CcBucketProps

Bucket properties to override defaults

Optional Readonly cpCloudFrontDistributionDefaultBehavior

cpCloudFrontDistributionDefaultBehavior?: BehaviorOptions

Override default CloudFront Distribution behavior

Optional Readonly cpDefaultRootObject

cpDefaultRootObject?: string

Root object of the website, e.g. index.html

Default

index.html

Readonly cpDomainName

cpDomainName: string

Domain name

Optional Readonly cpEnableCloudFrontLogging

cpEnableCloudFrontLogging?: boolean

Flag to enable or disable CloudFront logging

Default

false

Optional Readonly cpErrorResponsePagePath

cpErrorResponsePagePath?: string

Root object of the website, e.g. /error-page.html

Default

/error.html

Optional Readonly cpHostedZone

cpHostedZone?: IHostedZone

Hosted zone properties

Optional Readonly cpOriginAccessIdentity

cpOriginAccessIdentity?: OriginAccessIdentity

Origin Access Identity to override defaults

Default

A new one is created

Readonly cpPathToContent

cpPathToContent: string

Location of website content

Optional Readonly cpSubdomain

cpSubdomain?: string

Subdomain name e.g. www

Default

www

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc