Class App
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.amplify.alpha.App
- All Implemented Interfaces:
IResource
,IApp
,IGrantable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:28.956Z")
@Stability(Experimental)
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/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.amplify.alpha.IApp
IApp.Jsii$Default, IApp.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable
IGrantable.Jsii$Default, IGrantable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAutoBranchEnvironment
(String name, String value) (experimental) Adds an environment variable to the auto created branch.(experimental) Adds a branch to this application.addBranch
(String id, BranchOptions options) (experimental) Adds a branch to this application.addCustomRule
(CustomRule rule) (experimental) Adds a custom rewrite/redirect rule to this application.(experimental) Adds a domain to this application.addDomain
(String id, DomainOptions options) (experimental) Adds a domain to this application.addEnvironment
(String name, String value) (experimental) Adds an environment variable to this application.static IApp
(experimental) Import an existing application.getAppId()
(experimental) The application id.(experimental) The name of the application.getArn()
(experimental) The ARN of the application.(experimental) The default domain of the application.(experimental) The principal to grant permissions to.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
App
protected App(software.amazon.jsii.JsiiObjectRef objRef) -
App
protected App(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
App
@Stability(Experimental) public App(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull AppProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromAppId
@Stability(Experimental) @NotNull public static IApp fromAppId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String appId) (experimental) Import an existing application.- Parameters:
scope
- This parameter is required.id
- This parameter is required.appId
- This parameter is required.
-
addAutoBranchEnvironment
@Stability(Experimental) @NotNull public App addAutoBranchEnvironment(@NotNull String name, @NotNull 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
@Stability(Experimental) @NotNull public Branch addBranch(@NotNull String id, @Nullable BranchOptions options) (experimental) Adds a branch to this application.- Parameters:
id
- This parameter is required.options
-
-
addBranch
(experimental) Adds a branch to this application.- Parameters:
id
- This parameter is required.
-
addCustomRule
(experimental) Adds a custom rewrite/redirect rule to this application.- Parameters:
rule
- This parameter is required.
-
addDomain
@Stability(Experimental) @NotNull public Domain addDomain(@NotNull String id, @Nullable DomainOptions options) (experimental) Adds a domain to this application.- Parameters:
id
- This parameter is required.options
-
-
addDomain
(experimental) Adds a domain to this application.- Parameters:
id
- This parameter is required.
-
addEnvironment
@Stability(Experimental) @NotNull public App addEnvironment(@NotNull String name, @NotNull 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
(experimental) The application id. -
getAppName
(experimental) The name of the application. -
getArn
(experimental) The ARN of the application. -
getDefaultDomain
(experimental) The default domain of the application. -
getGrantPrincipal
(experimental) The principal to grant permissions to.- Specified by:
getGrantPrincipal
in interfaceIGrantable
-