« blib/lib/Paws/CloudFront/OriginRequestPolicySummary.pm
↑ Summary
blib/lib/Paws/CloudFront/OriginSslProtocols.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::OriginShield; | ||
| 3 | use Moose; | ||
| 4 | has Enabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has OriginShieldRegion => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudFront::OriginShield | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CloudFront::OriginShield object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Enabled => $value, ..., OriginShieldRegion => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::OriginShield object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Enabled | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | CloudFront Origin Shield. | ||
| 38 | |||
| 39 | Using Origin Shield can help reduce the load on your origin. For more | ||
| 40 | information, see Using Origin Shield | ||
| 41 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) | ||
| 42 | in the I<Amazon CloudFront Developer Guide>. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> Enabled => Bool | ||
| 48 | |||
| 49 | A flag that specifies whether Origin Shield is enabled. | ||
| 50 | |||
| 51 | When itE<rsquo>s enabled, CloudFront routes all requests through Origin | ||
| 52 | Shield, which can help protect your origin. When itE<rsquo>s disabled, | ||
| 53 | CloudFront might send requests directly to your origin from multiple | ||
| 54 | edge locations or regional edge caches. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 OriginShieldRegion => Str | ||
| 58 | |||
| 59 | The AWS Region for Origin Shield. | ||
| 60 | |||
| 61 | Specify the AWS Region that has the lowest latency to your origin. To | ||
| 62 | specify a region, use the region code, not the region name. For | ||
| 63 | example, specify the US East (Ohio) region as C<us-east-2>. | ||
| 64 | |||
| 65 | When you enable CloudFront Origin Shield, you must specify the AWS | ||
| 66 | Region for Origin Shield. For the list of AWS Regions that you can | ||
| 67 | specify, and for help choosing the best Region for your origin, see | ||
| 68 | Choosing the AWS Region for Origin Shield | ||
| 69 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) | ||
| 70 | in the I<Amazon CloudFront Developer Guide>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |