CfnApp (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.013Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Amplify::App`.

The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

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` Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
`static interface`	`CfnApp.BasicAuthConfigProperty` Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
`static class`	`CfnApp.Builder` A fluent builder for `CfnApp`.
`static interface`	`CfnApp.CustomRuleProperty` The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
`static interface`	`CfnApp.EnvironmentVariableProperty` Environment variables are key-value pairs that are available at build time.

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.

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccessToken()` The personal access token for a GitHub repository for an Amplify app.
`String`	`getAttrAppId()` Unique Id for the Amplify App.
`String`	`getAttrAppName()` Name for the Amplify App.
`String`	`getAttrArn()` ARN for the Amplify App.
`String`	`getAttrDefaultDomain()` Default domain for the Amplify App.
`Object`	`getAutoBranchCreationConfig()` Sets the configuration for your automatic branch creation.
`Object`	`getBasicAuthConfig()` The credentials for basic authorization for an Amplify app.
`String`	`getBuildSpec()` The build specification (build spec) for an Amplify app.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getCustomHeaders()` The custom HTTP headers for an Amplify app.
`Object`	`getCustomRules()` The custom rewrite and redirect rules for an Amplify app.
`String`	`getDescription()` The description for an Amplify app.
`Object`	`getEnableBranchAutoDeletion()` Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
`Object`	`getEnvironmentVariables()` The environment variables map for an Amplify app.
`String`	`getIamServiceRole()` The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
`String`	`getName()` The name for an Amplify app.
`String`	`getOauthToken()` The OAuth token for a third-party source control system for an Amplify app.
`String`	`getRepository()` The repository for an Amplify app.
`TagManager`	`getTags()` The tag for an Amplify app.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAccessToken(String value)` The personal access token for a GitHub repository for an Amplify app.
`void`	`setAutoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty value)` Sets the configuration for your automatic branch creation.
`void`	`setAutoBranchCreationConfig(IResolvable value)` Sets the configuration for your automatic branch creation.
`void`	`setBasicAuthConfig(CfnApp.BasicAuthConfigProperty value)` The credentials for basic authorization for an Amplify app.
`void`	`setBasicAuthConfig(IResolvable value)` The credentials for basic authorization for an Amplify app.
`void`	`setBuildSpec(String value)` The build specification (build spec) for an Amplify app.
`void`	`setCustomHeaders(String value)` The custom HTTP headers for an Amplify app.
`void`	`setCustomRules(IResolvable value)` The custom rewrite and redirect rules for an Amplify app.
`void`	`setCustomRules(List<Object> value)` The custom rewrite and redirect rules for an Amplify app.
`void`	`setDescription(String value)` The description for an Amplify app.
`void`	`setEnableBranchAutoDeletion(Boolean value)` Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
`void`	`setEnableBranchAutoDeletion(IResolvable value)` Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
`void`	`setEnvironmentVariables(IResolvable value)` The environment variables map for an Amplify app.
`void`	`setEnvironmentVariables(List<Object> value)` The environment variables map for an Amplify app.
`void`	`setIamServiceRole(String value)` The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
`void`	`setName(String value)` The name for an Amplify app.
`void`	`setOauthToken(String value)` The OAuth token for a third-party source control system for an Amplify app.
`void`	`setRepository(String value)` The repository for an Amplify app.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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.
  - getAttrAppId
```
@Stability(value=Stable)
 @NotNull
public String getAttrAppId()
```
    Unique Id for the Amplify App.
  - getAttrAppName
```
@Stability(value=Stable)
 @NotNull
public String getAttrAppName()
```
    Name for the Amplify App.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    ARN for the Amplify App.
  - getAttrDefaultDomain
```
@Stability(value=Stable)
 @NotNull
public String getAttrDefaultDomain()
```
    Default domain for the Amplify App.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    The tag for an Amplify app.
  - getName
```
@Stability(value=Stable)
 @NotNull
public String getName()
```
    The name for an Amplify app.
    Length Constraints: Minimum length of 1. Maximum length of 255.
    Pattern: (?s).+
  - setName
```
@Stability(value=Stable)
public void setName(@NotNull
                                             String value)
```
    The name for an Amplify app.
    Length Constraints: Minimum length of 1. Maximum length of 255.
    Pattern: (?s).+
  - getAccessToken
```
@Stability(value=Stable)
 @Nullable
public String getAccessToken()
```
    The personal access token for a GitHub repository for an Amplify app.
    The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
    Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .
    You must specify either AccessToken or OauthToken when you create a new app.
    Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    Length Constraints: Minimum length of 1. Maximum length of 255.
  - setAccessToken
```
@Stability(value=Stable)
public void setAccessToken(@Nullable
                                                    String value)
```
    The personal access token for a GitHub repository for an Amplify app.
    The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
    Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .
    You must specify either AccessToken or OauthToken when you create a new app.
    Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    Length Constraints: Minimum length of 1. Maximum length of 255.
  - getAutoBranchCreationConfig
```
@Stability(value=Stable)
 @Nullable
public Object getAutoBranchCreationConfig()
```
    Sets the configuration for your automatic branch creation.
  - setAutoBranchCreationConfig
```
@Stability(value=Stable)
public void setAutoBranchCreationConfig(@Nullable
                                                                 CfnApp.AutoBranchCreationConfigProperty value)
```
    Sets the configuration for your automatic branch creation.
  - setAutoBranchCreationConfig
```
@Stability(value=Stable)
public void setAutoBranchCreationConfig(@Nullable
                                                                 IResolvable value)
```
    Sets the configuration for your automatic branch creation.
  - getBasicAuthConfig
```
@Stability(value=Stable)
 @Nullable
public Object getBasicAuthConfig()
```
    The credentials for basic authorization for an Amplify app.
    You must base64-encode the authorization credentials and provide them in the format user:password .
  - setBasicAuthConfig
```
@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        CfnApp.BasicAuthConfigProperty value)
```
    The credentials for basic authorization for an Amplify app.
    You must base64-encode the authorization credentials and provide them in the format user:password .
  - setBasicAuthConfig
```
@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        IResolvable value)
```
    The credentials for basic authorization for an Amplify app.
    You must base64-encode the authorization credentials and provide them in the format user:password .
  - getBuildSpec
```
@Stability(value=Stable)
 @Nullable
public String getBuildSpec()
```
    The build specification (build spec) for an Amplify app.
    Length Constraints: Minimum length of 1. Maximum length of 25000.
    Pattern: (?s).+
  - setBuildSpec
```
@Stability(value=Stable)
public void setBuildSpec(@Nullable
                                                  String value)
```
    The build specification (build spec) for an Amplify app.
    Length Constraints: Minimum length of 1. Maximum length of 25000.
    Pattern: (?s).+
  - getCustomHeaders
```
@Stability(value=Stable)
 @Nullable
public String getCustomHeaders()
```
    The custom HTTP headers for an Amplify app.
    Length Constraints: Minimum length of 0. Maximum length of 25000.
    Pattern: (?s).*
  - setCustomHeaders
```
@Stability(value=Stable)
public void setCustomHeaders(@Nullable
                                                      String value)
```
    The custom HTTP headers for an Amplify app.
    Length Constraints: Minimum length of 0. Maximum length of 25000.
    Pattern: (?s).*
  - getCustomRules
```
@Stability(value=Stable)
 @Nullable
public Object getCustomRules()
```
    The custom rewrite and redirect rules for an Amplify app.
  - setCustomRules
```
@Stability(value=Stable)
public void setCustomRules(@Nullable
                                                    IResolvable value)
```
    The custom rewrite and redirect rules for an Amplify app.
  - setCustomRules
```
@Stability(value=Stable)
public void setCustomRules(@Nullable
                                                    List<Object> value)
```
    The custom rewrite and redirect rules for an Amplify app.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    The description for an Amplify app.
    Length Constraints: Maximum length of 1000.
    Pattern: (?s).*
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    The description for an Amplify app.
    Length Constraints: Maximum length of 1000.
    Pattern: (?s).*
  - getEnableBranchAutoDeletion
```
@Stability(value=Stable)
 @Nullable
public Object getEnableBranchAutoDeletion()
```
    Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
  - setEnableBranchAutoDeletion
```
@Stability(value=Stable)
public void setEnableBranchAutoDeletion(@Nullable
                                                                 Boolean value)
```
    Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
  - setEnableBranchAutoDeletion
```
@Stability(value=Stable)
public void setEnableBranchAutoDeletion(@Nullable
                                                                 IResolvable value)
```
    Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
  - getEnvironmentVariables
```
@Stability(value=Stable)
 @Nullable
public Object getEnvironmentVariables()
```
    The environment variables map for an Amplify app.
  - setEnvironmentVariables
```
@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             IResolvable value)
```
    The environment variables map for an Amplify app.
  - setEnvironmentVariables
```
@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             List<Object> value)
```
    The environment variables map for an Amplify app.
  - getIamServiceRole
```
@Stability(value=Stable)
 @Nullable
public String getIamServiceRole()
```
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
    Length Constraints: Minimum length of 0. Maximum length of 1000.
    Pattern: (?s).*
  - setIamServiceRole
```
@Stability(value=Stable)
public void setIamServiceRole(@Nullable
                                                       String value)
```
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
    Length Constraints: Minimum length of 0. Maximum length of 1000.
    Pattern: (?s).*
  - getOauthToken
```
@Stability(value=Stable)
 @Nullable
public String getOauthToken()
```
    The OAuth token for a third-party source control system for an Amplify app.
    The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
    Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .
    You must specify either OauthToken or AccessToken when you create a new app.
    Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    Length Constraints: Maximum length of 1000.
    Pattern: (?s).*
  - setOauthToken
```
@Stability(value=Stable)
public void setOauthToken(@Nullable
                                                   String value)
```
    The OAuth token for a third-party source control system for an Amplify app.
    The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
    Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .
    You must specify either OauthToken or AccessToken when you create a new app.
    Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    Length Constraints: Maximum length of 1000.
    Pattern: (?s).*
  - getRepository
```
@Stability(value=Stable)
 @Nullable
public String getRepository()
```
    The repository for an Amplify app.
    Pattern: (?s).*
  - setRepository
```
@Stability(value=Stable)
public void setRepository(@Nullable
                                                   String value)
```
    The repository for an Amplify app.
    Pattern: (?s).*

Class CfnApp

Nested Class Summary

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

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnApp

CfnApp

CfnApp

Method Detail

inspect

renderProperties

getAttrAppId

getAttrAppName

getAttrArn

getAttrDefaultDomain

getCfnProperties

getTags

getName

setName

getAccessToken

setAccessToken

getAutoBranchCreationConfig

setAutoBranchCreationConfig

setAutoBranchCreationConfig

getBasicAuthConfig

setBasicAuthConfig

setBasicAuthConfig

getBuildSpec

setBuildSpec

getCustomHeaders

setCustomHeaders

getCustomRules

setCustomRules

setCustomRules

getDescription

setDescription

getEnableBranchAutoDeletion

setEnableBranchAutoDeletion

setEnableBranchAutoDeletion

getEnvironmentVariables

setEnvironmentVariables

setEnvironmentVariables

getIamServiceRole

setIamServiceRole

getOauthToken

setOauthToken

getRepository

setRepository