You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFront::Types::AllowedMethods

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 AllowedMethods data as a hash:

{
  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
  },
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#cached_methodsTypes::CachedMethods

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.



148
149
150
151
152
153
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 148

class AllowedMethods < Struct.new(
  :quantity,
  :items,
  :cached_methods)
  include Aws::Structure
end

#itemsArray<String>

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

Returns:

  • (Array<String>)


148
149
150
151
152
153
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 148

class AllowedMethods < Struct.new(
  :quantity,
  :items,
  :cached_methods)
  include Aws::Structure
end

#quantityInteger

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

Returns:

  • (Integer)


148
149
150
151
152
153
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 148

class AllowedMethods < Struct.new(
  :quantity,
  :items,
  :cached_methods)
  include Aws::Structure
end