Interface CfnDomainProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)",
date="2024-03-26T18:09:18.664Z")
@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") .certificate(CertificateProperty.builder() .certificateArn("certificateArn") .certificateType("certificateType") .certificateVerificationDnsRecord("certificateVerificationDnsRecord") .build()) .certificateSettings(CertificateSettingsProperty.builder() .certificateType("certificateType") .customCertificateArn("customCertificateArn") .build()) .enableAutoSubDomain(false) .updateStatus("updateStatus") .build();
- See Also:
-
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 (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.default Object
Describes the SSL/TLS certificate for the domain association.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.default String
The status of the domain update operation that is currently in progress.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:
-
getCertificate
Describes the SSL/TLS certificate for the domain association.This can be your own custom certificate or the default certificate that Amplify provisions for you.
If you are updating your domain to use a different certificate,
Certificate
points to the new certificate that is being created instead of the current active certificate. Otherwise,Certificate
points to the current active certificate.- 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:
-
getUpdateStatus
The status of the domain update operation that is currently in progress.The following list describes the valid update states.
- REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
- PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
- IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
- PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
- AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on RouteĀ 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
- UPDATE_COMPLETE - The certificate has been associated with a domain.
- UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
- See Also:
-
builder
- Returns:
- a
CfnDomainProps.Builder
ofCfnDomainProps
-