libZSservicesZSamazonka-lightsailZSamazonka-lightsail
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.Lightsail.AttachCertificateToDistribution

Description

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

Synopsis

Creating a Request

data AttachCertificateToDistribution Source #

See: newAttachCertificateToDistribution smart constructor.

Constructors

AttachCertificateToDistribution' 

Fields

  • distributionName :: Text

    The name of the distribution that the certificate will be attached to.

    Use the GetDistributions action to get a list of distribution names that you can specify.

  • certificateName :: Text

    The name of the certificate to attach to a distribution.

    Only certificates with a status of ISSUED can be attached to a distribution.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

Instances

Instances details
Eq AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Read AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Show AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Generic AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Associated Types

type Rep AttachCertificateToDistribution :: Type -> Type #

NFData AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Hashable AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

ToJSON AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

AWSRequest AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

ToHeaders AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

ToPath AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

ToQuery AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

type Rep AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

type Rep AttachCertificateToDistribution = D1 ('MetaData "AttachCertificateToDistribution" "Amazonka.Lightsail.AttachCertificateToDistribution" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "AttachCertificateToDistribution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "distributionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse AttachCertificateToDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

newAttachCertificateToDistribution Source #

Create a value of AttachCertificateToDistribution 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:distributionName:AttachCertificateToDistribution', attachCertificateToDistribution_distributionName - The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

$sel:certificateName:AttachCertificateToDistribution', attachCertificateToDistribution_certificateName - The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

Request Lenses

attachCertificateToDistribution_distributionName :: Lens' AttachCertificateToDistribution Text Source #

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

attachCertificateToDistribution_certificateName :: Lens' AttachCertificateToDistribution Text Source #

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

Destructuring the Response

data AttachCertificateToDistributionResponse Source #

Constructors

AttachCertificateToDistributionResponse' 

Fields

  • operation :: Maybe Operation

    An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Read AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Show AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

Generic AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

NFData AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

type Rep AttachCertificateToDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachCertificateToDistribution

type Rep AttachCertificateToDistributionResponse = D1 ('MetaData "AttachCertificateToDistributionResponse" "Amazonka.Lightsail.AttachCertificateToDistribution" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "AttachCertificateToDistributionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAttachCertificateToDistributionResponse Source #

Create a value of AttachCertificateToDistributionResponse 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:operation:AttachCertificateToDistributionResponse', attachCertificateToDistributionResponse_operation - An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:AttachCertificateToDistributionResponse', attachCertificateToDistributionResponse_httpStatus - The response's http status code.

Response Lenses

attachCertificateToDistributionResponse_operation :: Lens' AttachCertificateToDistributionResponse (Maybe Operation) Source #

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.