libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront
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.CloudFront.Types.AliasICPRecordal

Description

 
Synopsis

Documentation

data AliasICPRecordal Source #

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

See: newAliasICPRecordal smart constructor.

Constructors

AliasICPRecordal' 

Fields

  • cname :: Maybe Text

    A domain name associated with a distribution.

  • iCPRecordalStatus :: Maybe ICPRecordalStatus

    The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

    The status values returned are the following:

    • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
    • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
    • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

Instances

Instances details
Eq AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

Read AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

Show AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

Generic AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

Associated Types

type Rep AliasICPRecordal :: Type -> Type #

NFData AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

Methods

rnf :: AliasICPRecordal -> () #

Hashable AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

FromXML AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

type Rep AliasICPRecordal Source # 
Instance details

Defined in Amazonka.CloudFront.Types.AliasICPRecordal

type Rep AliasICPRecordal = D1 ('MetaData "AliasICPRecordal" "Amazonka.CloudFront.Types.AliasICPRecordal" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "AliasICPRecordal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iCPRecordalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ICPRecordalStatus))))

newAliasICPRecordal :: AliasICPRecordal Source #

Create a value of AliasICPRecordal 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:cname:AliasICPRecordal', aliasICPRecordal_cname - A domain name associated with a distribution.

$sel:iCPRecordalStatus:AliasICPRecordal', aliasICPRecordal_iCPRecordalStatus - The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

The status values returned are the following:

  • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
  • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
  • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

aliasICPRecordal_cname :: Lens' AliasICPRecordal (Maybe Text) Source #

A domain name associated with a distribution.

aliasICPRecordal_iCPRecordalStatus :: Lens' AliasICPRecordal (Maybe ICPRecordalStatus) Source #

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

The status values returned are the following:

  • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
  • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
  • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.