Class App

(experimental) An Amplify Console application.

Inheritance

System.Object

Construct

Resource

App

Implements

IApp

IResource

IConstruct

Constructs.IConstruct

IDependable

IGrantable

Inherited Members

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Amplify

Assembly: Amazon.CDK.AWS.Amplify.dll

Syntax (csharp)

public class App : Resource, IApp, IResource, IConstruct, IConstruct, IDependable, IGrantable

Syntax (vb)

Public Class App
    Inherits Resource
    Implements IApp, IResource, IConstruct, IConstruct, IDependable, IGrantable

Remarks

Stability: Experimental

Synopsis

Constructors

App(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
App(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
App(Construct, String, IAppProps)

Properties

AppId	(experimental) The application id.
AppName	(experimental) The name of the application.
Arn	(experimental) The ARN of the application.
DefaultDomain	(experimental) The default domain of the application.
GrantPrincipal	(experimental) The principal to grant permissions to.

Methods

AddAutoBranchEnvironment(String, String)	(experimental) Adds an environment variable to the auto created branch.
AddBranch(String, IBranchOptions)	(experimental) Adds a branch to this application.
AddCustomRule(CustomRule)	(experimental) Adds a custom rewrite/redirect rule to this application.
AddDomain(String, IDomainOptions)	(experimental) Adds a domain to this application.
AddEnvironment(String, String)	(experimental) Adds an environment variable to this application.
FromAppId(Construct, String, String)	(experimental) Import an existing application.

Constructors

App(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected App(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

App(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected App(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

App(Construct, String, IAppProps)

public App(Construct scope, string id, IAppProps props)

Parameters

scope Constructs.Construct
id System.String
props IAppProps

Remarks

Stability: Experimental

Properties

AppId

(experimental) The application id.

public virtual string AppId { get; }

Property Value

System.String

Remarks

Stability: Experimental

AppName

(experimental) The name of the application.

public virtual string AppName { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

Arn

(experimental) The ARN of the application.

public virtual string Arn { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

DefaultDomain

(experimental) The default domain of the application.

public virtual string DefaultDomain { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

GrantPrincipal

(experimental) The principal to grant permissions to.

public virtual IPrincipal GrantPrincipal { get; }

Property Value

IPrincipal

Remarks

Stability: Experimental

Methods

AddAutoBranchEnvironment(String, String)

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

public virtual App AddAutoBranchEnvironment(string name, string value)

Parameters

name System.String
value System.String

Returns

App

Remarks

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

Stability: Experimental

AddBranch(String, IBranchOptions)

(experimental) Adds a branch to this application.

public virtual Branch AddBranch(string id, IBranchOptions options = null)

Parameters

id System.String
options IBranchOptions

Returns

Branch

Remarks

Stability: Experimental

AddCustomRule(CustomRule)

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

public virtual App AddCustomRule(CustomRule rule)

Parameters

rule CustomRule

Returns

App

Remarks

Stability: Experimental

AddDomain(String, IDomainOptions)

(experimental) Adds a domain to this application.

public virtual Domain AddDomain(string id, IDomainOptions options = null)

Parameters

id System.String
options IDomainOptions

Returns

Domain

Remarks

Stability: Experimental

AddEnvironment(String, String)

(experimental) Adds an environment variable to this application.

public virtual App AddEnvironment(string name, string value)

Parameters

name System.String
value System.String

Returns

App

Remarks

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

Stability: Experimental

FromAppId(Construct, String, String)

(experimental) Import an existing application.

public static IApp FromAppId(Construct scope, string id, string appId)

Parameters

scope Constructs.Construct
id System.String
appId System.String

Returns

IApp

Remarks

Stability: Experimental

Implements

IApp

IResource

IConstruct

Constructs.IConstruct

IDependable

IGrantable