Package software.amazon.awscdk.cfnpropertymixins.services.amplify

Class CfnBranchMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnBranchMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnBranchMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnBranchMixinProps

@Stability(Stable)
@Internal
public static final class CfnBranchMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnBranchMixinProps

An implementation for CfnBranchMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnBranchMixinProps

CfnBranchMixinProps.Builder, CfnBranchMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnBranchMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnBranchMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAppId()	The unique ID for an Amplify app.
final Object	getBackend()	The backend for a Branch of an Amplify app.
final Object	getBasicAuthConfig()	The basic authorization credentials for a branch of an Amplify app.
final String	getBranchName()	The name for the branch.
final String	getBuildSpec()	The build specification (build spec) for the branch.
final String	getComputeRoleArn()	The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.
final String	getDescription()	The description for the branch that is part of an Amplify app.
final Object	getEnableAutoBuild()	Enables auto building for the branch.
final Object	getEnablePerformanceMode()	Enables performance mode for the branch.
final Object	getEnablePullRequestPreview()	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
final Object	getEnableSkewProtection()	Specifies whether the skew protection feature is enabled for the branch.
final Object	getEnvironmentVariables()	The environment variables for the branch.
final String	getFramework()	The framework for the branch.
final String	getPullRequestEnvironmentName()	If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
final String	getStage()	Describes the current stage for the branch.
final List<CfnTag>	getTags()	The tag for the branch.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnBranchMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnBranchMixinProps.Builder.

Method Details

getAppId

public final String getAppId()

Description copied from interface: CfnBranchMixinProps

The unique ID for an Amplify app.

Specified by:

getAppId in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid

getBackend

public final Object getBackend()

Description copied from interface: CfnBranchMixinProps

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Returns union: either IResolvable or CfnBranchPropsMixin.BackendProperty

Specified by:

getBackend in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-backend

getBasicAuthConfig

public final Object getBasicAuthConfig()

Description copied from interface: CfnBranchMixinProps

The basic authorization credentials for a branch of an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

Returns union: either IResolvable or CfnBranchPropsMixin.BasicAuthConfigProperty

Specified by:

getBasicAuthConfig in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig

getBranchName

public final String getBranchName()

Description copied from interface: CfnBranchMixinProps

The name for the branch.

Specified by:

getBranchName in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname

getBuildSpec

public final String getBuildSpec()

Description copied from interface: CfnBranchMixinProps

The build specification (build spec) for the branch.

Specified by:

getBuildSpec in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec

getComputeRoleArn

public final String getComputeRoleArn()

Description copied from interface: CfnBranchMixinProps

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .

Specified by:

getComputeRoleArn in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-computerolearn

getDescription

public final String getDescription()

Description copied from interface: CfnBranchMixinProps

The description for the branch that is part of an Amplify app.

Specified by:

getDescription in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description

getEnableAutoBuild

public final Object getEnableAutoBuild()

Description copied from interface: CfnBranchMixinProps

Enables auto building for the branch.

Returns union: either Boolean or IResolvable

Specified by:

getEnableAutoBuild in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild

getEnablePerformanceMode

public final Object getEnablePerformanceMode()

Description copied from interface: CfnBranchMixinProps

Enables performance mode for the branch.

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.

Returns union: either Boolean or IResolvable

Specified by:

getEnablePerformanceMode in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode

getEnablePullRequestPreview

public final Object getEnablePullRequestPreview()

Description copied from interface: CfnBranchMixinProps

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.

To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName property.

For more information, see Web Previews in the AWS Amplify Hosting User Guide .

Returns union: either Boolean or IResolvable

Specified by:

getEnablePullRequestPreview in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview

getEnableSkewProtection

public final Object getEnableSkewProtection()

Description copied from interface: CfnBranchMixinProps

Specifies whether the skew protection feature is enabled for the branch.

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. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide .

Returns union: either Boolean or IResolvable

Specified by:

getEnableSkewProtection in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableskewprotection

getEnvironmentVariables

public final Object getEnvironmentVariables()

Description copied from interface: CfnBranchMixinProps

The environment variables for the branch.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBranchPropsMixin.EnvironmentVariableProperty>

Specified by:

getEnvironmentVariables in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables

getFramework

public final String getFramework()

Description copied from interface: CfnBranchMixinProps

The framework for the branch.

Specified by:

getFramework in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-framework

getPullRequestEnvironmentName

public final String getPullRequestEnvironmentName()

Description copied from interface: CfnBranchMixinProps

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.

For example, you could specify an environment named prod , test , or dev that you initialized with the Amplify CLI and mapped to this branch.

To enable pull request previews, set the EnablePullRequestPreview property to true .

If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.

For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide .

Specified by:

getPullRequestEnvironmentName in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname

getStage

public final String getStage()

Description copied from interface: CfnBranchMixinProps

Describes the current stage for the branch.

Specified by:

getStage in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnBranchMixinProps

The tag for the branch.

Specified by:

getTags in interface CfnBranchMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object