Class: Aws::CloudFront::Types::DefaultCacheBehavior

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

Overview

Note:

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

{
  target_origin_id: "string", # required
  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
  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,
  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",
  realtime_log_config_arn: "string",
  cache_policy_id: "string",
  origin_request_policy_id: "string",
  forwarded_values: {
    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"],
    },
  },
  min_ttl: 1,
  default_ttl: 1,
  max_ttl: 1,
}

A complex type that describes the default cache behavior if you don’t specify a CacheBehavior element or if request URLs don’t match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_methodsTypes::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.



3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#cache_policy_idString

The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#compressBoolean

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.

Returns:

  • (Boolean)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#default_ttlInteger

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

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.

Returns:

  • (Integer)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#field_level_encryption_idString

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#forwarded_valuesTypes::ForwardedValues

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

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



3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_function_associationsTypes::LambdaFunctionAssociations

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



3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#max_ttlInteger

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

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.

Returns:

  • (Integer)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#min_ttlInteger

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

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

Returns:

  • (Integer)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#origin_request_policy_idString

The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#realtime_log_config_arnString

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#smooth_streamingBoolean

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)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#target_origin_idString

The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#trusted_signersTypes::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 with Signed URLs and Signed Cookies 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.



3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end

#viewer_protocol_policyString

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 Requiring HTTPS Between Viewers and CloudFront 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 Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Returns:

  • (String)


3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3449

class DefaultCacheBehavior < Struct.new(
  :target_origin_id,
  :trusted_signers,
  :viewer_protocol_policy,
  :allowed_methods,
  :smooth_streaming,
  :compress,
  :lambda_function_associations,
  :field_level_encryption_id,
  :realtime_log_config_arn,
  :cache_policy_id,
  :origin_request_policy_id,
  :forwarded_values,
  :min_ttl,
  :default_ttl,
  :max_ttl)
  SENSITIVE = []
  include Aws::Structure
end