Interface IBranchOptions

(experimental) Options to add a branch to an application.

Namespace: Amazon.CDK.AWS.Amplify.Alpha

Assembly: Amazon.CDK.AWS.Amplify.Alpha.dll

Syntax (csharp)

public interface IBranchOptions

Syntax (vb)

Public Interface IBranchOptions

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

Role computeRole;
             App amplifyApp;


             var branch = amplifyApp.AddBranch("dev", new BranchOptions { ComputeRole = computeRole });

Synopsis

Properties

Asset	(experimental) Asset for deployment.
AutoBuild	(experimental) Whether to enable auto building for the branch.
BasicAuth	(experimental) The Basic Auth configuration.
BranchName	(experimental) The name of the branch.
BuildSpec	(experimental) BuildSpec for the branch.
ComputeRole	(experimental) The IAM role to assign to a branch of an SSR app.
Description	(experimental) A description for the branch.
EnvironmentVariables	(experimental) Environment variables for the branch.
PerformanceMode	(experimental) Enables performance mode for the branch.
PullRequestEnvironmentName	(experimental) The dedicated backend environment for the pull request previews.
PullRequestPreview	(experimental) Whether to enable pull request preview for the branch.
SkewProtection	(experimental) Specifies whether the skew protection feature is enabled for the branch.
Stage	(experimental) Stage for the branch.

Properties

Asset

(experimental) Asset for deployment.

Asset? Asset { get; }

Property Value

Asset

Remarks

The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's startDeployment API to initiate and deploy a S3 asset onto the App.

Default: - no asset

Stability: Experimental

AutoBuild

(experimental) Whether to enable auto building for the branch.

bool? AutoBuild { get; }

Property Value

bool?

Remarks

Default: true

Stability: Experimental

BasicAuth

(experimental) The Basic Auth configuration.

BasicAuth? BasicAuth { get; }

Property Value

BasicAuth

Remarks

Use this to set password protection for the branch

Default: - no password protection

Stability: Experimental

BranchName

(experimental) The name of the branch.

string? BranchName { get; }

Property Value

string

Remarks

Default: - the construct's id

Stability: Experimental

BuildSpec

(experimental) BuildSpec for the branch.

BuildSpec? BuildSpec { get; }

Property Value

BuildSpec

Remarks

Default: - no build spec

Stability: Experimental

See: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

ComputeRole

(experimental) The IAM role to assign to a branch of an SSR app.

IRole? ComputeRole { get; }

Property Value

IRole

Remarks

The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions.

This role overrides the app-level compute role.

Default: undefined - No specific role for the branch. If the app has a compute role, it will be inherited.

Stability: Experimental

Description

(experimental) A description for the branch.

string? Description { get; }

Property Value

string

Remarks

Default: - no description

Stability: Experimental

EnvironmentVariables

(experimental) Environment variables for the branch.

IDictionary<string, string>? EnvironmentVariables { get; }

Property Value

IDictionary<string, string>

Remarks

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

Default: - application environment variables

Stability: Experimental

PerformanceMode

(experimental) Enables performance mode for the branch.

bool? PerformanceMode { get; }

Property Value

bool?

Remarks

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Default: false

Stability: Experimental

PullRequestEnvironmentName

(experimental) The dedicated backend environment for the pull request previews.

string? PullRequestEnvironmentName { get; }

Property Value

string

Remarks

Default: - automatically provision a temporary backend

Stability: Experimental

PullRequestPreview

(experimental) Whether to enable pull request preview for the branch.

bool? PullRequestPreview { get; }

Property Value

bool?

Remarks

Default: true

Stability: Experimental

SkewProtection

(experimental) Specifies whether the skew protection feature is enabled for the branch.

bool? SkewProtection { get; }

Property Value

bool?

Remarks

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs.

Default: None - Default setting is no skew protection.

Stability: Experimental

Stage

(experimental) Stage for the branch.

string? Stage { get; }

Property Value

string

Remarks

Default: - no stage

Stability: Experimental