File Coverage

blib/lib/Paws/CloudFront/S3OriginConfig.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudFront::S3OriginConfig;
2 1     1   302 use Moose;
  1         3  
  1         4  
3             has OriginAccessIdentity => (is => 'ro', isa => 'Str', required => 1);
4             1;
5              
6             ### main pod documentation begin ###
7              
8             =head1 NAME
9              
10             Paws::CloudFront::S3OriginConfig
11              
12             =head1 USAGE
13              
14             This class represents one of two things:
15              
16             =head3 Arguments in a call to a service
17              
18             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
19             Each attribute should be used as a named argument in the calls that expect this type of object.
20              
21             As an example, if Att1 is expected to be a Paws::CloudFront::S3OriginConfig object:
22              
23             $service_obj->Method(Att1 => { OriginAccessIdentity => $value, ..., OriginAccessIdentity => $value });
24              
25             =head3 Results returned from an API call
26              
27             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::S3OriginConfig object:
28              
29             $result = $service_obj->Method(...);
30             $result->Att1->OriginAccessIdentity
31              
32             =head1 DESCRIPTION
33              
34             A complex type that contains information about the Amazon S3 origin. If
35             the origin is a custom origin, use the C<CustomOriginConfig> element
36             instead.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> OriginAccessIdentity => Str
42              
43             The CloudFront origin access identity to associate with the origin. Use
44             an origin access identity to configure the origin so that viewers can
45             I<only> access objects in an Amazon S3 bucket through CloudFront. The
46             format of the value is:
47              
48             origin-access-identity/cloudfront/I<ID-of-origin-access-identity>
49              
50             where C< I<ID-of-origin-access-identity> > is the value that CloudFront
51             returned in the C<ID> element when you created the origin access
52             identity.
53              
54             If you want viewers to be able to access objects using either the
55             CloudFront URL or the Amazon S3 URL, specify an empty
56             C<OriginAccessIdentity> element.
57              
58             To delete the origin access identity from an existing distribution,
59             update the distribution configuration and include an empty
60             C<OriginAccessIdentity> element.
61              
62             To replace the origin access identity, update the distribution
63             configuration and specify the new origin access identity.
64              
65             For more information about the origin access identity, see Serving
66             Private Content through CloudFront in the I<Amazon CloudFront Developer
67             Guide>.
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
74              
75             =head1 BUGS and CONTRIBUTIONS
76              
77             The source code is located here: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82