Interface CfnDomainProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:42.127Z")
@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") .enableAutoSubDomain(false) .build();
-
Nested Class Summary
Modifier 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 (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.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.Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
-
getDomainName
The domain name for the domain association.Length Constraints: Maximum length of 255.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(.)?$
-
getSubDomainSettings
The setting for the subdomain. -
getAutoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation. -
getAutoSubDomainIamRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
-
getEnableAutoSubDomain
Enables the automated creation of subdomains for branches. -
builder
- Returns:
- a
CfnDomainProps.Builder
ofCfnDomainProps
-