software.amazon.awscdk.services.amplify

Class CfnApp

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.amplify.CfnApp

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.599Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .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	Class and Description
static interface	CfnApp.AutoBranchCreationConfigProperty Example:
static interface	CfnApp.BasicAuthConfigProperty Example:
static class	CfnApp.Builder A fluent builder for CfnApp.
static interface	CfnApp.CustomRuleProperty Example:
static interface	CfnApp.EnvironmentVariableProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApp(software.constructs.Construct scope, String id, CfnAppProps props) Create a new `AWS::Amplify::App`.
protected	CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() `AWS::Amplify::App.AccessToken`.
String	getAttrAppId()
String	getAttrAppName()
String	getAttrArn()
String	getAttrDefaultDomain()
Object	getAutoBranchCreationConfig() `AWS::Amplify::App.AutoBranchCreationConfig`.
Object	getBasicAuthConfig() `AWS::Amplify::App.BasicAuthConfig`.
String	getBuildSpec() `AWS::Amplify::App.BuildSpec`.
protected Map<String,Object>	getCfnProperties()
String	getCustomHeaders() `AWS::Amplify::App.CustomHeaders`.
Object	getCustomRules() `AWS::Amplify::App.CustomRules`.
String	getDescription() `AWS::Amplify::App.Description`.
Object	getEnableBranchAutoDeletion() `AWS::Amplify::App.EnableBranchAutoDeletion`.
Object	getEnvironmentVariables() `AWS::Amplify::App.EnvironmentVariables`.
String	getIamServiceRole() `AWS::Amplify::App.IAMServiceRole`.
String	getName() `AWS::Amplify::App.Name`.
String	getOauthToken() `AWS::Amplify::App.OauthToken`.
String	getRepository() `AWS::Amplify::App.Repository`.
TagManager	getTags() `AWS::Amplify::App.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessToken(String value) `AWS::Amplify::App.AccessToken`.
void	setAutoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty value) `AWS::Amplify::App.AutoBranchCreationConfig`.
void	setAutoBranchCreationConfig(IResolvable value) `AWS::Amplify::App.AutoBranchCreationConfig`.
void	setBasicAuthConfig(CfnApp.BasicAuthConfigProperty value) `AWS::Amplify::App.BasicAuthConfig`.
void	setBasicAuthConfig(IResolvable value) `AWS::Amplify::App.BasicAuthConfig`.
void	setBuildSpec(String value) `AWS::Amplify::App.BuildSpec`.
void	setCustomHeaders(String value) `AWS::Amplify::App.CustomHeaders`.
void	setCustomRules(IResolvable value) `AWS::Amplify::App.CustomRules`.
void	setCustomRules(List<Object> value) `AWS::Amplify::App.CustomRules`.
void	setDescription(String value) `AWS::Amplify::App.Description`.
void	setEnableBranchAutoDeletion(Boolean value) `AWS::Amplify::App.EnableBranchAutoDeletion`.
void	setEnableBranchAutoDeletion(IResolvable value) `AWS::Amplify::App.EnableBranchAutoDeletion`.
void	setEnvironmentVariables(IResolvable value) `AWS::Amplify::App.EnvironmentVariables`.
void	setEnvironmentVariables(List<Object> value) `AWS::Amplify::App.EnvironmentVariables`.
void	setIamServiceRole(String value) `AWS::Amplify::App.IAMServiceRole`.
void	setName(String value) `AWS::Amplify::App.Name`.
void	setOauthToken(String value) `AWS::Amplify::App.OauthToken`.
void	setRepository(String value) `AWS::Amplify::App.Repository`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApp

protected CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

CfnApp

protected CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApp

@Stability(value=Stable)
public CfnApp(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnAppProps props)

Create a new `AWS::Amplify::App`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAccessToken

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

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

setAccessToken

@Stability(value=Stable)
public void setAccessToken(@Nullable
                                                    String value)

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

getAttrAppId

@Stability(value=Stable)
 @NotNull
public String getAttrAppId()

getAttrAppName

@Stability(value=Stable)
 @NotNull
public String getAttrAppName()

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrDefaultDomain

@Stability(value=Stable)
 @NotNull
public String getAttrDefaultDomain()

getAutoBranchCreationConfig

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

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

setAutoBranchCreationConfig

@Stability(value=Stable)
public void setAutoBranchCreationConfig(@Nullable
                                                                 CfnApp.AutoBranchCreationConfigProperty value)

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

setAutoBranchCreationConfig

@Stability(value=Stable)
public void setAutoBranchCreationConfig(@Nullable
                                                                 IResolvable value)

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

getBasicAuthConfig

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

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

setBasicAuthConfig

@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        CfnApp.BasicAuthConfigProperty value)

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

setBasicAuthConfig

@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        IResolvable value)

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

getBuildSpec

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

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

setBuildSpec

@Stability(value=Stable)
public void setBuildSpec(@Nullable
                                                  String value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCustomHeaders

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

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

setCustomHeaders

@Stability(value=Stable)
public void setCustomHeaders(@Nullable
                                                      String value)

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

getCustomRules

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

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

setCustomRules

@Stability(value=Stable)
public void setCustomRules(@Nullable
                                                    IResolvable value)

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

setCustomRules

@Stability(value=Stable)
public void setCustomRules(@Nullable
                                                    List<Object> value)

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

getDescription

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

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getEnableBranchAutoDeletion

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

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

setEnableBranchAutoDeletion

@Stability(value=Stable)
public void setEnableBranchAutoDeletion(@Nullable
                                                                 Boolean value)

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

setEnableBranchAutoDeletion

@Stability(value=Stable)
public void setEnableBranchAutoDeletion(@Nullable
                                                                 IResolvable value)

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

getEnvironmentVariables

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

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

setEnvironmentVariables

@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             IResolvable value)

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

setEnvironmentVariables

@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             List<Object> value)

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

getIamServiceRole

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

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

setIamServiceRole

@Stability(value=Stable)
public void setIamServiceRole(@Nullable
                                                       String value)

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

getName

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

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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

getOauthToken

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

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

setOauthToken

@Stability(value=Stable)
public void setOauthToken(@Nullable
                                                   String value)

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

getRepository

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

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

setRepository

@Stability(value=Stable)
public void setRepository(@Nullable
                                                   String value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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