amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.CreateCertificate

Description

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

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

Synopsis

Creating a Request

data CreateCertificate Source #

See: newCreateCertificate smart constructor.

Constructors

CreateCertificate' 

Fields

  • subjectAlternativeNames :: Maybe [Text]

    An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

    You can specify a maximum of nine alternate domains (in addition to the primary domain name).

    Wildcard domain entries (e.g., *.example.com) are not supported.

  • tags :: Maybe [Tag]

    The tag keys and optional values to add to the certificate during create.

    Use the TagResource action to tag a resource after it's created.

  • certificateName :: Text

    The name for the certificate.

  • domainName :: Text

    The domain name (e.g., example.com) for the certificate.

Instances

Instances details
ToJSON CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

ToHeaders CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

ToPath CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

ToQuery CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

AWSRequest CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Associated Types

type AWSResponse CreateCertificate #

Generic CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Associated Types

type Rep CreateCertificate :: Type -> Type #

Read CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Show CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

NFData CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Methods

rnf :: CreateCertificate -> () #

Eq CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Hashable CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

type AWSResponse CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

type Rep CreateCertificate Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

type Rep CreateCertificate = D1 ('MetaData "CreateCertificate" "Amazonka.Lightsail.CreateCertificate" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subjectAlternativeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateCertificate Source #

Create a value of CreateCertificate 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:

CreateCertificate, createCertificate_subjectAlternativeNames - An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com) are not supported.

CreateCertificate, createCertificate_tags - The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it's created.

CreateCertificate, createCertificate_certificateName - The name for the certificate.

CreateCertificate, createCertificate_domainName - The domain name (e.g., example.com) for the certificate.

Request Lenses

createCertificate_subjectAlternativeNames :: Lens' CreateCertificate (Maybe [Text]) Source #

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com) are not supported.

createCertificate_tags :: Lens' CreateCertificate (Maybe [Tag]) Source #

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it's created.

createCertificate_domainName :: Lens' CreateCertificate Text Source #

The domain name (e.g., example.com) for the certificate.

Destructuring the Response

data CreateCertificateResponse Source #

See: newCreateCertificateResponse smart constructor.

Constructors

CreateCertificateResponse' 

Fields

Instances

Instances details
Generic CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Associated Types

type Rep CreateCertificateResponse :: Type -> Type #

Read CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Show CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

NFData CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

Eq CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

type Rep CreateCertificateResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateCertificate

type Rep CreateCertificateResponse = D1 ('MetaData "CreateCertificateResponse" "Amazonka.Lightsail.CreateCertificate" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateCertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateSummary)) :*: (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateCertificateResponse Source #

Create a value of CreateCertificateResponse 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:certificate:CreateCertificateResponse', createCertificateResponse_certificate - An object that describes the certificate created.

$sel:operations:CreateCertificateResponse', createCertificateResponse_operations - An array of objects that describe 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:CreateCertificateResponse', createCertificateResponse_httpStatus - The response's http status code.

Response Lenses

createCertificateResponse_operations :: Lens' CreateCertificateResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.