Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon CloudFront CreateStreamingDistribution API operation.

Syntax

New-CFStreamingDistribution
-S3Origin_DomainName <String>
-Logging_Bucket <String>
-StreamingDistributionConfig_CallerReference <String>
-StreamingDistributionConfig_Comment <String>
-StreamingDistributionConfig_Enabled <Boolean>
-Logging_Enabled <Boolean>
-TrustedSigners_Enabled <Boolean>
-Aliases_Item <String[]>
-TrustedSigners_Item <String[]>
-S3Origin_OriginAccessIdentity <String>
-Logging_Prefix <String>
-StreamingDistributionConfig_PriceClass <PriceClass>
-Aliases_Quantity <Int32>
-TrustedSigners_Quantity <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudFrontConfig>

Description

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

Parameters

-Aliases_Item <String[]>
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_Aliases_Items
-Aliases_Quantity <Int32>
The number of CNAME aliases, if any, that you want to associate with this distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_Aliases_Quantity
-ClientConfig <AmazonCloudFrontConfig>
Amazon.PowerShell.Cmdlets.CF.AmazonCloudFrontClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Logging_Bucket <String>
The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_Logging_Bucket
-Logging_Enabled <Boolean>
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_Logging_Enabled
-Logging_Prefix <String>
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_Logging_Prefix
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the S3Origin_DomainName parameter. The -PassThru parameter is deprecated, use -Select '^S3Origin_DomainName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Origin_DomainName <String>
The DNS name of the Amazon S3 origin.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
AliasesStreamingDistributionConfig_S3Origin_DomainName
-S3Origin_OriginAccessIdentity <String>
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.To replace the origin access identity, update the distribution configuration and specify the new origin access identity.For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_S3Origin_OriginAccessIdentity
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateStreamingDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateStreamingDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamingDistributionConfig_CallerReference <String>
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamingDistributionConfig_Comment <String>
Any comments you want to include about the streaming distribution.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamingDistributionConfig_Enabled <Boolean>
Whether the streaming distribution is enabled to accept user requests for content.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamingDistributionConfig_PriceClass <PriceClass>
A complex type that contains information about price class for this streaming distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrustedSigners_Enabled <Boolean>
This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_TrustedSigners_Enabled
-TrustedSigners_Item <String[]>
A list of Amazon Web Services account identifiers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_TrustedSigners_Items
-TrustedSigners_Quantity <Int32>
The number of Amazon Web Services accounts in the list.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamingDistributionConfig_TrustedSigners_Quantity

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CloudFront.Model.CreateStreamingDistributionResponse
This cmdlet returns an Amazon.CloudFront.Model.CreateStreamingDistributionResponse object containing multiple properties.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.793.0