libZSservicesZSamazonka-apprunnerZSamazonka-apprunner
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data AssociateCustomDomain Source #

See: newAssociateCustomDomain smart constructor.

Constructors

AssociateCustomDomain' 

Fields

  • enableWWWSubdomain :: Maybe Bool

    Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.

    Default: true

  • serviceArn :: Text

    The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

  • domainName :: Text

    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).

Instances

Instances details
Eq AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Read AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Show AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Generic AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Associated Types

type Rep AssociateCustomDomain :: Type -> Type #

NFData AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Methods

rnf :: AssociateCustomDomain -> () #

Hashable AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

ToJSON AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

AWSRequest AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Associated Types

type AWSResponse AssociateCustomDomain #

ToHeaders AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

ToPath AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

ToQuery AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

type Rep AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

type Rep AssociateCustomDomain = D1 ('MetaData "AssociateCustomDomain" "Amazonka.AppRunner.AssociateCustomDomain" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "AssociateCustomDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enableWWWSubdomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse AssociateCustomDomain Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

newAssociateCustomDomain Source #

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:

$sel:enableWWWSubdomain: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

$sel:serviceArn:AssociateCustomDomain', associateCustomDomain_serviceArn - The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

$sel:domainName: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

  • httpStatus :: Int

    The response's http status code.

  • dNSTarget :: Text

    The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

  • serviceArn :: Text

    The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

  • customDomain :: CustomDomain

    A description of the domain name that's being associated.

Instances

Instances details
Eq AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Read AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Show AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Generic AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

Associated Types

type Rep AssociateCustomDomainResponse :: Type -> Type #

NFData AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

type Rep AssociateCustomDomainResponse Source # 
Instance details

Defined in Amazonka.AppRunner.AssociateCustomDomain

type Rep AssociateCustomDomainResponse = D1 ('MetaData "AssociateCustomDomainResponse" "Amazonka.AppRunner.AssociateCustomDomain" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "AssociateCustomDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "dNSTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "customDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomDomain))))

newAssociateCustomDomainResponse Source #

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.

$sel:serviceArn: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.

Response Lenses

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.