| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppRunner.AssociateCustomDomain
Description
Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call AssociateCustomDomain and receive a successful
response, use the information in the CustomDomain record that's
returned to add CNAME records to your Domain Name System (DNS). For each
mapped domain name, add a mapping to the target App Runner subdomain and
one or more certificate validation records. App Runner then performs DNS
validation to verify that you own or control the domain name that you
associated. App Runner tracks domain validity in a certificate stored in
AWS Certificate Manager (ACM).
Synopsis
- data AssociateCustomDomain = AssociateCustomDomain' {}
- newAssociateCustomDomain :: Text -> Text -> AssociateCustomDomain
- associateCustomDomain_enableWWWSubdomain :: Lens' AssociateCustomDomain (Maybe Bool)
- associateCustomDomain_serviceArn :: Lens' AssociateCustomDomain Text
- associateCustomDomain_domainName :: Lens' AssociateCustomDomain Text
- data AssociateCustomDomainResponse = AssociateCustomDomainResponse' {}
- newAssociateCustomDomainResponse :: Int -> Text -> Text -> CustomDomain -> AssociateCustomDomainResponse
- associateCustomDomainResponse_httpStatus :: Lens' AssociateCustomDomainResponse Int
- associateCustomDomainResponse_dNSTarget :: Lens' AssociateCustomDomainResponse Text
- associateCustomDomainResponse_serviceArn :: Lens' AssociateCustomDomainResponse Text
- associateCustomDomainResponse_customDomain :: Lens' AssociateCustomDomainResponse CustomDomain
- associateCustomDomainResponse_vpcDNSTargets :: Lens' AssociateCustomDomainResponse [VpcDNSTarget]
Creating a Request
data AssociateCustomDomain Source #
See: newAssociateCustomDomain smart constructor.
Constructors
| AssociateCustomDomain' | |
Fields
| |
Instances
newAssociateCustomDomain Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateCustomDomain |
Create a value of AssociateCustomDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateCustomDomain, associateCustomDomain_enableWWWSubdomain - Set to true to associate the subdomain www.DomainName with
the App Runner service in addition to the base domain.
Default: true
AssociateCustomDomain, associateCustomDomain_serviceArn - The Amazon Resource Name (ARN) of the App Runner service that you want
to associate a custom domain name with.
AssociateCustomDomain, associateCustomDomain_domainName - A custom domain endpoint to associate. Specify a root domain (for
example, example.com), a subdomain (for example, login.example.com
or admin.login.example.com), or a wildcard (for example,
*.example.com).
Request Lenses
associateCustomDomain_enableWWWSubdomain :: Lens' AssociateCustomDomain (Maybe Bool) Source #
Set to true to associate the subdomain www.DomainName with
the App Runner service in addition to the base domain.
Default: true
associateCustomDomain_serviceArn :: Lens' AssociateCustomDomain Text Source #
The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
associateCustomDomain_domainName :: Lens' AssociateCustomDomain Text Source #
A custom domain endpoint to associate. Specify a root domain (for
example, example.com), a subdomain (for example, login.example.com
or admin.login.example.com), or a wildcard (for example,
*.example.com).
Destructuring the Response
data AssociateCustomDomainResponse Source #
See: newAssociateCustomDomainResponse smart constructor.
Constructors
| AssociateCustomDomainResponse' | |
Fields
| |
Instances
newAssociateCustomDomainResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CustomDomain | |
| -> AssociateCustomDomainResponse |
Create a value of AssociateCustomDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateCustomDomainResponse', associateCustomDomainResponse_httpStatus - The response's http status code.
$sel:dNSTarget:AssociateCustomDomainResponse', associateCustomDomainResponse_dNSTarget - The App Runner subdomain of the App Runner service. The custom domain
name is mapped to this target name.
AssociateCustomDomain, associateCustomDomainResponse_serviceArn - The Amazon Resource Name (ARN) of the App Runner service with which a
custom domain name is associated.
$sel:customDomain:AssociateCustomDomainResponse', associateCustomDomainResponse_customDomain - A description of the domain name that's being associated.
$sel:vpcDNSTargets:AssociateCustomDomainResponse', associateCustomDomainResponse_vpcDNSTargets - DNS Target records for the custom domains of this Amazon VPC.
Response Lenses
associateCustomDomainResponse_httpStatus :: Lens' AssociateCustomDomainResponse Int Source #
The response's http status code.
associateCustomDomainResponse_dNSTarget :: Lens' AssociateCustomDomainResponse Text Source #
The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.
associateCustomDomainResponse_serviceArn :: Lens' AssociateCustomDomainResponse Text Source #
The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.
associateCustomDomainResponse_customDomain :: Lens' AssociateCustomDomainResponse CustomDomain Source #
A description of the domain name that's being associated.
associateCustomDomainResponse_vpcDNSTargets :: Lens' AssociateCustomDomainResponse [VpcDNSTarget] Source #
DNS Target records for the custom domains of this Amazon VPC.