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

Interface CfnDomainMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.375Z")
@Stability(Stable)
public interface CfnDomainMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDomainPropsMixin.

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.*;
 CfnDomainMixinProps cfnDomainMixinProps = CfnDomainMixinProps.builder()
         .appId("appId")
         .autoSubDomainCreationPatterns(List.of("autoSubDomainCreationPatterns"))
         .autoSubDomainIamRole("autoSubDomainIamRole")
         .certificateSettings(CertificateSettingsProperty.builder()
                 .certificateType("certificateType")
                 .customCertificateArn("customCertificateArn")
                 .build())
         .domainName("domainName")
         .enableAutoSubDomain(false)
         .subDomainSettings(List.of(SubDomainSettingProperty.builder()
                 .branchName("branchName")
                 .prefix("prefix")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainMixinProps.Builder	builder()
default String	getAppId()	The unique ID for an Amplify app.
default List<String>	getAutoSubDomainCreationPatterns()	Sets the branch patterns for automatic subdomain creation.
default Object	getAutoSubDomainIamRole()	The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
default Object	getCertificateSettings()	The type of SSL/TLS certificate to use for your custom domain.
default String	getDomainName()	The domain name for the domain association.
default Object	getEnableAutoSubDomain()	Enables the automated creation of subdomains for branches.
default Object	getSubDomainSettings()	The setting for the subdomain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppId

@Stability(Stable)
@Nullable
default String getAppId()

The unique ID for an Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid

getAutoSubDomainCreationPatterns

@Stability(Stable)
@Nullable
default List<String> getAutoSubDomainCreationPatterns()

Sets the branch patterns for automatic subdomain creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns

getAutoSubDomainIamRole

@Stability(Stable)
@Nullable
default Object getAutoSubDomainIamRole()

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole

getCertificateSettings

@Stability(Stable)
@Nullable
default Object getCertificateSettings()

The type of SSL/TLS certificate to use for your custom domain.

If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

Returns union: either IResolvable or CfnDomainPropsMixin.CertificateSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificatesettings

getDomainName

@Stability(Stable)
@Nullable
default String getDomainName()

The domain name for the domain association.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname

getEnableAutoSubDomain

@Stability(Stable)
@Nullable
default Object getEnableAutoSubDomain()

Enables the automated creation of subdomains for branches.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain

getSubDomainSettings

@Stability(Stable)
@Nullable
default Object getSubDomainSettings()

The setting for the subdomain.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomainPropsMixin.SubDomainSettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings

builder

@Stability(Stable)
static CfnDomainMixinProps.Builder builder()

Returns:

a CfnDomainMixinProps.Builder of CfnDomainMixinProps