Interface DomainAssociation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DomainAssociation.Builder,
,DomainAssociation> SdkBuilder<DomainAssociation.Builder,
,DomainAssociation> SdkPojo
- Enclosing class:
DomainAssociation
-
Method Summary
Modifier and TypeMethodDescriptionautoSubDomainCreationPatterns
(String... autoSubDomainCreationPatterns) Sets branch patterns for automatic subdomain creation.autoSubDomainCreationPatterns
(Collection<String> autoSubDomainCreationPatterns) Sets branch patterns for automatic subdomain creation.autoSubDomainIAMRole
(String autoSubDomainIAMRole) The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.default DomainAssociation.Builder
certificate
(Consumer<Certificate.Builder> certificate) Describes the SSL/TLS certificate for the domain association.certificate
(Certificate certificate) Describes the SSL/TLS certificate for the domain association.certificateVerificationDNSRecord
(String certificateVerificationDNSRecord) The DNS record for certificate verification.domainAssociationArn
(String domainAssociationArn) The Amazon Resource Name (ARN) for the domain association.domainName
(String domainName) The name of the domain.domainStatus
(String domainStatus) The current status of the domain association.domainStatus
(DomainStatus domainStatus) The current status of the domain association.enableAutoSubDomain
(Boolean enableAutoSubDomain) Enables the automated creation of subdomains for branches.statusReason
(String statusReason) Additional information that describes why the domain association is in the current state.subDomains
(Collection<SubDomain> subDomains) The subdomains for the domain association.subDomains
(Consumer<SubDomain.Builder>... subDomains) The subdomains for the domain association.subDomains
(SubDomain... subDomains) The subdomains for the domain association.updateStatus
(String updateStatus) The status of the domain update operation that is currently in progress.updateStatus
(UpdateStatus updateStatus) The status of the domain update operation that is currently in progress.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
domainAssociationArn
The Amazon Resource Name (ARN) for the domain association.
- Parameters:
domainAssociationArn
- The Amazon Resource Name (ARN) for the domain association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainName
The name of the domain.
- Parameters:
domainName
- The name of the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableAutoSubDomain
Enables the automated creation of subdomains for branches.
- Parameters:
enableAutoSubDomain
- Enables the automated creation of subdomains for branches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoSubDomainCreationPatterns
DomainAssociation.Builder autoSubDomainCreationPatterns(Collection<String> autoSubDomainCreationPatterns) Sets branch patterns for automatic subdomain creation.
- Parameters:
autoSubDomainCreationPatterns
- Sets branch patterns for automatic subdomain creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoSubDomainCreationPatterns
Sets branch patterns for automatic subdomain creation.
- Parameters:
autoSubDomainCreationPatterns
- Sets branch patterns for automatic subdomain creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoSubDomainIAMRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
- Parameters:
autoSubDomainIAMRole
- The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainStatus
The current status of the domain association.
- Parameters:
domainStatus
- The current status of the domain association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainStatus
The current status of the domain association.
- Parameters:
domainStatus
- The current status of the domain association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
updateStatus
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.
- Parameters:
updateStatus
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
updateStatus
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.
- Parameters:
updateStatus
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusReason
Additional information that describes why the domain association is in the current state.
- Parameters:
statusReason
- Additional information that describes why the domain association is in the current state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateVerificationDNSRecord
The DNS record for certificate verification.
- Parameters:
certificateVerificationDNSRecord
- The DNS record for certificate verification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subDomains
The subdomains for the domain association.
- Parameters:
subDomains
- The subdomains for the domain association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subDomains
The subdomains for the domain association.
- Parameters:
subDomains
- The subdomains for the domain association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subDomains
The subdomains for the domain association.
This is a convenience method that creates an instance of theSubDomain.Builder
avoiding the need to create one manually viaSubDomain.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosubDomains(List<SubDomain>)
.- Parameters:
subDomains
- a consumer that will call methods onSubDomain.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certificate
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.- Parameters:
certificate
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificate
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,
This is a convenience method that creates an instance of thecertificate
points to the new certificate that is being created instead of the current active certificate. Otherwise,certificate
points to the current active certificate.Certificate.Builder
avoiding the need to create one manually viaCertificate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocertificate(Certificate)
.- Parameters:
certificate
- a consumer that will call methods onCertificate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-