Package software.aws.awsprototypingsdk.staticwebsite

Interface RuntimeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RuntimeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.65.0 (build 7a02b7f)",
           date="2022-08-30T04:18:33.221Z")
@Stability(Experimental)
public interface RuntimeOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Dynamic configuration which gets resolved only during deployment.

Example:

 // Will store a JSON file called runtime-config.json in the root of the StaticWebsite S3 bucket containing any
 // and all resolved values.
 const runtimeConfig = {jsonPayload: {bucketArn: s3Bucket.bucketArn}};
 new StaticWebsite(scope, 'StaticWebsite', {websiteContentPath: 'path/to/website', runtimeConfig});
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RuntimeOptions.Builder	A builder for RuntimeOptions
static class	RuntimeOptions.Jsii$Proxy	An implementation for RuntimeOptions

Method Summary

Modifier and Type	Method	Description
static RuntimeOptions.Builder	builder()
default String	getJsonFileName()	(experimental) File name to store runtime configuration (jsonPayload).
Object	getJsonPayload()	(experimental) Arbitrary JSON payload containing runtime values to deploy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJsonPayload

@Stability(Experimental)
@NotNull
Object getJsonPayload()

(experimental) Arbitrary JSON payload containing runtime values to deploy.

Typically this contains resourceArns, etc which are only known at deploy time.

Example:

 { userPoolId: some.userPool.userPoolId, someResourceArn: some.resource.Arn }
 

getJsonFileName

@Stability(Experimental)
@Nullable
default String getJsonFileName()

(experimental) File name to store runtime configuration (jsonPayload).

Must follow pattern: '*.json'

Default: "runtime-config.json"

builder

@Stability(Experimental)
static RuntimeOptions.Builder builder()

Returns:

a RuntimeOptions.Builder of RuntimeOptions