software.amazon.awscdk.services.amplify

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.717Z")
 @Stability(value=Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Amplify::Domain`.

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.*;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .appId("appId")
         .domainName("domainName")
         .subDomainSettings(List.of(SubDomainSettingProperty.builder()
                 .branchName("branchName")
                 .prefix("prefix")
                 .build()))
         // the properties below are optional
         .autoSubDomainCreationPatterns(List.of("autoSubDomainCreationPatterns"))
         .autoSubDomainIamRole("autoSubDomainIamRole")
         .enableAutoSubDomain(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomainProps.Builder	builder()
String	getAppId() `AWS::Amplify::Domain.AppId`.
default List<String>	getAutoSubDomainCreationPatterns() `AWS::Amplify::Domain.AutoSubDomainCreationPatterns`.
default String	getAutoSubDomainIamRole() `AWS::Amplify::Domain.AutoSubDomainIAMRole`.
String	getDomainName() `AWS::Amplify::Domain.DomainName`.
default Object	getEnableAutoSubDomain() `AWS::Amplify::Domain.EnableAutoSubDomain`.
Object	getSubDomainSettings() `AWS::Amplify::Domain.SubDomainSettings`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAppId

@Stability(value=Stable)
 @NotNull
String getAppId()

`AWS::Amplify::Domain.AppId`.

getAutoSubDomainCreationPatterns

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

`AWS::Amplify::Domain.AutoSubDomainCreationPatterns`.

getAutoSubDomainIamRole

@Stability(value=Stable)
 @Nullable
default String getAutoSubDomainIamRole()

`AWS::Amplify::Domain.AutoSubDomainIAMRole`.

getDomainName

@Stability(value=Stable)
 @NotNull
String getDomainName()

`AWS::Amplify::Domain.DomainName`.

getEnableAutoSubDomain

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

`AWS::Amplify::Domain.EnableAutoSubDomain`.

getSubDomainSettings

@Stability(value=Stable)
 @NotNull
Object getSubDomainSettings()

`AWS::Amplify::Domain.SubDomainSettings`.

builder

@Stability(value=Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps