Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon CloudFront Resource Types Reference » AWS::CloudFront::StreamingDistribution

AWS::CloudFront::StreamingDistribution

The AWS::CloudFront::StreamingDistribution resource specifies an RMTP distribution for Amazon CloudFront. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. For more information, see CreateStreamingDistribution in the Amazon CloudFront API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CloudFront::StreamingDistribution",
  "Properties" : {
    "StreamingDistributionConfig" : StreamingDistributionConfig,
    "Tags" : [ Tag, ... ]
  }
}

YAML

Type: AWS::CloudFront::StreamingDistribution
Properties:
  StreamingDistributionConfig: StreamingDistributionConfig
  Tags: 
    - Tag

Properties

StreamingDistributionConfig

Information about the configuration of the RMTP streaming distribution.

Required: Yes

Type: StreamingDistributionConfig

Update requires: No interruption

Tags

Key-value tags to assign to this streaming distribution.

Required: Yes

Type: List of Resource Tag

Update requires: No interruption

Duplicates not allowed.

Return Values

Ref

When you pass the logical ID of an AWS::CloudFront::StreamingDistribution resource to the intrinsic Ref function, the function returns the streaming distribution ID, such as E1E7FEN9T35R9W.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

DomainName

The domain name of the resource, such as sct27g85mgx04.cloudfront.net.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Example

The following example specifies a streaming distribution and assigns it a single tag.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "streamingdistribution": {
            "Type": "AWS::CloudFront::StreamingDistribution",
            "Properties": {
                "StreamingDistributionConfig": {
                    "Aliases": [
                        "string-values"
                    ],
                    "Comment": "string-value",
                    "Enabled": "boolean-value",
                    "Logging": {
                        "Bucket": "string-value",
                        "Enabled": "boolean-value",
                        "Prefix": "string-value"
                    },
                    "PriceClass": "string-value",
                    "S3Origin": {
                        "DomainName": "string-value",
                        "OriginAccessIdentity": "string-value"
                    },
                    "TrustedSigners": {
                        "Enabled": "boolean-value",
                        "AwsAccountNumbers": [
                            "string-values"
                        ]
                    }
                },
                "Tags": [
                    {
                        "Key": "string-value",
                        "Value": "string-value"
                    }
                ]
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources:
  streamingdistribution:
    Type: AWS::CloudFront::StreamingDistribution
    Properties:
      StreamingDistributionConfig:
        Aliases:
          - string-values
        Comment: string-value
        Enabled: boolean-value
        Logging:
          Bucket: string-value
          Enabled: boolean-value
          Prefix: string-value
        PriceClass: string-value
        S3Origin:
          DomainName: string-value
          OriginAccessIdentity: string-value
        TrustedSigners:
          Enabled: boolean-value
          AwsAccountNumbers:
            - string-values
      Tags:
        - Key: string-value
          Value: string-value

See Also