Class: Aws::CloudFront::Types::OriginShield

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass OriginShield data as a hash:

{
  enabled: false, # required
  origin_shield_region: "OriginShieldRegion",
}

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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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.

Returns:

  • (Boolean)

10500
10501
10502
10503
10504
10505
# File 'lib/aws-sdk-cloudfront/types.rb', line 10500

class OriginShield < Struct.new(
  :enabled,
  :origin_shield_region)
  SENSITIVE = []
  include Aws::Structure
end

#origin_shield_regionString

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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region

Returns:

  • (String)

10500
10501
10502
10503
10504
10505
# File 'lib/aws-sdk-cloudfront/types.rb', line 10500

class OriginShield < Struct.new(
  :enabled,
  :origin_shield_region)
  SENSITIVE = []
  include Aws::Structure
end