| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::S3OriginConfig; | ||
| 3 | use Moose; | ||
| 4 | has OriginAccessIdentity => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::CloudFront::S3OriginConfig | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::CloudFront::S3OriginConfig object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { OriginAccessIdentity => $value, ..., OriginAccessIdentity => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::S3OriginConfig object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->OriginAccessIdentity | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | A complex type that contains information about the Amazon S3 origin. If | ||
| 37 | the origin is a custom origin or an S3 bucket that is configured as a | ||
| 38 | website endpoint, use the C<CustomOriginConfig> element instead. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> OriginAccessIdentity => Str | ||
| 44 | |||
| 45 | The CloudFront origin access identity to associate with the origin. Use | ||
| 46 | an origin access identity to configure the origin so that viewers can | ||
| 47 | I<only> access objects in an Amazon S3 bucket through CloudFront. The | ||
| 48 | format of the value is: | ||
| 49 | |||
| 50 | origin-access-identity/cloudfront/I<ID-of-origin-access-identity> | ||
| 51 | |||
| 52 | where C< I<ID-of-origin-access-identity> > is the value that CloudFront | ||
| 53 | returned in the C<ID> element when you created the origin access | ||
| 54 | identity. | ||
| 55 | |||
| 56 | If you want viewers to be able to access objects using either the | ||
| 57 | CloudFront URL or the Amazon S3 URL, specify an empty | ||
| 58 | C<OriginAccessIdentity> element. | ||
| 59 | |||
| 60 | To delete the origin access identity from an existing distribution, | ||
| 61 | update the distribution configuration and include an empty | ||
| 62 | C<OriginAccessIdentity> element. | ||
| 63 | |||
| 64 | To replace the origin access identity, update the distribution | ||
| 65 | configuration and specify the new origin access identity. | ||
| 66 | |||
| 67 | For more information about the origin access identity, see Serving | ||
| 68 | Private Content through CloudFront | ||
| 69 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) | ||
| 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 |