Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:55.980Z") @Stability(Stable) public class CfnApp extends CfnResource implements IInspectable, ITaggable
The AWS::Amplify::App resource specifies Apps in Amplify Hosting.

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()))
                 .framework("framework")
                 .pullRequestEnvironmentName("pullRequestEnvironmentName")
                 .stage("stage")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .buildSpec("buildSpec")
         .cacheConfig(CacheConfigProperty.builder()
                 .type("type")
                 .build())
         .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")
         .platform("platform")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApp

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

    • CfnApp

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

    • CfnApp

      @Stability(Stable) public CfnApp(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrAppId()
      Unique Id for the Amplify App.

    • getAttrAppName

      @Stability(Stable) @NotNull public String getAttrAppName()
      Name for the Amplify App.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      ARN for the Amplify App.

    • getAttrDefaultDomain

      @Stability(Stable) @NotNull public String getAttrDefaultDomain()
      Default domain for the Amplify App.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the Amplify app.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the Amplify app.

    • getAccessToken

      @Stability(Stable) @Nullable public String getAccessToken()
      The personal access token for a GitHub repository for an Amplify app.

    • setAccessToken

      @Stability(Stable) public void setAccessToken(@Nullable String value)
      The personal access token for a GitHub repository for an Amplify app.

    • getAutoBranchCreationConfig

      @Stability(Stable) @Nullable public Object getAutoBranchCreationConfig()
      Sets the configuration for your automatic branch creation.

    • setAutoBranchCreationConfig

      @Stability(Stable) public void setAutoBranchCreationConfig(@Nullable IResolvable value)
      Sets the configuration for your automatic branch creation.

    • setAutoBranchCreationConfig

      @Stability(Stable) public void setAutoBranchCreationConfig(@Nullable CfnApp.AutoBranchCreationConfigProperty value)
      Sets the configuration for your automatic branch creation.

    • getBasicAuthConfig

      @Stability(Stable) @Nullable public Object getBasicAuthConfig()
      The credentials for basic authorization for an Amplify app.

    • setBasicAuthConfig

      @Stability(Stable) public void setBasicAuthConfig(@Nullable IResolvable value)
      The credentials for basic authorization for an Amplify app.

    • setBasicAuthConfig

      @Stability(Stable) public void setBasicAuthConfig(@Nullable CfnApp.BasicAuthConfigProperty value)
      The credentials for basic authorization for an Amplify app.

    • getBuildSpec

      @Stability(Stable) @Nullable public String getBuildSpec()
      The build specification (build spec) for an Amplify app.

    • setBuildSpec

      @Stability(Stable) public void setBuildSpec(@Nullable String value)
      The build specification (build spec) for an Amplify app.

    • getCacheConfig

      @Stability(Stable) @Nullable public Object getCacheConfig()
      The cache configuration for the Amplify app.

    • setCacheConfig

      @Stability(Stable) public void setCacheConfig(@Nullable IResolvable value)
      The cache configuration for the Amplify app.

    • setCacheConfig

      @Stability(Stable) public void setCacheConfig(@Nullable CfnApp.CacheConfigProperty value)
      The cache configuration for the Amplify app.

    • getCustomHeaders

      @Stability(Stable) @Nullable public String getCustomHeaders()
      The custom HTTP headers for an Amplify app.

    • setCustomHeaders

      @Stability(Stable) public void setCustomHeaders(@Nullable String value)
      The custom HTTP headers for an Amplify app.

    • getCustomRules

      @Stability(Stable) @Nullable public Object getCustomRules()
      The custom rewrite and redirect rules for an Amplify app.

    • setCustomRules

      @Stability(Stable) public void setCustomRules(@Nullable IResolvable value)
      The custom rewrite and redirect rules for an Amplify app.

    • setCustomRules

      @Stability(Stable) public void setCustomRules(@Nullable List<Object> value)
      The custom rewrite and redirect rules for an Amplify app.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the Amplify app.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the Amplify app.

    • getEnableBranchAutoDeletion

      @Stability(Stable) @Nullable public Object getEnableBranchAutoDeletion()
      Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

    • setEnableBranchAutoDeletion

      @Stability(Stable) public void setEnableBranchAutoDeletion(@Nullable Boolean value)
      Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

    • setEnableBranchAutoDeletion

      @Stability(Stable) public void setEnableBranchAutoDeletion(@Nullable IResolvable value)
      Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

    • getEnvironmentVariables

      @Stability(Stable) @Nullable public Object getEnvironmentVariables()
      The environment variables for the Amplify app.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable IResolvable value)
      The environment variables for the Amplify app.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable List<Object> value)
      The environment variables for the Amplify app.

    • getIamServiceRole

      @Stability(Stable) @Nullable public String getIamServiceRole()
      AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

    • setIamServiceRole

      @Stability(Stable) public void setIamServiceRole(@Nullable String value)
      AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

    • getOauthToken

      @Stability(Stable) @Nullable public String getOauthToken()
      The OAuth token for a third-party source control system for an Amplify app.

    • setOauthToken

      @Stability(Stable) public void setOauthToken(@Nullable String value)
      The OAuth token for a third-party source control system for an Amplify app.

    • getPlatform

      @Stability(Stable) @Nullable public String getPlatform()
      The platform for the Amplify app.

    • setPlatform

      @Stability(Stable) public void setPlatform(@Nullable String value)
      The platform for the Amplify app.

    • getRepository

      @Stability(Stable) @Nullable public String getRepository()
      The Git repository for the Amplify app.

    • setRepository

      @Stability(Stable) public void setRepository(@Nullable String value)
      The Git repository for the Amplify app.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tag for an Amplify app.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tag for an Amplify app.