Package software.aws.awsprototypingsdk.staticwebsite

Interface StaticWebsiteProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    StaticWebsiteProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.65.0 (build 7a02b7f)",
           date="2022-08-30T04:18:33.225Z")
@Stability(Experimental)
public interface StaticWebsiteProps
extends software.amazon.jsii.JsiiSerializable
    (experimental) Properties for configuring the StaticWebsite.

    • Method Detail

      • getWebsiteContentPath

        @Stability(Experimental)
@NotNull
String getWebsiteContentPath()
        (experimental) Path to the directory containing the static website files and assets.

        This directory must contain an index.html file.

      • getDefaultWebsiteBucketEncryption

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.s3.BucketEncryption getDefaultWebsiteBucketEncryption()
        (experimental) Bucket encryption to use for the default bucket.

        Supported options are KMS or S3MANAGED.

        Note: If planning to use KMS, ensure you associate a Lambda Edge function to sign requests to S3 as OAI does not currently support KMS encryption. Refer to {@link https://aws.amazon.com/blogs/networking-and-content-delivery/serving-sse-kms-encrypted-content-from-s3-using-cloudfront/}

        Default: - "S3MANAGED"

      • getDefaultWebsiteBucketEncryptionKey

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.kms.Key getDefaultWebsiteBucketEncryptionKey()
        (experimental) A predefined KMS customer encryption key to use for the default bucket that gets created.

        Note: This is only used if the websiteBucket is left undefined, otherwise all settings from the provided websiteBucket will be used.

      • getDistributionProps

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.cloudfront.DistributionProps getDistributionProps()
        (experimental) Custom distribution properties.

        Note: defaultBehaviour.origin is a required parameter, however it will not be used as this construct will wire it on your behalf. You will need to pass in an instance of StaticWebsiteOrigin (NoOp) to keep the compiler happy.

      • getRuntimeOptions

        @Stability(Experimental)
@Nullable
default RuntimeOptions getRuntimeOptions()
        (experimental) Dynamic configuration which gets resolved only during deployment.

      • getWebAclProps

        @Stability(Experimental)
@Nullable
default CloudFrontWebAclProps getWebAclProps()
        (experimental) Limited configuration settings for the generated webAcl.

        For more advanced settings, create your own ACL and pass in the webAclId as a param to distributionProps.

        Note: If pass in your own ACL, make sure the SCOPE is CLOUDFRONT and it is created in us-east-1.

      • getWebsiteBucket

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.s3.IBucket getWebsiteBucket()
        (experimental) Predefined bucket to deploy the website into.