« blib/lib/Paws/CloudFront/DescribeFunctionResult.pm
↑ Summary
blib/lib/Paws/CloudFront/DistributionConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::Distribution; | ||
| 3 | use Moose; | ||
| 4 | has ActiveTrustedKeyGroups => (is => 'ro', isa => 'Paws::CloudFront::ActiveTrustedKeyGroups'); | ||
| 5 | has ActiveTrustedSigners => (is => 'ro', isa => 'Paws::CloudFront::ActiveTrustedSigners'); | ||
| 6 | has AliasICPRecordals => (is => 'ro', isa => 'ArrayRef[Paws::CloudFront::AliasICPRecordal]', request_name => 'AliasICPRecordal', traits => ['NameInRequest']); | ||
| 7 | has ARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has DistributionConfig => (is => 'ro', isa => 'Paws::CloudFront::DistributionConfig', required => 1); | ||
| 9 | has DomainName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has InProgressInvalidationBatches => (is => 'ro', isa => 'Int', required => 1); | ||
| 12 | has LastModifiedTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudFront::Distribution | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::CloudFront::Distribution object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { ActiveTrustedKeyGroups => $value, ..., Status => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::Distribution object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->ActiveTrustedKeyGroups | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | A distribution tells CloudFront where you want content to be delivered | ||
| 46 | from, and the details about how to track and manage content delivery. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ActiveTrustedKeyGroups => L<Paws::CloudFront::ActiveTrustedKeyGroups> | ||
| 52 | |||
| 53 | CloudFront automatically adds this field to the response if | ||
| 54 | youE<rsquo>ve configured a cache behavior in this distribution to serve | ||
| 55 | private content using key groups. This field contains a list of key | ||
| 56 | groups and the public keys in each key group that CloudFront can use to | ||
| 57 | verify the signatures of signed URLs or signed cookies. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ActiveTrustedSigners => L<Paws::CloudFront::ActiveTrustedSigners> | ||
| 61 | |||
| 62 | We recommend using C<TrustedKeyGroups> instead of C<TrustedSigners>. | ||
| 63 | |||
| 64 | CloudFront automatically adds this field to the response if | ||
| 65 | youE<rsquo>ve configured a cache behavior in this distribution to serve | ||
| 66 | private content using trusted signers. This field contains a list of | ||
| 67 | AWS account IDs and the active CloudFront key pairs in each account | ||
| 68 | that CloudFront can use to verify the signatures of signed URLs or | ||
| 69 | signed cookies. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AliasICPRecordals => ArrayRef[L<Paws::CloudFront::AliasICPRecordal>] | ||
| 73 | |||
| 74 | AWS services in China customers must file for an Internet Content | ||
| 75 | Provider (ICP) recordal if they want to serve content publicly on an | ||
| 76 | alternate domain name, also known as a CNAME, that they've added to | ||
| 77 | CloudFront. AliasICPRecordal provides the ICP recordal status for | ||
| 78 | CNAMEs associated with distributions. | ||
| 79 | |||
| 80 | For more information about ICP recordals, see Signup, Accounts, and | ||
| 81 | Credentials | ||
| 82 | (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) | ||
| 83 | in I<Getting Started with AWS services in China>. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> ARN => Str | ||
| 87 | |||
| 88 | The ARN (Amazon Resource Name) for the distribution. For example: | ||
| 89 | C<arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5>, where | ||
| 90 | C<123456789012> is your AWS account ID. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> DistributionConfig => L<Paws::CloudFront::DistributionConfig> | ||
| 94 | |||
| 95 | The current configuration information for the distribution. Send a | ||
| 96 | C<GET> request to the C</I<CloudFront API version>/distribution | ||
| 97 | ID/config> resource. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> DomainName => Str | ||
| 101 | |||
| 102 | The domain name corresponding to the distribution, for example, | ||
| 103 | C<d111111abcdef8.cloudfront.net>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> Id => Str | ||
| 107 | |||
| 108 | The identifier for the distribution. For example: C<EDFDVBD632BHDS5>. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> InProgressInvalidationBatches => Int | ||
| 112 | |||
| 113 | The number of invalidation batches currently in progress. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> LastModifiedTime => Str | ||
| 117 | |||
| 118 | The date and time the distribution was last modified. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> Status => Str | ||
| 122 | |||
| 123 | This response element indicates the current status of the distribution. | ||
| 124 | When the status is C<Deployed>, the distribution's information is fully | ||
| 125 | propagated to all CloudFront edge locations. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |