amazonka-cloudfront-2.0: Amazon CloudFront 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.CloudFront.Types.OriginShield

Description

 
Synopsis

Documentation

data OriginShield Source #

CloudFront Origin Shield.

Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

See: newOriginShield smart constructor.

Constructors

OriginShield' 

Fields

  • originShieldRegion :: Maybe Text

    The Amazon Web Services Region for Origin Shield.

    Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2.

    When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide.

  • enabled :: Bool

    A flag that specifies whether Origin Shield is enabled.

    When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.

Instances

Instances details
FromXML OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

ToXML OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

Methods

toXML :: OriginShield -> XML #

Generic OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

Associated Types

type Rep OriginShield :: Type -> Type #

Read OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

Show OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

NFData OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

Methods

rnf :: OriginShield -> () #

Eq OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

Hashable OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

type Rep OriginShield Source # 
Instance details

Defined in Amazonka.CloudFront.Types.OriginShield

type Rep OriginShield = D1 ('MetaData "OriginShield" "Amazonka.CloudFront.Types.OriginShield" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "OriginShield'" 'PrefixI 'True) (S1 ('MetaSel ('Just "originShieldRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newOriginShield Source #

Create a value of OriginShield 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:originShieldRegion:OriginShield', originShield_originShieldRegion - The Amazon Web Services Region for Origin Shield.

Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2.

When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide.

$sel:enabled:OriginShield', originShield_enabled - A flag that specifies whether Origin Shield is enabled.

When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.

originShield_originShieldRegion :: Lens' OriginShield (Maybe Text) Source #

The Amazon Web Services Region for Origin Shield.

Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2.

When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide.

originShield_enabled :: Lens' OriginShield Bool Source #

A flag that specifies whether Origin Shield is enabled.

When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.