Package software.amazon.awscdk.services.amplify

Class CfnAppProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.amplify.CfnAppProps.Jsii$Proxy

All Implemented Interfaces:

CfnAppProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAppProps

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

An implementation for CfnAppProps

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.services.amplify.CfnAppProps

CfnAppProps.Builder, CfnAppProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAppProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAppProps.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	getAccessToken()	The personal access token for a GitHub repository for an Amplify app.
final Object	getAutoBranchCreationConfig()	Sets the configuration for your automatic branch creation.
final Object	getBasicAuthConfig()	The credentials for basic authorization for an Amplify app.
final String	getBuildSpec()	The build specification (build spec) for an Amplify app.
final Object	getCacheConfig()	The cache configuration for the Amplify app.
final String	getComputeRoleArn()	The Amazon Resource Name (ARN) of the IAM role for an SSR app.
final String	getCustomHeaders()	The custom HTTP headers for an Amplify app.
final Object	getCustomRules()	The custom rewrite and redirect rules for an Amplify app.
final String	getDescription()	The description of the Amplify app.
final Object	getEnableBranchAutoDeletion()	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
final Object	getEnvironmentVariables()	The environment variables for the Amplify app.
final Object	getIamServiceRole()	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
final Object	getJobConfig()	The configuration details that apply to the jobs for an Amplify app.
final String	getName()	The name of the Amplify app.
final String	getOauthToken()	The OAuth token for a third-party source control system for an Amplify app.
final String	getPlatform()	The platform for the Amplify app.
final String	getRepository()	The Git repository for the Amplify app.
final List<CfnTag>	getTags()	The tag for an Amplify app.
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(CfnAppProps.Builder builder)

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

Method Details

getName

public final String getName()

Description copied from interface: CfnAppProps

The name of the Amplify app.

Specified by:

getName in interface CfnAppProps

See Also:

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

getAccessToken

public final String getAccessToken()

Description copied from interface: CfnAppProps

The personal access token for a GitHub repository for an Amplify app.

The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

You must specify either AccessToken or OauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Specified by:

getAccessToken in interface CfnAppProps

See Also:

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

getAutoBranchCreationConfig

public final Object getAutoBranchCreationConfig()

Description copied from interface: CfnAppProps

Sets the configuration for your automatic branch creation.

Returns union: either IResolvable or CfnApp.AutoBranchCreationConfigProperty

Specified by:

getAutoBranchCreationConfig in interface CfnAppProps

See Also:

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

getBasicAuthConfig

public final Object getBasicAuthConfig()

Description copied from interface: CfnAppProps

The credentials for basic authorization for an Amplify app.

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

Returns union: either IResolvable or CfnApp.BasicAuthConfigProperty

Specified by:

getBasicAuthConfig in interface CfnAppProps

See Also:

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

getBuildSpec

public final String getBuildSpec()

Description copied from interface: CfnAppProps

The build specification (build spec) for an Amplify app.

Specified by:

getBuildSpec in interface CfnAppProps

See Also:

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

getCacheConfig

public final Object getCacheConfig()

Description copied from interface: CfnAppProps

The cache configuration for the Amplify app.

If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Returns union: either IResolvable or CfnApp.CacheConfigProperty

Specified by:

getCacheConfig in interface CfnAppProps

See Also:

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

getComputeRoleArn

public final String getComputeRoleArn()

Description copied from interface: CfnAppProps

The Amazon Resource Name (ARN) of the IAM role for an SSR app.

The 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 CfnAppProps

See Also:

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

getCustomHeaders

public final String getCustomHeaders()

Description copied from interface: CfnAppProps

The custom HTTP headers for an Amplify app.

Specified by:

getCustomHeaders in interface CfnAppProps

See Also:

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

getCustomRules

public final Object getCustomRules()

Description copied from interface: CfnAppProps

The custom rewrite and redirect rules for an Amplify app.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApp.CustomRuleProperty>

Specified by:

getCustomRules in interface CfnAppProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnAppProps

The description of the Amplify app.

Specified by:

getDescription in interface CfnAppProps

See Also:

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

getEnableBranchAutoDeletion

public final Object getEnableBranchAutoDeletion()

Description copied from interface: CfnAppProps

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Returns union: either Boolean or IResolvable

Specified by:

getEnableBranchAutoDeletion in interface CfnAppProps

See Also:

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

getEnvironmentVariables

public final Object getEnvironmentVariables()

Description copied from interface: CfnAppProps

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

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

Specified by:

getEnvironmentVariables in interface CfnAppProps

See Also:

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

getIamServiceRole

public final Object getIamServiceRole()

Description copied from interface: CfnAppProps

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

Returns union: either String or IRoleRef

Specified by:

getIamServiceRole in interface CfnAppProps

See Also:

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

getJobConfig

public final Object getJobConfig()

Description copied from interface: CfnAppProps

The configuration details that apply to the jobs for an Amplify app.

Returns union: either IResolvable or CfnApp.JobConfigProperty

Specified by:

getJobConfig in interface CfnAppProps

See Also:

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

getOauthToken

public final String getOauthToken()

Description copied from interface: CfnAppProps

The OAuth token for a third-party source control system for an Amplify app.

The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .

You must specify either OauthToken or AccessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Specified by:

getOauthToken in interface CfnAppProps

See Also:

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

getPlatform

public final String getPlatform()

Description copied from interface: CfnAppProps

The platform for the Amplify app.

For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

Specified by:

getPlatform in interface CfnAppProps

See Also:

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

getRepository

public final String getRepository()

Description copied from interface: CfnAppProps

The Git repository for the Amplify app.

Specified by:

getRepository in interface CfnAppProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnAppProps

The tag for an Amplify app.

Specified by:

getTags in interface CfnAppProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-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