Interface IAppProps
(experimental) Properties for an App.
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public interface IAppProps
Syntax (vb)
Public Interface IAppProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var amplifyApp = new App(this, "MyApp", new AppProps {
SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
Owner = "<user>",
Repository = "<repo>",
OauthToken = SecretValue.SecretsManager("my-github-token")
}),
AutoBranchCreation = new AutoBranchCreation { // Automatically connect branches that match a pattern set
Patterns = new [] { "feature/*", "test/*" } },
AutoBranchDeletion = true
});
Synopsis
Properties
AppName | (experimental) The name for the application. |
AutoBranchCreation | (experimental) The auto branch creation configuration. |
AutoBranchDeletion | (experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. |
BasicAuth | (experimental) The Basic Auth configuration. |
BuildSpec | (experimental) BuildSpec for the application. |
CustomResponseHeaders | (experimental) The custom HTTP response headers for an Amplify app. |
CustomRules | (experimental) Custom rewrite/redirect rules for the application. |
Description | (experimental) A description for the application. |
EnvironmentVariables | (experimental) Environment variables for the application. |
Role | (experimental) The IAM service role to associate with the application. |
SourceCodeProvider | (experimental) The source code provider for this application. |
Properties
AppName
(experimental) The name for the application.
virtual string AppName { get; }
Property Value
System.String
Remarks
Default: - a CDK generated name
Stability: Experimental
AutoBranchCreation
(experimental) The auto branch creation configuration.
virtual IAutoBranchCreation AutoBranchCreation { get; }
Property Value
Remarks
Use this to automatically create branches that match a certain pattern.
Default: - no auto branch creation
Stability: Experimental
AutoBranchDeletion
(experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
virtual Nullable<bool> AutoBranchDeletion { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
BasicAuth
(experimental) The Basic Auth configuration.
virtual BasicAuth BasicAuth { get; }
Property Value
Remarks
Use this to set password protection at an app level to all your branches.
Default: - no password protection
Stability: Experimental
BuildSpec
(experimental) BuildSpec for the application.
virtual BuildSpec BuildSpec { get; }
Property Value
Remarks
Alternatively, add a amplify.yml
file to the repository.
Default: - no build spec
Stability: Experimental
See: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html
CustomResponseHeaders
(experimental) The custom HTTP response headers for an Amplify app.
virtual ICustomResponseHeader[] CustomResponseHeaders { get; }
Property Value
Remarks
Default: - no custom response headers
Stability: Experimental
See: https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html
CustomRules
(experimental) Custom rewrite/redirect rules for the application.
virtual CustomRule[] CustomRules { get; }
Property Value
Remarks
Default: - no custom rewrite/redirect rules
Stability: Experimental
Description
(experimental) A description for the application.
virtual string Description { get; }
Property Value
System.String
Remarks
Default: - no description
Stability: Experimental
EnvironmentVariables
(experimental) Environment variables for the application.
virtual IDictionary<string, string> EnvironmentVariables { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
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
Stability: Experimental
Role
(experimental) The IAM service role to associate with the application.
virtual IRole Role { get; }
Property Value
Remarks
The App implements IGrantable.
Default: - a new role is created
Stability: Experimental
SourceCodeProvider
(experimental) The source code provider for this application.
virtual ISourceCodeProvider SourceCodeProvider { get; }
Property Value
Remarks
Default: - not connected to a source code provider
Stability: Experimental