software.amazon.awscdk.services.amplify

Interface CfnAppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.601Z")
 @Stability(value=Stable)
public interface CfnAppProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Amplify::App`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .name("name")
         // the properties below are optional
         .accessToken("accessToken")
         .autoBranchCreationConfig(AutoBranchCreationConfigProperty.builder()
                 .autoBranchCreationPatterns(List.of("autoBranchCreationPatterns"))
                 .basicAuthConfig(BasicAuthConfigProperty.builder()
                         .enableBasicAuth(false)
                         .password("password")
                         .username("username")
                         .build())
                 .buildSpec("buildSpec")
                 .enableAutoBranchCreation(false)
                 .enableAutoBuild(false)
                 .enablePerformanceMode(false)
                 .enablePullRequestPreview(false)
                 .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .pullRequestEnvironmentName("pullRequestEnvironmentName")
                 .stage("stage")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .buildSpec("buildSpec")
         .customHeaders("customHeaders")
         .customRules(List.of(CustomRuleProperty.builder()
                 .source("source")
                 .target("target")
                 // the properties below are optional
                 .condition("condition")
                 .status("status")
                 .build()))
         .description("description")
         .enableBranchAutoDeletion(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .iamServiceRole("iamServiceRole")
         .oauthToken("oauthToken")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAppProps.Builder	builder()
default String	getAccessToken() `AWS::Amplify::App.AccessToken`.
default Object	getAutoBranchCreationConfig() `AWS::Amplify::App.AutoBranchCreationConfig`.
default Object	getBasicAuthConfig() `AWS::Amplify::App.BasicAuthConfig`.
default String	getBuildSpec() `AWS::Amplify::App.BuildSpec`.
default String	getCustomHeaders() `AWS::Amplify::App.CustomHeaders`.
default Object	getCustomRules() `AWS::Amplify::App.CustomRules`.
default String	getDescription() `AWS::Amplify::App.Description`.
default Object	getEnableBranchAutoDeletion() `AWS::Amplify::App.EnableBranchAutoDeletion`.
default Object	getEnvironmentVariables() `AWS::Amplify::App.EnvironmentVariables`.
default String	getIamServiceRole() `AWS::Amplify::App.IAMServiceRole`.
String	getName() `AWS::Amplify::App.Name`.
default String	getOauthToken() `AWS::Amplify::App.OauthToken`.
default String	getRepository() `AWS::Amplify::App.Repository`.
default List<CfnTag>	getTags() `AWS::Amplify::App.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessToken

@Stability(value=Stable)
 @Nullable
default String getAccessToken()

`AWS::Amplify::App.AccessToken`.

getAutoBranchCreationConfig

@Stability(value=Stable)
 @Nullable
default Object getAutoBranchCreationConfig()

`AWS::Amplify::App.AutoBranchCreationConfig`.

getBasicAuthConfig

@Stability(value=Stable)
 @Nullable
default Object getBasicAuthConfig()

`AWS::Amplify::App.BasicAuthConfig`.

getBuildSpec

@Stability(value=Stable)
 @Nullable
default String getBuildSpec()

`AWS::Amplify::App.BuildSpec`.

getCustomHeaders

@Stability(value=Stable)
 @Nullable
default String getCustomHeaders()

`AWS::Amplify::App.CustomHeaders`.

getCustomRules

@Stability(value=Stable)
 @Nullable
default Object getCustomRules()

`AWS::Amplify::App.CustomRules`.

getDescription

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

`AWS::Amplify::App.Description`.

getEnableBranchAutoDeletion

@Stability(value=Stable)
 @Nullable
default Object getEnableBranchAutoDeletion()

`AWS::Amplify::App.EnableBranchAutoDeletion`.

getEnvironmentVariables

@Stability(value=Stable)
 @Nullable
default Object getEnvironmentVariables()

`AWS::Amplify::App.EnvironmentVariables`.

getIamServiceRole

@Stability(value=Stable)
 @Nullable
default String getIamServiceRole()

`AWS::Amplify::App.IAMServiceRole`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Amplify::App.Name`.

getOauthToken

@Stability(value=Stable)
 @Nullable
default String getOauthToken()

`AWS::Amplify::App.OauthToken`.

getRepository

@Stability(value=Stable)
 @Nullable
default String getRepository()

`AWS::Amplify::App.Repository`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Amplify::App.Tags`.

builder

@Stability(value=Stable)
static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps