AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CacheBehavior

import "github.com/aws/aws-sdk-go/service/cloudfront"

type CacheBehavior struct { AllowedMethods *AllowedMethods `type:"structure"` Compress *bool `type:"boolean"` DefaultTTL *int64 `type:"long"` FieldLevelEncryptionId *string `type:"string"` ForwardedValues *ForwardedValues `type:"structure" required:"true"` LambdaFunctionAssociations *LambdaFunctionAssociations `type:"structure"` MaxTTL *int64 `type:"long"` MinTTL *int64 `type:"long" required:"true"` PathPattern *string `type:"string" required:"true"` SmoothStreaming *bool `type:"boolean"` TargetOriginId *string `type:"string" required:"true"` TrustedSigners *TrustedSigners `type:"structure" required:"true"` ViewerProtocolPolicy *string `type:"string" required:"true" enum:"ViewerProtocolPolicy"` }

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 (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront) 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 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the Amazon CloudFront Developer Guide.

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.

Compress

Type: *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 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the Amazon CloudFront Developer Guide.

DefaultTTL

Type: *int64

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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the Amazon CloudFront Developer Guide.

FieldLevelEncryptionId

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

ForwardedValues

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

LambdaFunctionAssociations

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

MaxTTL

Type: *int64

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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the Amazon CloudFront Developer Guide.

MinTTL

Type: *int64

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) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the 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).

MinTTL is a required field

PathPattern

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

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 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the Amazon CloudFront Developer Guide.

PathPattern is a required field

SmoothStreaming

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

TargetOriginId

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

TargetOriginId is a required field

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 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) 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.

For more information about updating the distribution configuration, see DistributionConfig .

ViewerProtocolPolicy

Type: *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 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html) 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) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the Amazon CloudFront Developer Guide.

ViewerProtocolPolicy is a required field

Method

GoString

func (s CacheBehavior) GoString() string

GoString returns the string representation

SetAllowedMethods

func (s *CacheBehavior) SetAllowedMethods(v *AllowedMethods) *CacheBehavior

SetAllowedMethods sets the AllowedMethods field's value.

SetCompress

func (s *CacheBehavior) SetCompress(v bool) *CacheBehavior

SetCompress sets the Compress field's value.

SetDefaultTTL

func (s *CacheBehavior) SetDefaultTTL(v int64) *CacheBehavior

SetDefaultTTL sets the DefaultTTL field's value.

SetFieldLevelEncryptionId

func (s *CacheBehavior) SetFieldLevelEncryptionId(v string) *CacheBehavior

SetFieldLevelEncryptionId sets the FieldLevelEncryptionId field's value.

SetForwardedValues

func (s *CacheBehavior) SetForwardedValues(v *ForwardedValues) *CacheBehavior

SetForwardedValues sets the ForwardedValues field's value.

SetLambdaFunctionAssociations

func (s *CacheBehavior) SetLambdaFunctionAssociations(v *LambdaFunctionAssociations) *CacheBehavior

SetLambdaFunctionAssociations sets the LambdaFunctionAssociations field's value.

SetMaxTTL

func (s *CacheBehavior) SetMaxTTL(v int64) *CacheBehavior

SetMaxTTL sets the MaxTTL field's value.

SetMinTTL

func (s *CacheBehavior) SetMinTTL(v int64) *CacheBehavior

SetMinTTL sets the MinTTL field's value.

SetPathPattern

func (s *CacheBehavior) SetPathPattern(v string) *CacheBehavior

SetPathPattern sets the PathPattern field's value.

SetSmoothStreaming

func (s *CacheBehavior) SetSmoothStreaming(v bool) *CacheBehavior

SetSmoothStreaming sets the SmoothStreaming field's value.

SetTargetOriginId

func (s *CacheBehavior) SetTargetOriginId(v string) *CacheBehavior

SetTargetOriginId sets the TargetOriginId field's value.

SetTrustedSigners

func (s *CacheBehavior) SetTrustedSigners(v *TrustedSigners) *CacheBehavior

SetTrustedSigners sets the TrustedSigners field's value.

SetViewerProtocolPolicy

func (s *CacheBehavior) SetViewerProtocolPolicy(v string) *CacheBehavior

SetViewerProtocolPolicy sets the ViewerProtocolPolicy field's value.

String

func (s CacheBehavior) String() string

String returns the string representation

Validate

func (s *CacheBehavior) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: