software.amazon.awscdk.services.amplify

Class App

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.amplify.App

All Implemented Interfaces:

IConstruct, IDependable, IResource, IApp, IGrantable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.069Z")
public class App
extends Resource
implements IApp, IGrantable

(experimental) An Amplify Console application.

Example:

 App amplifyApp = App.Builder.create(this, "MyApp")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(SecretValue.secretsManager("my-github-token"))
                 .build())
         .autoBranchCreation(AutoBranchCreation.builder() // Automatically connect branches that match a pattern set
                 .patterns(List.of("feature/*", "test/*")).build())
         .autoBranchDeletion(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	App.Builder (experimental) A fluent builder for App.

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

IApp.Jsii$Default, IApp.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	App(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	App(software.amazon.jsii.JsiiObjectRef objRef)
	App(software.constructs.Construct scope, java.lang.String id, AppProps props)

Method Summary

Modifier and Type	Method and Description
App	addAutoBranchEnvironment(java.lang.String name, java.lang.String value) (experimental) Adds an environment variable to the auto created branch.
Branch	addBranch(java.lang.String id) (experimental) Adds a branch to this application.
Branch	addBranch(java.lang.String id, BranchOptions options) (experimental) Adds a branch to this application.
App	addCustomRule(CustomRule rule) (experimental) Adds a custom rewrite/redirect rule to this application.
Domain	addDomain(java.lang.String id) (experimental) Adds a domain to this application.
Domain	addDomain(java.lang.String id, DomainOptions options) (experimental) Adds a domain to this application.
App	addEnvironment(java.lang.String name, java.lang.String value) (experimental) Adds an environment variable to this application.
static IApp	fromAppId(software.constructs.Construct scope, java.lang.String id, java.lang.String appId) (experimental) Import an existing application.
java.lang.String	getAppId() (experimental) The application id.
java.lang.String	getAppName() (experimental) The name of the application.
java.lang.String	getArn() (experimental) The ARN of the application.
java.lang.String	getDefaultDomain() (experimental) The default domain of the application.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

App

protected App(software.amazon.jsii.JsiiObjectRef objRef)

App

protected App(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

App

public App(software.constructs.Construct scope,
           java.lang.String id,
           AppProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAppId

public static IApp fromAppId(software.constructs.Construct scope,
                             java.lang.String id,
                             java.lang.String appId)

(experimental) Import an existing application.

Parameters:

scope - This parameter is required.

id - This parameter is required.

appId - This parameter is required.

addAutoBranchEnvironment

public App addAutoBranchEnvironment(java.lang.String name,
                                    java.lang.String value)

(experimental) Adds an environment variable to the auto created branch.

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

Parameters:

name - This parameter is required.

value - This parameter is required.

addBranch

public Branch addBranch(java.lang.String id,
                        BranchOptions options)

(experimental) Adds a branch to this application.

Parameters:

id - This parameter is required.

options -

addBranch

public Branch addBranch(java.lang.String id)

(experimental) Adds a branch to this application.

Parameters:

id - This parameter is required.

addCustomRule

public App addCustomRule(CustomRule rule)

(experimental) Adds a custom rewrite/redirect rule to this application.

Parameters:

rule - This parameter is required.

addDomain

public Domain addDomain(java.lang.String id,
                        DomainOptions options)

(experimental) Adds a domain to this application.

Parameters:

id - This parameter is required.

options -

addDomain

public Domain addDomain(java.lang.String id)

(experimental) Adds a domain to this application.

Parameters:

id - This parameter is required.

addEnvironment

public App addEnvironment(java.lang.String name,
                          java.lang.String value)

(experimental) Adds an environment variable to this application.

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

Parameters:

name - This parameter is required.

value - This parameter is required.

getAppId

public java.lang.String getAppId()

(experimental) The application id.

Specified by:

getAppId in interface IApp

getAppName

public java.lang.String getAppName()

(experimental) The name of the application.

getArn

public java.lang.String getArn()

(experimental) The ARN of the application.

getDefaultDomain

public java.lang.String getDefaultDomain()

(experimental) The default domain of the application.

getGrantPrincipal

public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable