Class: Aws::CloudFront::Types::CacheBehavior

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass CacheBehavior data as a hash:

{
  path_pattern: "string", # required
  target_origin_id: "string", # required
  forwarded_values: { # required
    query_string: false, # required
    cookies: { # required
      forward: "none", # required, accepts none, whitelist, all
      whitelisted_names: {
        quantity: 1, # required
        items: ["string"],
      },
    },
    headers: {
      quantity: 1, # required
      items: ["string"],
    },
    query_string_cache_keys: {
      quantity: 1, # required
      items: ["string"],
    },
  },
  trusted_signers: { # required
    enabled: false, # required
    quantity: 1, # required
    items: ["string"],
  },
  viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
  min_ttl: 1, # required
  allowed_methods: {
    quantity: 1, # required
    items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
    cached_methods: {
      quantity: 1, # required
      items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
    },
  },
  smooth_streaming: false,
  default_ttl: 1,
  max_ttl: 1,
  compress: false,
  lambda_function_associations: {
    quantity: 1, # required
    items: [
      {
        lambda_function_arn: "LambdaFunctionARN", # required
        event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
        include_body: false,
      },
    ],
  },
  field_level_encryption_id: "string",
}

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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_methods ⇒ Types::AllowedMethods

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only ‘GET` and `HEAD` requests.

  • CloudFront forwards only ‘GET`, `HEAD`, and `OPTIONS` requests.

  • CloudFront forwards ‘GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can’t perform operations that you don’t want them to. For example, you might not want users to have permissions to delete objects from your origin.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#compress ⇒ Boolean

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 *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html

Returns:

  • (Boolean) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#default_ttl ⇒ Integer

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 ‘Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html

Returns:

  • (Integer) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#field_level_encryption_id ⇒ String

The value of ‘ID` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

Returns:

  • (String) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#forwarded_values ⇒ Types::ForwardedValues

A complex type that specifies how CloudFront handles query strings and cookies.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#lambda_function_associations ⇒ Types::LambdaFunctionAssociations

A complex type that contains zero or more Lambda function associations for a cache behavior.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#max_ttl ⇒ Integer

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 ‘Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html

Returns:

  • (Integer) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#min_ttl ⇒ Integer

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 [ Managing How Long Content Stays in an Edge Cache (Expiration)] in the 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`).

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html

Returns:

  • (Integer) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#path_pattern ⇒ String

The pattern (for example, ‘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.

<note markdown=“1”> 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 `/`.

</note>

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.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern

Returns:

  • (String) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#smooth_streaming ⇒ Boolean

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 ‘true`; if not, specify `false`. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`.

Returns:

  • (Boolean) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#target_origin_id ⇒ String

The value of ‘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 in your distribution.

Returns:

  • (String) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#trusted_signers ⇒ Types::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 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.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end

#viewer_protocol_policy ⇒ String

The protocol that viewers can use to access the files in the origin specified by ‘TargetOriginId` when a request matches the path pattern in `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*.

<note markdown=“1”> 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 [Managing How Long Content Stays in an Edge Cache (Expiration)] in the *Amazon CloudFront Developer Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html

Returns:

  • (String) 


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 521

class CacheBehavior < Struct.new(
  :path_pattern,
  :target_origin_id,
  :forwarded_values,
  :trusted_signers,
  :viewer_protocol_policy,
  :min_ttl,
  :allowed_methods,
  :smooth_streaming,
  :default_ttl,
  :max_ttl,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id)
  include Aws::Structure
end