Initialize connection to Cloudfront
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
cdn = Fog::AWS::CDN.new( :aws_access_key_id => your_aws_access_key_id, :aws_secret_access_key => your_aws_secret_access_key )
options<~Hash> - config arguments for connection. Defaults to {}.
cdn object with connection to aws.
# File lib/fog/aws/cdn.rb, line 82 def initialize(options={}) require 'fog/core/parser' @aws_access_key_id = options[:aws_access_key_id] @aws_secret_access_key = options[:aws_secret_access_key] @connection_options = options[:connection_options] || {} @hmac = Fog::HMAC.new('sha1', @aws_secret_access_key) @host = options[:host] || 'cloudfront.amazonaws.com' @path = options[:path] || '/' @persistent = options[:persistent] || true @port = options[:port] || 443 @scheme = options[:scheme] || 'https' @version = options[:version] || '2010-11-01' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options) end
Delete a distribution from CloudFront
distribution_id<~String> - Id of distribution to delete
etag<~String> - etag of that distribution from earlier get or put
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DeleteDistribution.html
# File lib/fog/aws/requests/cdn/delete_distribution.rb, line 15 def delete_distribution(distribution_id, etag) request({ :expects => 204, :headers => { 'If-Match' => etag }, :idempotent => true, :method => 'DELETE', :path => "/distribution/#{distribution_id}" }) end
Delete a streaming distribution from CloudFront
distribution_id<~String> - Id of distribution to delete
etag<~String> - etag of that distribution from earlier get or put
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DeleteStreamingDistribution.html
# File lib/fog/aws/requests/cdn/delete_streaming_distribution.rb, line 15 def delete_streaming_distribution(distribution_id, etag) request({ :expects => 204, :headers => { 'If-Match' => etag }, :idempotent => true, :method => 'DELETE', :path => "/streaming-distribution/#{distribution_id}" }) end
Get information about a distribution from CloudFront
distribution_id<~String> - id of distribution
response<~Excon::Response>:
body<~Hash>:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
or
'CustomOrigin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'www.example.com'
'HTTPPort'<~Integer> - HTTP port of origin, in [80, 443] or (1024...65535)
'HTTPSPort'<~Integer> - HTTPS port of origin, in [80, 443] or (1024...65535)
'OriginProtocolPolicy'<~String> - Policy on using http vs https, in ['http-only', 'match-viewer']
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Status'<~String> - Status of distribution
'DistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'InProgressInvalidationBatches'<~Integer> - number of invalidation batches in progress
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
'Origin'<~String> - s3 origin bucket
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/GetDistribution.html
# File lib/fog/aws/requests/cdn/get_distribution.rb, line 44 def get_distribution(distribution_id) request({ :expects => 200, :idempotent => true, :method => 'GET', :parser => Fog::Parsers::CDN::AWS::Distribution.new, :path => "/distribution/#{distribution_id}" }) end
List information about distributions in CloudFront
options<~Hash> - config arguments for list. Defaults to {}.
'Marker'<~String> - limits object keys to only those that appear lexicographically after its value.
'MaxItems'<~Integer> - limits number of object keys returned
response<~Excon::Response>:
body<~Hash>:
'IsTruncated'<~Boolean> - Whether or not the listing is truncated
'Marker'<~String> - Marker specified for query
'MaxItems'<~Integer> - Maximum number of keys specified for query
'NextMarker'<~String> - Marker to specify for next page (id of last result of current page)
'DistributionSummary'<~Array>:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
or
'CustomOrigin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'www.example.com'
'HTTPPort'<~Integer> - HTTP port of origin, in [80, 443] or (1024...65535)
'HTTPSPort'<~Integer> - HTTPS port of origin, in [80, 443] or (1024...65535)
'OriginProtocolPolicy'<~String> - Policy on using http vs https, in ['http-only', 'match-viewer']
'Comment'<~String> - comment associated with distribution
'CNAME'<~Array> - array of associated cnames
'Enabled'<~Boolean> - whether or not distribution is enabled
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Origin'<~String> - s3 origin bucket
'Status'<~String> - Status of distribution
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/ListDistributions.html
# File lib/fog/aws/requests/cdn/get_distribution_list.rb, line 45 def get_distribution_list(options = {}) request({ :expects => 200, :idempotent => true, :method => 'GET', :parser => Fog::Parsers::CDN::AWS::GetDistributionList.new, :path => "/distribution", :query => options }) end
options<~Hash> - config arguments for list. Defaults to {}.
'Marker'<~String> - limits object keys to only those that appear lexicographically after its value.
'MaxItems'<~Integer> - limits number of object keys returned
response<~Excon::Response>:
body<~Hash>:
'IsTruncated'<~Boolean> - Whether or not the listing is truncated
'Marker'<~String> - Marker specified for query
'MaxItems'<~Integer> - Maximum number of keys specified for query
'NextMarker'<~String> - Marker to specify for next page (id of last result of current page)
'InvalidationSummary'<~Array>:
'Id'<~String>:
'Status'<~String>:
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/ListInvalidation.html
# File lib/fog/aws/requests/cdn/get_invalidation_list.rb, line 28 def get_invalidation_list(distribution_id, options = {}) request({ :expects => 200, :idempotent => true, :method => 'GET', :parser => Fog::Parsers::CDN::AWS::GetInvalidationList.new, :path => "/distribution/#{distribution_id}/invalidation", :query => options }) end
Get information about a streaming distribution from CloudFront
distribution_id<~String> - id of distribution
response<~Excon::Response>:
body<~Hash>:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Status'<~String> - Status of distribution
'StreamingDistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'InProgressInvalidationBatches'<~Integer> - number of invalidation batches in progress
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
'Origin'<~String> - s3 origin bucket
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/GetStreamingDistribution.html
# File lib/fog/aws/requests/cdn/get_streaming_distribution.rb, line 37 def get_streaming_distribution(distribution_id) request({ :expects => 200, :idempotent => true, :method => 'GET', :parser => Fog::Parsers::CDN::AWS::StreamingDistribution.new, :path => "/streaming-distribution/#{distribution_id}" }) end
List information about distributions in CloudFront
options<~Hash> - config arguments for list. Defaults to {}.
'Marker'<~String> - limits object keys to only those that appear lexicographically after its value.
'MaxItems'<~Integer> - limits number of object keys returned
response<~Excon::Response>:
body<~Hash>:
'IsTruncated'<~Boolean> - Whether or not the listing is truncated
'Marker'<~String> - Marker specified for query
'MaxItems'<~Integer> - Maximum number of keys specified for query
'NextMarker'<~String> - Marker to specify for next page (id of last result of current page)
'StreamingDistributionSummary'<~Array>:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
or
'CustomOrigin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'www.example.com'
'HTTPPort'<~Integer> - HTTP port of origin, in [80, 443] or (1024...65535)
'HTTPSPort'<~Integer> - HTTPS port of origin, in [80, 443] or (1024...65535)
'OriginProtocolPolicy'<~String> - Policy on using http vs https, in ['http-only', 'match-viewer']
'Comment'<~String> - comment associated with distribution
'CNAME'<~Array> - array of associated cnames
'Enabled'<~Boolean> - whether or not distribution is enabled
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Origin'<~String> - s3 origin bucket
'Status'<~String> - Status of distribution
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/ListStreamingDistributions.html
# File lib/fog/aws/requests/cdn/get_streaming_distribution_list.rb, line 45 def get_streaming_distribution_list(options = {}) request({ :expects => 200, :idempotent => true, :method => 'GET', :parser => Fog::Parsers::CDN::AWS::GetStreamingDistributionList.new, :path => "/streaming-distribution", :query => options }) end
create a new distribution in CloudFront
options<~Hash> - config for distribution. Defaults to {}. REQUIRED:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
or
'CustomOrigin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'www.example.com'
'HTTPPort'<~Integer> - Optional HTTP port of origin, in [80, 443] or (1024...65535), defaults to 80
'HTTPSPort'<~Integer> - Optional HTTPS port of origin, in [80, 443] or (1024...65535), defaults to 443
'OriginProtocolPolicy'<~String> - Policy on using http vs https, in ['http-only', 'match-viewer']
OPTIONAL:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'Comment'<~String> - Optional comment about distribution
'CNAME'<~Array> - Optional array of strings to set as CNAMEs
'DefaultRootObject'<~String> - Optional default object to return for '/'
'Enabled'<~Boolean> - Whether or not distribution should accept requests, defaults to true
'Logging'<~Hash>: Optional logging config
'Bucket'<~String> - Bucket to store logs in, ie 'mylogs.s3.amazonaws.com'
'Prefix'<~String> - Optional prefix for log filenames, ie 'myprefix/'
'OriginAccessIdentity'<~String> - Used for serving private content, in format 'origin-access-identity/cloudfront/ID'
'RequiredProtocols'<~String> - Optional, set to 'https' to force https connections
'TrustedSigners'<~Array> - Optional grant of rights to up to 5 aws accounts to generate signed URLs for private content, elements are either 'Self' for your own account or an AWS Account Number
response<~Excon::Response>:
body<~Hash>:
'DomainName'<~String>: Domain name of distribution
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Status'<~String> - Status of distribution
'DistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
'Origin'<~String> - s3 origin bucket
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/CreateDistribution.html
# File lib/fog/aws/requests/cdn/post_distribution.rb, line 56 def post_distribution(options = {}) options['CallerReference'] = Time.now.to_i.to_s data = '<?xml version="1.0" encoding="UTF-8"?>' data << "<DistributionConfig xmlns=\"http://cloudfront.amazonaws.com/doc/#{@version}/\">" for key, value in options case value when Array for item in value data << "<#{key}>#{item}</#{key}>" end when Hash data << "<#{key}>" for inner_key, inner_value in value data << "<#{inner_key}>#{inner_value}</#{inner_key}>" end data << "</#{key}>" else data << "<#{key}>#{value}</#{key}>" end end data << "</DistributionConfig>" request({ :body => data, :expects => 201, :headers => { 'Content-Type' => 'text/xml' }, :idempotent => true, :method => 'POST', :parser => Fog::Parsers::CDN::AWS::Distribution.new, :path => "/distribution" }) end
List information about distributions in CloudFront
distribution_id<~String> - Id of distribution for invalidations
paths<~Array> - Array of string paths to objects to invalidate
caller_reference<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
response<~Excon::Response>:
body<~Hash>:
'Id'<~String> - Id of invalidation
'Status'<~String> - Status of invalidation
'CreateTime'<~Integer> - Time of invalidation creation
'InvalidationBatch'<~Array>:
'Path'<~Array> - Array of strings of objects to invalidate
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/CreateInvalidation.html
# File lib/fog/aws/requests/cdn/post_invalidation.rb, line 29 def post_invalidation(distribution_id, paths, caller_reference = Time.now.to_i.to_s) body = '<?xml version="1.0" encoding="UTF-8"?>' body << "<InvalidationBatch>" for path in [*paths] body << "<Path>" << path << "</Path>" end body << "<CallerReference>" << caller_reference << "</CallerReference>" body << "</InvalidationBatch>" request({ :body => body, :expects => 201, :headers => {'Content-Type' => 'text/xml'}, :idempotent => true, :method => 'POST', :parser => Fog::Parsers::CDN::AWS::PostInvalidation.new, :path => "/distribution/#{distribution_id}/invalidation" }) end
create a new streaming distribution in CloudFront
options<~Hash> - config for distribution. Defaults to {}. REQUIRED:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
OPTIONAL:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'Comment'<~String> - Optional comment about distribution
'CNAME'<~Array> - Optional array of strings to set as CNAMEs
'Enabled'<~Boolean> - Whether or not distribution should accept requests, defaults to true
'Logging'<~Hash>: Optional logging config
'Bucket'<~String> - Bucket to store logs in, ie 'mylogs.s3.amazonaws.com'
'Prefix'<~String> - Optional prefix for log filenames, ie 'myprefix/'
response<~Excon::Response>:
body<~Hash>:
'Id'<~String> - Id of distribution
'Status'<~String> - Status of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'DomainName'<~String>: Domain name of distribution
'StreamingDistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/CreateStreamingDistribution.html
# File lib/fog/aws/requests/cdn/post_streaming_distribution.rb, line 43 def post_streaming_distribution(options = {}) options['CallerReference'] = Time.now.to_i.to_s data = '<?xml version="1.0" encoding="UTF-8"?>' data << "<StreamingDistributionConfig xmlns=\"http://cloudfront.amazonaws.com/doc/#{@version}/\">" for key, value in options case value when Array for item in value data << "<#{key}>#{item}</#{key}>" end when Hash data << "<#{key}>" for inner_key, inner_value in value data << "<#{inner_key}>#{inner_value}</#{inner_key}>" end data << "</#{key}>" else data << "<#{key}>#{value}</#{key}>" end end data << "</StreamingDistributionConfig>" request({ :body => data, :expects => 201, :headers => { 'Content-Type' => 'text/xml' }, :idempotent => true, :method => 'POST', :parser => Fog::Parsers::CDN::AWS::StreamingDistribution.new, :path => "/streaming-distribution" }) end
update a distribution in CloudFront
distribution_id<~String> - Id of distribution to update config for
options<~Hash> - config for distribution. Defaults to {}. REQUIRED:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
'OriginAccessIdentity'<~String> - Optional: Used when serving private content
or
'CustomOrigin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'www.example.com'
'HTTPPort'<~Integer> - HTTP port of origin, in [80, 443] or (1024...65535)
'HTTPSPort'<~Integer> - HTTPS port of origin, in [80, 443] or (1024...65535)
'OriginProtocolPolicy'<~String> - Policy on using http vs https, in ['http-only', 'match-viewer']
OPTIONAL:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'Comment'<~String> - Optional comment about distribution
'CNAME'<~Array> - Optional array of strings to set as CNAMEs
'DefaultRootObject'<~String> - Optional default object to return for '/'
'Enabled'<~Boolean> - Whether or not distribution should accept requests, defaults to true
'Logging'<~Hash>: Optional logging config
'Bucket'<~String> - Bucket to store logs in, ie 'mylogs.s3.amazonaws.com'
'Prefix'<~String> - Optional prefix for log filenames, ie 'myprefix/'
'OriginAccessIdentity'<~String> - Used for serving private content, in format 'origin-access-identity/cloudfront/ID'
'RequiredProtocols'<~String> - Optional, set to 'https' to force https connections
'TrustedSigners'<~Array> - Optional grant of rights to up to 5 aws accounts to generate signed URLs for private content, elements are either 'Self' for your own account or an AWS Account Number
response<~Excon::Response>:
body<~Hash>:
'DomainName'<~String>: Domain name of distribution
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Status'<~String> - Status of distribution
'DistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
'Origin'<~String> - s3 origin bucket
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/CreateDistribution.html
# File lib/fog/aws/requests/cdn/put_distribution_config.rb, line 57 def put_distribution_config(distribution_id, etag, options = {}) data = '<?xml version="1.0" encoding="UTF-8"?>' data << "<DistributionConfig xmlns=\"http://cloudfront.amazonaws.com/doc/#{@version}/\">" for key, value in options case value when Array for item in value data << "<#{key}>#{item}</#{key}>" end when Hash data << "<#{key}>" for inner_key, inner_value in value data << "<#{inner_key}>#{inner_value}</#{inner_key}>" end data << "</#{key}>" else data << "<#{key}>#{value}</#{key}>" end end data << "</DistributionConfig>" request({ :body => data, :expects => 200, :headers => { 'Content-Type' => 'text/xml', 'If-Match' => etag }, :idempotent => true, :method => 'PUT', :parser => Fog::Parsers::CDN::AWS::Distribution.new, :path => "/distribution/#{distribution_id}/config" }) end
update a streaming distribution in CloudFront
distribution_id<~String> - Id of distribution to update config for
options<~Hash> - config for distribution. Defaults to {}. REQUIRED:
'S3Origin'<~Hash>:
'DNSName'<~String> - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'
OPTIONAL:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'Comment'<~String> - Optional comment about distribution
'CNAME'<~Array> - Optional array of strings to set as CNAMEs
'Enabled'<~Boolean> - Whether or not distribution should accept requests, defaults to true
'Logging'<~Hash>: Optional logging config
'Bucket'<~String> - Bucket to store logs in, ie 'mylogs.s3.amazonaws.com'
'Prefix'<~String> - Optional prefix for log filenames, ie 'myprefix/'
response<~Excon::Response>:
body<~Hash>:
'DomainName'<~String>: Domain name of distribution
'Id'<~String> - Id of distribution
'LastModifiedTime'<~String> - Timestamp of last modification of distribution
'Status'<~String> - Status of distribution
'StreamingDistributionConfig'<~Array>:
'CallerReference'<~String> - Used to prevent replay, defaults to Fog::Time.now.to_i.to_s
'CNAME'<~Array> - array of associated cnames
'Comment'<~String> - comment associated with distribution
'Enabled'<~Boolean> - whether or not distribution is enabled
'Logging'<~Hash>:
'Bucket'<~String> - bucket logs are stored in
'Prefix'<~String> - prefix logs are stored with
'Origin'<~String> - s3 origin bucket
'TrustedSigners'<~Array> - trusted signers
docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/PutStreamingDistribution.html
# File lib/fog/aws/requests/cdn/put_streaming_distribution_config.rb, line 46 def put_streaming_distribution_config(distribution_id, etag, options = {}) data = '<?xml version="1.0" encoding="UTF-8"?>' data << "<StreamingDistributionConfig xmlns=\"http://cloudfront.amazonaws.com/doc/#{@version}/\">" for key, value in options case value when Array for item in value data << "<#{key}>#{item}</#{key}>" end when Hash data << "<#{key}>" for inner_key, inner_value in value data << "<#{inner_key}>#{inner_value}</#{inner_key}>" end data << "</#{key}>" else data << "<#{key}>#{value}</#{key}>" end end data << "</StreamingDistributionConfig>" request({ :body => data, :expects => 200, :headers => { 'Content-Type' => 'text/xml', 'If-Match' => etag }, :idempotent => true, :method => 'PUT', :parser => Fog::Parsers::CDN::AWS::StreamingDistribution.new, :path => "/streaming-distribution/#{distribution_id}/config" }) end
# File lib/fog/aws/cdn.rb, line 98 def reload @connection.reset end