« blib/lib/Paws/Lightsail/UpdateContainerServiceResult.pm
↑ Summary
blib/lib/Paws/Lightsail/UpdateDistributionBundle.pm »
| 1 | |||
| 2 | package Paws::Lightsail::UpdateDistribution; | ||
| 3 | use Moose; | ||
| 4 | has CacheBehaviors => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::CacheBehaviorPerPath]', traits => ['NameInRequest'], request_name => 'cacheBehaviors' ); | ||
| 5 | has CacheBehaviorSettings => (is => 'ro', isa => 'Paws::Lightsail::CacheSettings', traits => ['NameInRequest'], request_name => 'cacheBehaviorSettings' ); | ||
| 6 | has DefaultCacheBehavior => (is => 'ro', isa => 'Paws::Lightsail::CacheBehavior', traits => ['NameInRequest'], request_name => 'defaultCacheBehavior' ); | ||
| 7 | has DistributionName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distributionName' , required => 1); | ||
| 8 | has IsEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'isEnabled' ); | ||
| 9 | has Origin => (is => 'ro', isa => 'Paws::Lightsail::InputOrigin', traits => ['NameInRequest'], request_name => 'origin' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDistribution'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::UpdateDistributionResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Lightsail::UpdateDistribution - Arguments for method UpdateDistribution on L<Paws::Lightsail> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateDistribution on the | ||
| 27 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateDistribution. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDistribution. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $lightsail = Paws->service('Lightsail'); | ||
| 35 | my $UpdateDistributionResult = $lightsail->UpdateDistribution( | ||
| 36 | DistributionName => 'MyResourceName', | ||
| 37 | CacheBehaviorSettings => { | ||
| 38 | AllowedHTTPMethods => 'MyNonEmptyString', # OPTIONAL | ||
| 39 | CachedHTTPMethods => 'MyNonEmptyString', # OPTIONAL | ||
| 40 | DefaultTTL => 1, # OPTIONAL | ||
| 41 | ForwardedCookies => { | ||
| 42 | CookiesAllowList => [ 'Mystring', ... ], # OPTIONAL | ||
| 43 | Option => 'none', # values: none, allow-list, all; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | ForwardedHeaders => { | ||
| 46 | HeadersAllowList => [ | ||
| 47 | 'Accept', | ||
| 48 | ... # values: Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer | ||
| 49 | ], # OPTIONAL | ||
| 50 | Option => 'none', # values: none, allow-list, all; OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | ForwardedQueryStrings => { | ||
| 53 | Option => 1, # OPTIONAL | ||
| 54 | QueryStringsAllowList => [ 'Mystring', ... ], # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | MaximumTTL => 1, # OPTIONAL | ||
| 57 | MinimumTTL => 1, # OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | CacheBehaviors => [ | ||
| 60 | { | ||
| 61 | Behavior => 'dont-cache', # values: dont-cache, cache; OPTIONAL | ||
| 62 | Path => 'Mystring', | ||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # OPTIONAL | ||
| 66 | DefaultCacheBehavior => { | ||
| 67 | Behavior => 'dont-cache', # values: dont-cache, cache; OPTIONAL | ||
| 68 | }, # OPTIONAL | ||
| 69 | IsEnabled => 1, # OPTIONAL | ||
| 70 | Origin => { | ||
| 71 | Name => 'MyResourceName', | ||
| 72 | ProtocolPolicy => 'http-only', # values: http-only, https-only; OPTIONAL | ||
| 73 | RegionName => 'us-east-1' | ||
| 74 | , # values: us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2; OPTIONAL | ||
| 75 | }, # OPTIONAL | ||
| 76 | ); | ||
| 77 | |||
| 78 | # Results: | ||
| 79 | my $Operation = $UpdateDistributionResult->Operation; | ||
| 80 | |||
| 81 | # Returns a L<Paws::Lightsail::UpdateDistributionResult> object. | ||
| 82 | |||
| 83 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 84 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/UpdateDistribution> | ||
| 85 | |||
| 86 | =head1 ATTRIBUTES | ||
| 87 | |||
| 88 | |||
| 89 | =head2 CacheBehaviors => ArrayRef[L<Paws::Lightsail::CacheBehaviorPerPath>] | ||
| 90 | |||
| 91 | An array of objects that describe the per-path cache behavior for the | ||
| 92 | distribution. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 CacheBehaviorSettings => L<Paws::Lightsail::CacheSettings> | ||
| 97 | |||
| 98 | An object that describes the cache behavior settings for the | ||
| 99 | distribution. | ||
| 100 | |||
| 101 | The C<cacheBehaviorSettings> specified in your | ||
| 102 | C<UpdateDistributionRequest> will replace your distribution's existing | ||
| 103 | settings. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 DefaultCacheBehavior => L<Paws::Lightsail::CacheBehavior> | ||
| 108 | |||
| 109 | An object that describes the default cache behavior for the | ||
| 110 | distribution. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> DistributionName => Str | ||
| 115 | |||
| 116 | The name of the distribution to update. | ||
| 117 | |||
| 118 | Use the C<GetDistributions> action to get a list of distribution names | ||
| 119 | that you can specify. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 IsEnabled => Bool | ||
| 124 | |||
| 125 | Indicates whether to enable the distribution. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Origin => L<Paws::Lightsail::InputOrigin> | ||
| 130 | |||
| 131 | An object that describes the origin resource for the distribution, such | ||
| 132 | as a Lightsail instance or load balancer. | ||
| 133 | |||
| 134 | The distribution pulls, caches, and serves content from the origin. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head1 SEE ALSO | ||
| 140 | |||
| 141 | This class forms part of L<Paws>, documenting arguments for method UpdateDistribution in L<Paws::Lightsail> | ||
| 142 | |||
| 143 | =head1 BUGS and CONTRIBUTIONS | ||
| 144 | |||
| 145 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 146 | |||
| 147 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 148 | |||
| 149 | =cut | ||
| 150 |