AWS Documentation » Amazon CloudFront » API Reference » Complex Types » StreamingDistribution Complex Type	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

StreamingDistribution Complex Type

Topics

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/2012-07-01/">
   <Id>id</Id>
   <Status>Deployed | InProgress</Status>
   <LastModifiedTime>date and time in ISO 8601 format</LastModifiedTime>
   <DomainName>CloudFront domain name for the distribution</DomainName>
   <ActiveTrustedSigners>
      <Enabled>true | false</Enabled>
      <Quantity>number of trusted signers for this distribution</Quantity>
      <Items>
         <Signer>
            <AwsAccountNumber>self | AWS account number</AwsAccountNumber>
            <KeyPairIds>
               <Quantity>number of active key pairs for 
                  AwsAccountNumber</Quantity>
               <Items>
                  <KeyPairId>active key pair associated with 
                     AwsAccountNumber</KeyPairId>
               </Items>
            </KeyPairIds>
         </Signer>
      </Items>
   </ActiveTrustedSigners>
   <StreamingDistributionConfig>
      <CallerReference>unique description for this 
         distribution</CallerReference>
      <S3Origin>
         <DNSName>CloudFront domain name assigned to the 
            streaming distribution</DNSName>
         <OriginAccessIdentity>origin-access-identity/cloudfront/ID</OriginAccessIdentity>
      </S3Origin>
      <Aliases>
         <Quantity>number of CNAME aliases</Quantity>
         <Items>
            <CNAME>CNAME alias</CNAME>
         </Items>
      </Aliases>
      <Comment>comment about the distribution</Comment>
      <Logging>
         <Enabled>true | false</Enabled>
         <Bucket>Amazon S3 bucket for logs</Bucket>
         <Prefix>prefix for log file names</Prefix>
      </Logging>
      <TrustedSigners>
         <Quantity>number of trusted signers</Quantity>
         <Items>
            <AwsAccountNumber>self | AWS account that can create 
               signed URLs</AwsAccountNumber>
         </Items>
      </TrustedSigners>
      <PriceClass>maximum price class for the distribution</PriceClass>
      <Enabled>true | false</Enabled>
   </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.

Name	Description
`Id`	The identifier for the streaming distribution. For example: `EGTXBD79EXAMPLE`. Type: String Default: None
`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
`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., 2012-05-19T19:37:58Z) Default: None
`DomainName`	The domain name corresponding to the streaming distribution, for example, `s5c39gqb8ow64r.cloudfront.net`. Type: String Default: None
`ActiveTrustedSigners`	A complex type that lists the AWS accounts, if any, that you included in the `TrustedSigners` complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content. The `Signer` complex type lists the AWS account number of the trusted signer or `self` if the signer is the AWS account that created the distribution. The `Signer` element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no `KeyPairId` element appears for a `Signer`, that signer can't create signed URLs. For more information, go to Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. Type: Complex type Default: None Parent: `StreamingDistribution` Children: `Enabled`, `Quantity`, `Items`
`Enabled (ActiveTrustedSigners)`	`Enabled` is `true` if any of the AWS accounts that are listed in the `TrustedSigners` complex type for this streaming distribution have active CloudFront key pairs. If not, `Enabled` is `false`. For more information, see `ActiveTrustedSigners`. Type: String Default: None Valid Values: `true` \| `false` Parent: `ActiveTrustedSigners`
`Quantity (ActiveTrustedSigners)`	The number of trusted signers in the `TrustedSigners` complex type. For more information, see `ActiveTrustedSigners`. Type: Integer Default: None Parent: `ActiveTrustedSigners`
`Items (ActiveTrustedSigners)`	A complex type that contains one `Signer` complex type for each trusted signer that is specified in the `TrustedSigners` complex type. For more information, see `ActiveTrustedSigners`. Type: Complex Default: None Children: `Signer` Parent: `ActiveTrustedSigners`
`Signer`	A complex type that lists the AWS accounts that were included in the `TrustedSigners` complex type, as well as their active CloudFront key pair IDs, if any. For more information, see `ActiveTrustedSigners`. Type: Complex Default: None Children: `AWSAccountNumber`, `KeyPairIds` Parent: `Items`
`AwsAccountNumber`	An AWS account that is included in the `TrustedSigners` complex type for this streaming distribution. Valid values include: `self`, which is the AWS account that was used to create the distribution. An AWS account number. For more information, see `ActiveTrustedSigners`. Type: String Default: None Parent: `Signer`
`KeyPairIds`	A complex type that lists the active CloudFront key pairs, if any, that are associated with `AwsAccountNumber`. For more information, see `ActiveTrustedSigners`. Type: Complex Default: None Parent: `Signer`
`Quantity (KeyPairIds)`	The number of active CloudFront key pairs for `AwsAccountNumber`. For more information, see `ActiveTrustedSigners`. Type: Integer Default: None Parent: `KeyPairIds`
`Items (KeyPairIds)`	A complex type that lists the active CloudFront key pairs, if any, that are associated with `AwsAccountNumber`. For more information, see `ActiveTrustedSigners`. Type: Complex Default: None Child: `KeyPairId` Parent: `KeyPairIds`
`KeyPairId`	An active CloudFront key pair Id that is associated with `AwsAccountNumber`. For more information, see `ActiveTrustedSigners`. Type: String Default: None Parent: `Items (KeyPairIds)`
`StreamingDistributionConfig`	The current configuration information for the streaming distribution. Type: StreamingDistributionConfig Complex Type Default: None

Note

Even though a distribution might be deployed, you must enable the distribution for use before end users can retrieve content. To enable a distribution, change the value of the Enabled element for the StreamingDistributionConfig to true. For more information about the StreamingDistributionConfig, see StreamingDistributionConfig Complex Type.

Example

The following example shows a streaming distribution that includes all optional values.

<StreamingDistribution xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
   <Id>EGTXBD79EXAMPLE</Id>
   <Status>Deployed</Status>
   <LastModifiedTime>2012-05-19T19:37:58Z</LastModifiedTime>
   <DomainName>s5c39gqb8ow64r.cloudfront.net</DomainName>
   <ActiveTrustedSigners>
      <Quantity>3</Quantity>
      <Items>
         <Signer>
            <AwsAccountNumber>self</AwsAccountNumber>
            <KeyPairIds>
               <Quantity>1</Quantity>
               <Items>
                  <KeyPairId>APKA9ONS7QCOWEXAMPLE</KeyPairId>
               </Items>
            </KeyPairIds>
         </Signer>
         <Signer>
            <AwsAccountNumber>111122223333</AwsAccountNumber>
            <KeyPairIds>
               <Quantity>2</Quantity>
               <KeyPairId>APKAI72T5DYBXEXAMPLE</KeyPairId>
               <KeyPairId>APKAU72D8DYNXEXAMPLE</KeyPairId>
            </KeyPairIds>
         </Signer>
         <Signer>
            <AwsAccountNumber>444455556666</AwsAccountNumber>
            <KeyPairIds>
               <Quantity>0</Quantity>
            </KeyPairIds>
         </Signer>
      </Items>
   </ActiveTrustedSigners>
   <StreamingDistributionConfig>   
      <CallerReference>20120229090000</CallerReference>
      <S3Origin>
         <DNSName>mystreamingbucket.s3.amazonaws.com</DNSName>
         <OriginAccessIdentity>origin-access-identity/cloudfront/E74FTE3AEXAMPLE</OriginAccessIdentity>
      </S3Origin>
      <Aliases>
         <Quantity>1</Quantity>
         <Items>
            <CNAME>www.example.com</CNAME>
         </Items>
      </Aliases>
      <Comment>example comment</Comment>
      <Logging>
         <Enabled>true</Enabled>
         <Bucket>myawslogbucket.s3.amazonaws.com</Bucket>
         <Prefix>myprefix/</Prefix>
      </Logging>
      <TrustedSigners>
         <Quantity>3</Quantity>
         <Items>
            <AwsAccountNumber>self</AwsAccountNumber>
            <AwsAccountNumber>111122223333</AwsAccountNumber>
            <AwsAccountNumber>444455556666</AwsAccountNumber>
         </Items>
      </TrustedSigners>
      <PriceClass>PriceClass_All</PriceClass>
      <Enabled>true</Enabled>
   </StreamingDistributionConfig>
</StreamingDistribution>

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...