AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Elemental MediaPackage CreateOriginEndpoint API operation.

Syntax

New-EMPOriginEndpoint
-Id <String>
-Authorization_CdnIdentifierSecret <String>
-SpekeKeyProvider_CertificateArn <String>
-ChannelId <String>
-Encryption_ConstantInitializationVector <String>
-DashPackage <DashPackage>
-Description <String>
-Encryption_EncryptionMethod <CmafEncryptionMethod>
-CmafPackage_HlsManifest <HlsManifestCreateOrUpdateParameters[]>
-HlsPackage <HlsPackage>
-Encryption_KeyRotationIntervalSecond <Int32>
-ManifestName <String>
-StreamSelection_MaxVideoBitsPerSecond <Int32>
-StreamSelection_MinVideoBitsPerSecond <Int32>
-MssPackage <MssPackage>
-Origination <Origination>
-EncryptionContractConfiguration_PresetSpeke20Audio <PresetSpeke20Audio>
-EncryptionContractConfiguration_PresetSpeke20Video <PresetSpeke20Video>
-SpekeKeyProvider_ResourceId <String>
-SpekeKeyProvider_RoleArn <String>
-Authorization_SecretsRoleArn <String>
-CmafPackage_SegmentDurationSecond <Int32>
-CmafPackage_SegmentPrefix <String>
-StartoverWindowSecond <Int32>
-StreamSelection_StreamOrder <StreamOrder>
-SpekeKeyProvider_SystemId <String[]>
-Tag <Hashtable>
-TimeDelaySecond <Int32>
-SpekeKeyProvider_Url <String>
-Whitelist <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaPackageConfig>

Description

Creates a new OriginEndpoint record.

Parameters

-Authorization_CdnIdentifierSecret <String>
The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Authorization_SecretsRoleArn <String>
The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ChannelId <String>
The ID of the Channel that the OriginEndpoint will be associated with.This cannot be changed after the OriginEndpoint is created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaPackageConfig>
Amazon.PowerShell.Cmdlets.EMP.AmazonMediaPackageClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CmafPackage_HlsManifest <HlsManifestCreateOrUpdateParameters[]>
A list of HLS manifest configurations Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_HlsManifests
-CmafPackage_SegmentDurationSecond <Int32>
Duration (in seconds) of each segment. Actual segments will berounded to the nearest multiple of the source segment duration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_SegmentDurationSeconds
-CmafPackage_SegmentPrefix <String>
An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DashPackage <DashPackage>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A short text description of the OriginEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encryption_ConstantInitializationVector <String>
An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_ConstantInitializationVector
-Encryption_EncryptionMethod <CmafEncryptionMethod>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_EncryptionMethod
-Encryption_KeyRotationIntervalSecond <Int32>
Time (in seconds) between each encryption key rotation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_KeyRotationIntervalSeconds
-EncryptionContractConfiguration_PresetSpeke20Audio <PresetSpeke20Audio>
A collection of audio encryption presets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_EncryptionContractConfiguration_PresetSpeke20Audio
-EncryptionContractConfiguration_PresetSpeke20Video <PresetSpeke20Video>
A collection of video encryption presets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_EncryptionContractConfiguration_PresetSpeke20Video
-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)
-HlsPackage <HlsPackage>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Id <String>
The ID of the OriginEndpoint. The ID must be unique within the regionand it cannot be changed after the OriginEndpoint is created.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ManifestName <String>
A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MssPackage <MssPackage>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Origination <Origination>
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpointmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not berequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.MediaPackage.Model.CreateOriginEndpointResponse). Specifying the name of a property of type Amazon.MediaPackage.Model.CreateOriginEndpointResponse 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)
-SpekeKeyProvider_CertificateArn <String>
An Amazon Resource Name (ARN) of a Certificate Manager certificatethat MediaPackage will use for enforcing secure end-to-end datatransfer with the key provider service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_CertificateArn
-SpekeKeyProvider_ResourceId <String>
The resource ID to include in key requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_ResourceId
-SpekeKeyProvider_RoleArn <String>
An Amazon Resource Name (ARN) of an IAM role that AWS ElementalMediaPackage will assume when accessing the key provider service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_RoleArn
-SpekeKeyProvider_SystemId <String[]>
The system IDs to include in key requests. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_SystemIds
-SpekeKeyProvider_Url <String>
The URL of the external key provider service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_Encryption_SpekeKeyProvider_Url
-StartoverWindowSecond <Int32>
Maximum duration (seconds) of content to retain for startover playback.If not specified, startover playback will be disabled for the OriginEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStartoverWindowSeconds
-StreamSelection_MaxVideoBitsPerSecond <Int32>
The maximum video bitrate (bps) to include in output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_StreamSelection_MaxVideoBitsPerSecond
-StreamSelection_MinVideoBitsPerSecond <Int32>
The minimum video bitrate (bps) to include in output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_StreamSelection_MinVideoBitsPerSecond
-StreamSelection_StreamOrder <StreamOrder>
A directive that determines the order of streams in the output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCmafPackage_StreamSelection_StreamOrder
-Tag <Hashtable>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TimeDelaySecond <Int32>
Amount of delay (seconds) to enforce on the playback of live content.If not specified, there will be no time delay in effect for the OriginEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTimeDelaySeconds
-Whitelist <String[]>
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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.MediaPackage.Model.CreateOriginEndpointResponse
This cmdlet returns an Amazon.MediaPackage.Model.CreateOriginEndpointResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z