Interface CfnDomainProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.283Z")
@Stability(Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnDomain
.
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") .certificateSettings(CertificateSettingsProperty.builder() .certificateType("certificateType") .customCertificateArn("customCertificateArn") .build()) .enableAutoSubDomain(false) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDomainProps
static final class
An implementation forCfnDomainProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDomainProps.Builder
builder()
getAppId()
The unique ID for an Amplify app.Sets the branch patterns for automatic subdomain creation.default String
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.default Object
The type of SSL/TLS certificate to use for your custom domain.The domain name for the domain association.default Object
Enables the automated creation of subdomains for branches.The setting for the subdomain.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAppId
The unique ID for an Amplify app.- See Also:
-
getDomainName
The domain name for the domain association.- See Also:
-
getSubDomainSettings
The setting for the subdomain.- See Also:
-
getAutoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.- See Also:
-
getAutoSubDomainIamRole
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.- See Also:
-
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.
- See Also:
-
getEnableAutoSubDomain
Enables the automated creation of subdomains for branches.- See Also:
-
builder
- Returns:
- a
CfnDomainProps.Builder
ofCfnDomainProps
-