Package software.amazon.awscdk.cfnpropertymixins.services.amplify

Class CfnAppPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnAppPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.366Z")
@Stability(Stable)
public class CfnAppPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.amplify.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAppPropsMixin cfnAppPropsMixin = CfnAppPropsMixin.Builder.create(CfnAppMixinProps.builder()
         .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())
         .computeRoleArn("computeRoleArn")
         .customHeaders("customHeaders")
         .customRules(List.of(CustomRuleProperty.builder()
                 .condition("condition")
                 .source("source")
                 .status("status")
                 .target("target")
                 .build()))
         .description("description")
         .enableBranchAutoDeletion(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .iamServiceRole("iamServiceRole")
         .jobConfig(JobConfigProperty.builder()
                 .buildComputeType("buildComputeType")
                 .build())
         .name("name")
         .oauthToken("oauthToken")
         .platform("platform")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAppPropsMixin.AutoBranchCreationConfigProperty	Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
static interface	CfnAppPropsMixin.BasicAuthConfigProperty	Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
static final class	CfnAppPropsMixin.Builder	A fluent builder for CfnAppPropsMixin.
static interface	CfnAppPropsMixin.CacheConfigProperty	Describes the cache configuration for an Amplify app.
static interface	CfnAppPropsMixin.CustomRuleProperty	The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
static interface	CfnAppPropsMixin.EnvironmentVariableProperty	Environment variables are key-value pairs that are available at build time.
static interface	CfnAppPropsMixin.JobConfigProperty	Describes the configuration details that apply to the jobs for an Amplify app.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAppPropsMixin(CfnAppMixinProps props)	Create a mixin to apply properties to AWS::Amplify::App.
	CfnAppPropsMixin(CfnAppMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Amplify::App.
protected	CfnAppPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAppPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAppMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAppPropsMixin

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

CfnAppPropsMixin

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

CfnAppPropsMixin

@Stability(Stable)
public CfnAppPropsMixin(@NotNull
 CfnAppMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Amplify::App.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAppPropsMixin

@Stability(Stable)
public CfnAppPropsMixin(@NotNull
 CfnAppMixinProps props)

Create a mixin to apply properties to AWS::Amplify::App.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAppMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()