software.amazon.awscdk.services.amplify

Interface AppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:20.059Z")
 @Stability(value=Experimental)
public interface AppProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for an App.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AppProps.Builder A builder for AppProps
static class	AppProps.Jsii$Proxy An implementation for AppProps

Method Summary

Modifier and Type	Method and Description
static AppProps.Builder	builder()
default String	getAppName() (experimental) The name for the application.
default AutoBranchCreation	getAutoBranchCreation() (experimental) The auto branch creation configuration.
default Boolean	getAutoBranchDeletion() (experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
default BasicAuth	getBasicAuth() (experimental) The Basic Auth configuration.
default BuildSpec	getBuildSpec() (experimental) BuildSpec for the application.
default List<CustomRule>	getCustomRules() (experimental) Custom rewrite/redirect rules for the application.
default String	getDescription() (experimental) A description for the application.
default Map<String,String>	getEnvironmentVariables() (experimental) Environment variables for the application.
default IRole	getRole() (experimental) The IAM service role to associate with the application.
default ISourceCodeProvider	getSourceCodeProvider() (experimental) The source code provider for this application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAppName

@Stability(value=Experimental)
 @Nullable
default String getAppName()

(experimental) The name for the application.

Default: - a CDK generated name

getAutoBranchCreation

@Stability(value=Experimental)
 @Nullable
default AutoBranchCreation getAutoBranchCreation()

(experimental) The auto branch creation configuration.

Use this to automatically create branches that match a certain pattern.

Default: - no auto branch creation

getAutoBranchDeletion

@Stability(value=Experimental)
 @Nullable
default Boolean getAutoBranchDeletion()

(experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

Default: false

getBasicAuth

@Stability(value=Experimental)
 @Nullable
default BasicAuth getBasicAuth()

(experimental) The Basic Auth configuration.

Use this to set password protection at an app level to all your branches.

Default: - no password protection

getBuildSpec

@Stability(value=Experimental)
 @Nullable
default BuildSpec getBuildSpec()

(experimental) BuildSpec for the application.

Alternatively, add a amplify.yml file to the repository.

Default: - no build spec

See Also:

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

getCustomRules

@Stability(value=Experimental)
 @Nullable
default List<CustomRule> getCustomRules()

(experimental) Custom rewrite/redirect rules for the application.

Default: - no custom rewrite/redirect rules

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) A description for the application.

Default: - no description

getEnvironmentVariables

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnvironmentVariables()

(experimental) Environment variables for the application.

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

Default: - no environment variables

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) The IAM service role to associate with the application.

The App implements IGrantable.

Default: - a new role is created

getSourceCodeProvider

@Stability(value=Experimental)
 @Nullable
default ISourceCodeProvider getSourceCodeProvider()

(experimental) The source code provider for this application.

Default: - not connected to a source code provider

builder

@Stability(value=Experimental)
static AppProps.Builder builder()

Returns:

a AppProps.Builder of AppProps