NAME
Paws::CloudFront::CacheBehavior
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CloudFront::CacheBehavior object:
$service_obj->Method(Att1 => { AllowedMethods => $value, ..., ViewerProtocolPolicy => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::CacheBehavior object:
$result = $service_obj->Method(...);
$result->Att1->AllowedMethods
DESCRIPTION
A complex type that describes how CloudFront processes requests.
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.
If you don't want to specify any cache behaviors, include only an empty CacheBehaviors
element. Don't include an empty CacheBehavior
element, or CloudFront returns a MalformedXML
error.
To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.
ATTRIBUTES
AllowedMethods => Paws::CloudFront::AllowedMethods
Compress => Bool
Whether you want CloudFront to automatically compress certain files for
this cache behavior. If so, specify true; if not, specify false. For
more information, see Serving Compressed Files in the I<Amazon
CloudFront Developer Guide>.
DefaultTTL => Int
The default amount of time that you want objects to stay in CloudFront
caches before CloudFront forwards another request to your origin to
determine whether the object has been updated. The value that you
specify applies only when your origin does not add HTTP headers such as
C<Cache-Control max-age>, C<Cache-Control s-maxage>, and C<Expires> to
objects. For more information, see Specifying How Long Objects and
Errors Stay in a CloudFront Edge Cache (Expiration) in the I<Amazon
CloudFront Developer Guide>.
REQUIRED ForwardedValues => Paws::CloudFront::ForwardedValues
A complex type that specifies how CloudFront handles query strings and
cookies.
LambdaFunctionAssociations => Paws::CloudFront::LambdaFunctionAssociations
A complex type that contains zero or more Lambda function associations
for a cache behavior.
MaxTTL => Int
The maximum amount of time that you want objects to stay in CloudFront
caches before CloudFront forwards another request to your origin to
determine whether the object has been updated. The value that you
specify applies only when your origin adds HTTP headers such as
C<Cache-Control max-age>, C<Cache-Control s-maxage>, and C<Expires> to
objects. For more information, see Specifying How Long Objects and
Errors Stay in a CloudFront Edge Cache (Expiration) in the I<Amazon
CloudFront Developer Guide>.
REQUIRED MinTTL => Int
The minimum amount of time that you want objects to stay in CloudFront
caches before CloudFront forwards another request to your origin to
determine whether the object has been updated. For more information,
see Specifying How Long Objects and Errors Stay in a CloudFront Edge
Cache (Expiration) in the I<Amazon Amazon CloudFront Developer Guide>.
You must specify 0
for MinTTL
if you configure CloudFront to forward all headers to your origin (under Headers
, if you specify 1
for Quantity
and *
for Name
).
REQUIRED PathPattern => Str
The pattern (for example, C<images/*.jpg>) that specifies which
requests to apply the behavior to. When CloudFront receives a viewer
request, the requested path is compared with path patterns in the order
in which cache behaviors are listed in the distribution.
You can optionally include a slash (/
) at the beginning of the path pattern. For example, /images/*.jpg
. CloudFront behavior is the same with or without the leading /
.
The path pattern for the default cache behavior is *
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
SmoothStreaming => Bool
Indicates whether you want to distribute media files in the Microsoft
Smooth Streaming format using the origin that is associated with this
cache behavior. If so, specify C<true>; if not, specify C<false>. If
you specify C<true> for C<SmoothStreaming>, you can still distribute
other content using this cache behavior if the content matches the
value of C<PathPattern>.
REQUIRED TargetOriginId => Str
The value of C<ID> for the origin that you want CloudFront to route
requests to when a request matches the path pattern either for a cache
behavior or for the default cache behavior.
REQUIRED TrustedSigners => Paws::CloudFront::TrustedSigners
A complex type that specifies the AWS accounts, if any, that you want
to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the PathPattern
for this cache behavior, specify true
for Enabled
, and specify the applicable values for Quantity
and Items
. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
If you don't want to require signed URLs in requests for objects that match PathPattern
, specify false
for Enabled
and 0
for Quantity
. Omit Items
.
To add, change, or remove one or more trusted signers, change Enabled
to true
(if it's currently false
), change Quantity
as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
REQUIRED ViewerProtocolPolicy => Str
The protocol that viewers can use to access the files in the origin
specified by C<TargetOriginId> when a request matches the path pattern
in C<PathPattern>. You can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::CloudFront
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues