Amazon CloudFront
API Reference (API Version 2010-11-01)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

StreamingDistribution Complex Type

Description

The StreamingDistribution complex type describes the information about a streaming distribution. For more information about streaming distributions, go to Working with Distributions and Streaming Media Files in the Amazon CloudFront Developer Guide.

This complex type is used as a response element in POST Streaming Distribution and in GET Streaming Distribution.

Syntax

<StreamingDistribution xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
   <Id>id</Id>
   <Status>status</Status>
   <LastModifiedTime>time</LastModifiedTime>
   <DomainName>domain name</DomainName>
   <StreamingDistributionConfig>
      <S3Origin>
         <DNSName>name</DNSName>
         <OriginAccessIdentity>OAI</OriginAccessIdentity>
      <S3Origin>origin</S3Origin> 
      <CallerReference>ref</CallerReference>
      <CNAME>canonical name</CNAME>
      <Comment>The comment.</Comment>
      <Enabled>true|false</Enabled>
      <Logging>
         <Bucket>mylogs.s3.amazonaws.com</Bucket>
         <Prefix>myprefix/</Prefix>
      </Logging>
   </StreamingDistributionConfig>
</StreamingDistribution>

Elements

The following table describes the child elements in the StreamingDistribution datatype. They're presented in the order they appear in the distribution, and not in alphabetical order.

NameDescriptionRequired

Id

The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.

Type: String

Default: None

Yes

Status

The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

Type: String

Valid Values: Deployed | InProgress

Default: None

Yes

LastModifiedTime

The date and time the distribution was last modified.

Type: String with date in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (e.g., 2009-11-19T19:37:58Z)

Default: None

Yes

DomainName

The domain name corresponding to the streaming distribution. For example, s5c39gqb8ow64r.cloudfront.net.

Type: String

Default: None

Yes

StreamingDistributionConfig

The current configuration information for the streaming distribution.

Type: StreamingDistributionConfig Complex Type

Default: None

Yes

[Note]Note

Even though a distribution might be deployed, you must enable the distribution for use before end users can retrieve content. For more information about enabled and disabled distributions, go to Parts of a Basic Distribution in the Amazon CloudFront Developer Guide.

Examples

The following example shows a streaming distribution with the basic required elements. It doesn't include any CNAMEs or comments.

<StreamingDistribution xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
   <Id>EGTXBD79H29TRA8</Id>
   <Status>Deployed</Status>
   <LastModifiedTime>2009-11-19T19:37:58Z</LastModifiedTime>
   <DomainName>s5c39gqb8ow64r.cloudfront.net</DomainName>
   <StreamingDistributionConfig>   
      <S3Origin>
         <DNSName>mystreamingbucket.s3.amazonaws.com</DNSName>
      </S3Origin>   
      <CallerReference>20091130090000</CallerReference>
      <Enabled>true</Enabled>
   </StreamingDistributionConfig>
</StreamingDistribution>

The following example shows a distribution with a CNAME and comments, and with streaming access logging enabled.

<StreamingDistribution xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
   <Id>EGTXBD79H29TRA8</Id>
   <Status>Deployed</Status>
   <LastModifiedTime>2009-11-19T19:37:58Z</LastModifiedTime>
   <DomainName>s5c39gqb8ow64r.cloudfront.net</DomainName>
   <StreamingDistributionConfig>   
      <S3Origin>
         <DNSName>mystreamingbucket.s3.amazonaws.com</DNSName>
      </S3Origin>   
      <CallerReference>20091130090000</CallerReference>
      <CNAME>beagles.com</CNAME>
      <Comment>My comments</Comment>
      <Enabled>true</Enabled>
      <Logging>
         <Bucket>mylogs.s3.amazonaws.com</Bucket>
         <Prefix>myprefix/</Prefix>
      </Logging>
   </StreamingDistributionConfig>
</StreamingDistribution>