amazonka-cloudfront-2.0: gen/Amazonka/CloudFront/Types/DistributionSummary.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.CloudFront.Types.DistributionSummary
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.CloudFront.Types.DistributionSummary where
import Amazonka.CloudFront.Types.AliasICPRecordal
import Amazonka.CloudFront.Types.Aliases
import Amazonka.CloudFront.Types.CacheBehaviors
import Amazonka.CloudFront.Types.CustomErrorResponses
import Amazonka.CloudFront.Types.DefaultCacheBehavior
import Amazonka.CloudFront.Types.HttpVersion
import Amazonka.CloudFront.Types.OriginGroups
import Amazonka.CloudFront.Types.Origins
import Amazonka.CloudFront.Types.PriceClass
import Amazonka.CloudFront.Types.Restrictions
import Amazonka.CloudFront.Types.ViewerCertificate
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
-- | A summary of the information about a CloudFront distribution.
--
-- /See:/ 'newDistributionSummary' smart constructor.
data DistributionSummary = DistributionSummary'
{ -- | 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.
--
-- For more information about ICP recordals, see
-- <https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html Signup, Accounts, and Credentials>
-- in /Getting Started with Amazon Web Services services in China/.
aliasICPRecordals :: Prelude.Maybe [AliasICPRecordal],
-- | A complex type that contains information about origin groups for this
-- distribution.
originGroups :: Prelude.Maybe OriginGroups,
-- | The identifier for the distribution. For example: @EDFDVBD632BHDS5@.
id :: Prelude.Text,
-- | The ARN (Amazon Resource Name) for the distribution. For example:
-- @arn:aws:cloudfront::123456789012:distribution\/EDFDVBD632BHDS5@, where
-- @123456789012@ is your Amazon Web Services account ID.
arn :: Prelude.Text,
-- | The current status of the distribution. When the status is @Deployed@,
-- the distribution\'s information is propagated to all CloudFront edge
-- locations.
status :: Prelude.Text,
-- | The date and time the distribution was last modified.
lastModifiedTime :: Data.ISO8601,
-- | The domain name that corresponds to the distribution, for example,
-- @d111111abcdef8.cloudfront.net@.
domainName :: Prelude.Text,
-- | A complex type that contains information about CNAMEs (alternate domain
-- names), if any, for this distribution.
aliases :: Aliases,
-- | A complex type that contains information about origins for this
-- distribution.
origins :: Origins,
-- | A complex type that describes the default cache behavior if you don\'t
-- specify a @CacheBehavior@ element or if files don\'t match any of the
-- values of @PathPattern@ in @CacheBehavior@ elements. You must create
-- exactly one default cache behavior.
defaultCacheBehavior :: DefaultCacheBehavior,
-- | A complex type that contains zero or more @CacheBehavior@ elements.
cacheBehaviors :: CacheBehaviors,
-- | A complex type that contains zero or more @CustomErrorResponses@
-- elements.
customErrorResponses :: CustomErrorResponses,
-- | The comment originally specified when this distribution was created.
comment :: Prelude.Text,
-- | A complex type that contains information about price class for this
-- streaming distribution.
priceClass :: PriceClass,
-- | Whether the distribution is enabled to accept user requests for content.
enabled :: Prelude.Bool,
-- | A complex type that determines the distribution\'s SSL\/TLS
-- configuration for communicating with viewers.
viewerCertificate :: ViewerCertificate,
-- | A complex type that identifies ways in which you want to restrict
-- distribution of your content.
restrictions :: Restrictions,
-- | The Web ACL Id (if any) associated with the distribution.
webACLId :: Prelude.Text,
-- | Specify the maximum HTTP version that you want viewers to use to
-- communicate with CloudFront. The default value for new web distributions
-- is @http2@. Viewers that don\'t support @HTTP\/2@ will automatically use
-- an earlier version.
httpVersion :: HttpVersion,
-- | Whether CloudFront responds to IPv6 DNS requests with an IPv6 address
-- for your distribution.
isIPV6Enabled :: Prelude.Bool,
-- | Whether the primary distribution has a staging distribution enabled.
staging :: Prelude.Bool
}
deriving (Prelude.Eq, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DistributionSummary' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'aliasICPRecordals', 'distributionSummary_aliasICPRecordals' - 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.
--
-- For more information about ICP recordals, see
-- <https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html Signup, Accounts, and Credentials>
-- in /Getting Started with Amazon Web Services services in China/.
--
-- 'originGroups', 'distributionSummary_originGroups' - A complex type that contains information about origin groups for this
-- distribution.
--
-- 'id', 'distributionSummary_id' - The identifier for the distribution. For example: @EDFDVBD632BHDS5@.
--
-- 'arn', 'distributionSummary_arn' - The ARN (Amazon Resource Name) for the distribution. For example:
-- @arn:aws:cloudfront::123456789012:distribution\/EDFDVBD632BHDS5@, where
-- @123456789012@ is your Amazon Web Services account ID.
--
-- 'status', 'distributionSummary_status' - The current status of the distribution. When the status is @Deployed@,
-- the distribution\'s information is propagated to all CloudFront edge
-- locations.
--
-- 'lastModifiedTime', 'distributionSummary_lastModifiedTime' - The date and time the distribution was last modified.
--
-- 'domainName', 'distributionSummary_domainName' - The domain name that corresponds to the distribution, for example,
-- @d111111abcdef8.cloudfront.net@.
--
-- 'aliases', 'distributionSummary_aliases' - A complex type that contains information about CNAMEs (alternate domain
-- names), if any, for this distribution.
--
-- 'origins', 'distributionSummary_origins' - A complex type that contains information about origins for this
-- distribution.
--
-- 'defaultCacheBehavior', 'distributionSummary_defaultCacheBehavior' - A complex type that describes the default cache behavior if you don\'t
-- specify a @CacheBehavior@ element or if files don\'t match any of the
-- values of @PathPattern@ in @CacheBehavior@ elements. You must create
-- exactly one default cache behavior.
--
-- 'cacheBehaviors', 'distributionSummary_cacheBehaviors' - A complex type that contains zero or more @CacheBehavior@ elements.
--
-- 'customErrorResponses', 'distributionSummary_customErrorResponses' - A complex type that contains zero or more @CustomErrorResponses@
-- elements.
--
-- 'comment', 'distributionSummary_comment' - The comment originally specified when this distribution was created.
--
-- 'priceClass', 'distributionSummary_priceClass' - A complex type that contains information about price class for this
-- streaming distribution.
--
-- 'enabled', 'distributionSummary_enabled' - Whether the distribution is enabled to accept user requests for content.
--
-- 'viewerCertificate', 'distributionSummary_viewerCertificate' - A complex type that determines the distribution\'s SSL\/TLS
-- configuration for communicating with viewers.
--
-- 'restrictions', 'distributionSummary_restrictions' - A complex type that identifies ways in which you want to restrict
-- distribution of your content.
--
-- 'webACLId', 'distributionSummary_webACLId' - The Web ACL Id (if any) associated with the distribution.
--
-- 'httpVersion', 'distributionSummary_httpVersion' - Specify the maximum HTTP version that you want viewers to use to
-- communicate with CloudFront. The default value for new web distributions
-- is @http2@. Viewers that don\'t support @HTTP\/2@ will automatically use
-- an earlier version.
--
-- 'isIPV6Enabled', 'distributionSummary_isIPV6Enabled' - Whether CloudFront responds to IPv6 DNS requests with an IPv6 address
-- for your distribution.
--
-- 'staging', 'distributionSummary_staging' - Whether the primary distribution has a staging distribution enabled.
newDistributionSummary ::
-- | 'id'
Prelude.Text ->
-- | 'arn'
Prelude.Text ->
-- | 'status'
Prelude.Text ->
-- | 'lastModifiedTime'
Prelude.UTCTime ->
-- | 'domainName'
Prelude.Text ->
-- | 'aliases'
Aliases ->
-- | 'origins'
Origins ->
-- | 'defaultCacheBehavior'
DefaultCacheBehavior ->
-- | 'cacheBehaviors'
CacheBehaviors ->
-- | 'customErrorResponses'
CustomErrorResponses ->
-- | 'comment'
Prelude.Text ->
-- | 'priceClass'
PriceClass ->
-- | 'enabled'
Prelude.Bool ->
-- | 'viewerCertificate'
ViewerCertificate ->
-- | 'restrictions'
Restrictions ->
-- | 'webACLId'
Prelude.Text ->
-- | 'httpVersion'
HttpVersion ->
-- | 'isIPV6Enabled'
Prelude.Bool ->
-- | 'staging'
Prelude.Bool ->
DistributionSummary
newDistributionSummary
pId_
pARN_
pStatus_
pLastModifiedTime_
pDomainName_
pAliases_
pOrigins_
pDefaultCacheBehavior_
pCacheBehaviors_
pCustomErrorResponses_
pComment_
pPriceClass_
pEnabled_
pViewerCertificate_
pRestrictions_
pWebACLId_
pHttpVersion_
pIsIPV6Enabled_
pStaging_ =
DistributionSummary'
{ aliasICPRecordals =
Prelude.Nothing,
originGroups = Prelude.Nothing,
id = pId_,
arn = pARN_,
status = pStatus_,
lastModifiedTime =
Data._Time Lens.# pLastModifiedTime_,
domainName = pDomainName_,
aliases = pAliases_,
origins = pOrigins_,
defaultCacheBehavior = pDefaultCacheBehavior_,
cacheBehaviors = pCacheBehaviors_,
customErrorResponses = pCustomErrorResponses_,
comment = pComment_,
priceClass = pPriceClass_,
enabled = pEnabled_,
viewerCertificate = pViewerCertificate_,
restrictions = pRestrictions_,
webACLId = pWebACLId_,
httpVersion = pHttpVersion_,
isIPV6Enabled = pIsIPV6Enabled_,
staging = pStaging_
}
-- | 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.
--
-- For more information about ICP recordals, see
-- <https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html Signup, Accounts, and Credentials>
-- in /Getting Started with Amazon Web Services services in China/.
distributionSummary_aliasICPRecordals :: Lens.Lens' DistributionSummary (Prelude.Maybe [AliasICPRecordal])
distributionSummary_aliasICPRecordals = Lens.lens (\DistributionSummary' {aliasICPRecordals} -> aliasICPRecordals) (\s@DistributionSummary' {} a -> s {aliasICPRecordals = a} :: DistributionSummary) Prelude.. Lens.mapping Lens.coerced
-- | A complex type that contains information about origin groups for this
-- distribution.
distributionSummary_originGroups :: Lens.Lens' DistributionSummary (Prelude.Maybe OriginGroups)
distributionSummary_originGroups = Lens.lens (\DistributionSummary' {originGroups} -> originGroups) (\s@DistributionSummary' {} a -> s {originGroups = a} :: DistributionSummary)
-- | The identifier for the distribution. For example: @EDFDVBD632BHDS5@.
distributionSummary_id :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_id = Lens.lens (\DistributionSummary' {id} -> id) (\s@DistributionSummary' {} a -> s {id = a} :: DistributionSummary)
-- | The ARN (Amazon Resource Name) for the distribution. For example:
-- @arn:aws:cloudfront::123456789012:distribution\/EDFDVBD632BHDS5@, where
-- @123456789012@ is your Amazon Web Services account ID.
distributionSummary_arn :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_arn = Lens.lens (\DistributionSummary' {arn} -> arn) (\s@DistributionSummary' {} a -> s {arn = a} :: DistributionSummary)
-- | The current status of the distribution. When the status is @Deployed@,
-- the distribution\'s information is propagated to all CloudFront edge
-- locations.
distributionSummary_status :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_status = Lens.lens (\DistributionSummary' {status} -> status) (\s@DistributionSummary' {} a -> s {status = a} :: DistributionSummary)
-- | The date and time the distribution was last modified.
distributionSummary_lastModifiedTime :: Lens.Lens' DistributionSummary Prelude.UTCTime
distributionSummary_lastModifiedTime = Lens.lens (\DistributionSummary' {lastModifiedTime} -> lastModifiedTime) (\s@DistributionSummary' {} a -> s {lastModifiedTime = a} :: DistributionSummary) Prelude.. Data._Time
-- | The domain name that corresponds to the distribution, for example,
-- @d111111abcdef8.cloudfront.net@.
distributionSummary_domainName :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_domainName = Lens.lens (\DistributionSummary' {domainName} -> domainName) (\s@DistributionSummary' {} a -> s {domainName = a} :: DistributionSummary)
-- | A complex type that contains information about CNAMEs (alternate domain
-- names), if any, for this distribution.
distributionSummary_aliases :: Lens.Lens' DistributionSummary Aliases
distributionSummary_aliases = Lens.lens (\DistributionSummary' {aliases} -> aliases) (\s@DistributionSummary' {} a -> s {aliases = a} :: DistributionSummary)
-- | A complex type that contains information about origins for this
-- distribution.
distributionSummary_origins :: Lens.Lens' DistributionSummary Origins
distributionSummary_origins = Lens.lens (\DistributionSummary' {origins} -> origins) (\s@DistributionSummary' {} a -> s {origins = a} :: DistributionSummary)
-- | A complex type that describes the default cache behavior if you don\'t
-- specify a @CacheBehavior@ element or if files don\'t match any of the
-- values of @PathPattern@ in @CacheBehavior@ elements. You must create
-- exactly one default cache behavior.
distributionSummary_defaultCacheBehavior :: Lens.Lens' DistributionSummary DefaultCacheBehavior
distributionSummary_defaultCacheBehavior = Lens.lens (\DistributionSummary' {defaultCacheBehavior} -> defaultCacheBehavior) (\s@DistributionSummary' {} a -> s {defaultCacheBehavior = a} :: DistributionSummary)
-- | A complex type that contains zero or more @CacheBehavior@ elements.
distributionSummary_cacheBehaviors :: Lens.Lens' DistributionSummary CacheBehaviors
distributionSummary_cacheBehaviors = Lens.lens (\DistributionSummary' {cacheBehaviors} -> cacheBehaviors) (\s@DistributionSummary' {} a -> s {cacheBehaviors = a} :: DistributionSummary)
-- | A complex type that contains zero or more @CustomErrorResponses@
-- elements.
distributionSummary_customErrorResponses :: Lens.Lens' DistributionSummary CustomErrorResponses
distributionSummary_customErrorResponses = Lens.lens (\DistributionSummary' {customErrorResponses} -> customErrorResponses) (\s@DistributionSummary' {} a -> s {customErrorResponses = a} :: DistributionSummary)
-- | The comment originally specified when this distribution was created.
distributionSummary_comment :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_comment = Lens.lens (\DistributionSummary' {comment} -> comment) (\s@DistributionSummary' {} a -> s {comment = a} :: DistributionSummary)
-- | A complex type that contains information about price class for this
-- streaming distribution.
distributionSummary_priceClass :: Lens.Lens' DistributionSummary PriceClass
distributionSummary_priceClass = Lens.lens (\DistributionSummary' {priceClass} -> priceClass) (\s@DistributionSummary' {} a -> s {priceClass = a} :: DistributionSummary)
-- | Whether the distribution is enabled to accept user requests for content.
distributionSummary_enabled :: Lens.Lens' DistributionSummary Prelude.Bool
distributionSummary_enabled = Lens.lens (\DistributionSummary' {enabled} -> enabled) (\s@DistributionSummary' {} a -> s {enabled = a} :: DistributionSummary)
-- | A complex type that determines the distribution\'s SSL\/TLS
-- configuration for communicating with viewers.
distributionSummary_viewerCertificate :: Lens.Lens' DistributionSummary ViewerCertificate
distributionSummary_viewerCertificate = Lens.lens (\DistributionSummary' {viewerCertificate} -> viewerCertificate) (\s@DistributionSummary' {} a -> s {viewerCertificate = a} :: DistributionSummary)
-- | A complex type that identifies ways in which you want to restrict
-- distribution of your content.
distributionSummary_restrictions :: Lens.Lens' DistributionSummary Restrictions
distributionSummary_restrictions = Lens.lens (\DistributionSummary' {restrictions} -> restrictions) (\s@DistributionSummary' {} a -> s {restrictions = a} :: DistributionSummary)
-- | The Web ACL Id (if any) associated with the distribution.
distributionSummary_webACLId :: Lens.Lens' DistributionSummary Prelude.Text
distributionSummary_webACLId = Lens.lens (\DistributionSummary' {webACLId} -> webACLId) (\s@DistributionSummary' {} a -> s {webACLId = a} :: DistributionSummary)
-- | Specify the maximum HTTP version that you want viewers to use to
-- communicate with CloudFront. The default value for new web distributions
-- is @http2@. Viewers that don\'t support @HTTP\/2@ will automatically use
-- an earlier version.
distributionSummary_httpVersion :: Lens.Lens' DistributionSummary HttpVersion
distributionSummary_httpVersion = Lens.lens (\DistributionSummary' {httpVersion} -> httpVersion) (\s@DistributionSummary' {} a -> s {httpVersion = a} :: DistributionSummary)
-- | Whether CloudFront responds to IPv6 DNS requests with an IPv6 address
-- for your distribution.
distributionSummary_isIPV6Enabled :: Lens.Lens' DistributionSummary Prelude.Bool
distributionSummary_isIPV6Enabled = Lens.lens (\DistributionSummary' {isIPV6Enabled} -> isIPV6Enabled) (\s@DistributionSummary' {} a -> s {isIPV6Enabled = a} :: DistributionSummary)
-- | Whether the primary distribution has a staging distribution enabled.
distributionSummary_staging :: Lens.Lens' DistributionSummary Prelude.Bool
distributionSummary_staging = Lens.lens (\DistributionSummary' {staging} -> staging) (\s@DistributionSummary' {} a -> s {staging = a} :: DistributionSummary)
instance Data.FromXML DistributionSummary where
parseXML x =
DistributionSummary'
Prelude.<$> ( x
Data..@? "AliasICPRecordals"
Core..!@ Prelude.mempty
Prelude.>>= Core.may (Data.parseXMLList "AliasICPRecordal")
)
Prelude.<*> (x Data..@? "OriginGroups")
Prelude.<*> (x Data..@ "Id")
Prelude.<*> (x Data..@ "ARN")
Prelude.<*> (x Data..@ "Status")
Prelude.<*> (x Data..@ "LastModifiedTime")
Prelude.<*> (x Data..@ "DomainName")
Prelude.<*> (x Data..@ "Aliases")
Prelude.<*> (x Data..@ "Origins")
Prelude.<*> (x Data..@ "DefaultCacheBehavior")
Prelude.<*> (x Data..@ "CacheBehaviors")
Prelude.<*> (x Data..@ "CustomErrorResponses")
Prelude.<*> (x Data..@ "Comment")
Prelude.<*> (x Data..@ "PriceClass")
Prelude.<*> (x Data..@ "Enabled")
Prelude.<*> (x Data..@ "ViewerCertificate")
Prelude.<*> (x Data..@ "Restrictions")
Prelude.<*> (x Data..@ "WebACLId")
Prelude.<*> (x Data..@ "HttpVersion")
Prelude.<*> (x Data..@ "IsIPV6Enabled")
Prelude.<*> (x Data..@ "Staging")
instance Prelude.Hashable DistributionSummary where
hashWithSalt _salt DistributionSummary' {..} =
_salt
`Prelude.hashWithSalt` aliasICPRecordals
`Prelude.hashWithSalt` originGroups
`Prelude.hashWithSalt` id
`Prelude.hashWithSalt` arn
`Prelude.hashWithSalt` status
`Prelude.hashWithSalt` lastModifiedTime
`Prelude.hashWithSalt` domainName
`Prelude.hashWithSalt` aliases
`Prelude.hashWithSalt` origins
`Prelude.hashWithSalt` defaultCacheBehavior
`Prelude.hashWithSalt` cacheBehaviors
`Prelude.hashWithSalt` customErrorResponses
`Prelude.hashWithSalt` comment
`Prelude.hashWithSalt` priceClass
`Prelude.hashWithSalt` enabled
`Prelude.hashWithSalt` viewerCertificate
`Prelude.hashWithSalt` restrictions
`Prelude.hashWithSalt` webACLId
`Prelude.hashWithSalt` httpVersion
`Prelude.hashWithSalt` isIPV6Enabled
`Prelude.hashWithSalt` staging
instance Prelude.NFData DistributionSummary where
rnf DistributionSummary' {..} =
Prelude.rnf aliasICPRecordals
`Prelude.seq` Prelude.rnf originGroups
`Prelude.seq` Prelude.rnf id
`Prelude.seq` Prelude.rnf arn
`Prelude.seq` Prelude.rnf status
`Prelude.seq` Prelude.rnf lastModifiedTime
`Prelude.seq` Prelude.rnf domainName
`Prelude.seq` Prelude.rnf aliases
`Prelude.seq` Prelude.rnf origins
`Prelude.seq` Prelude.rnf defaultCacheBehavior
`Prelude.seq` Prelude.rnf cacheBehaviors
`Prelude.seq` Prelude.rnf customErrorResponses
`Prelude.seq` Prelude.rnf comment
`Prelude.seq` Prelude.rnf priceClass
`Prelude.seq` Prelude.rnf enabled
`Prelude.seq` Prelude.rnf viewerCertificate
`Prelude.seq` Prelude.rnf restrictions
`Prelude.seq` Prelude.rnf webACLId
`Prelude.seq` Prelude.rnf httpVersion
`Prelude.seq` Prelude.rnf isIPV6Enabled
`Prelude.seq` Prelude.rnf staging