Method: Fog::CDN::AWS::Real#get_distribution

Defined in:
lib/fog/aws/requests/cdn/get_distribution.rb

#get_distribution(distribution_id) ⇒ Object

Get information about a distribution from CloudFront

Parameters

  • distribution_id<~String> - id of distribution

Returns

  • 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 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

See Also

docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/GetDistribution.html


44
45
46
47
48
49
50
51
52
# 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