software.amazon.awscdk.services.ivs

Class CfnChannel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ivs.CfnChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.106Z")
 @Stability(value=Stable)
public class CfnChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IVS::Channel`.

The AWS::IVS::Channel resource specifies an channel. A channel stores configuration information related to your live stream. For more information, see CreateChannel in the Amazon Interactive Video Service API Reference .

By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The Channel resource does not create a stream key; to create a stream key, use the StreamKey resource instead.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .authorized(false)
         .latencyMode("latencyMode")
         .name("name")
         .recordingConfigurationArn("recordingConfigurationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnChannel.Builder A fluent builder for CfnChannel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnChannel(software.constructs.Construct scope, String id) Create a new `AWS::IVS::Channel`.
	CfnChannel(software.constructs.Construct scope, String id, CfnChannelProps props) Create a new `AWS::IVS::Channel`.
protected	CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The channel ARN.
String	getAttrIngestEndpoint() Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
String	getAttrPlaybackUrl() Channel playback URL.
Object	getAuthorized() Whether the channel is authorized.
protected Map<String,Object>	getCfnProperties()
String	getLatencyMode() Channel latency mode.
String	getName() Channel name.
String	getRecordingConfigurationArn() The ARN of a RecordingConfiguration resource.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getType() The channel type, which determines the allowable resolution and bitrate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorized(Boolean value) Whether the channel is authorized.
void	setAuthorized(IResolvable value) Whether the channel is authorized.
void	setLatencyMode(String value) Channel latency mode.
void	setName(String value) Channel name.
void	setRecordingConfigurationArn(String value) The ARN of a RecordingConfiguration resource.
void	setType(String value) The channel type, which determines the allowable resolution and bitrate.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnChannel

protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

CfnChannel

protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnChannel

@Stability(value=Stable)
public CfnChannel(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           CfnChannelProps props)

Create a new `AWS::IVS::Channel`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnChannel

@Stability(value=Stable)
public CfnChannel(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)

Create a new `AWS::IVS::Channel`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The channel ARN.

For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

getAttrIngestEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrIngestEndpoint()

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

For example: a1b2c3d4e5f6.global-contribute.live-video.net

getAttrPlaybackUrl

@Stability(value=Stable)
 @NotNull
public String getAttrPlaybackUrl()

Channel playback URL.

For example: https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getAuthorized

@Stability(value=Stable)
 @Nullable
public Object getAuthorized()

Whether the channel is authorized.

Default : false

setAuthorized

@Stability(value=Stable)
public void setAuthorized(@Nullable
                                                   Boolean value)

Whether the channel is authorized.

Default : false

setAuthorized

@Stability(value=Stable)
public void setAuthorized(@Nullable
                                                   IResolvable value)

Whether the channel is authorized.

Default : false

getLatencyMode

@Stability(value=Stable)
 @Nullable
public String getLatencyMode()

Channel latency mode. Valid values:.

• NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
• LOW : Use LOW for near real-time interactions with viewers.

In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

Default : LOW

setLatencyMode

@Stability(value=Stable)
public void setLatencyMode(@Nullable
                                                    String value)

Channel latency mode. Valid values:.

• NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
• LOW : Use LOW for near real-time interactions with viewers.

In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

Default : LOW

getName

@Stability(value=Stable)
 @Nullable
public String getName()

Channel name.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

Channel name.

getRecordingConfigurationArn

@Stability(value=Stable)
 @Nullable
public String getRecordingConfigurationArn()

The ARN of a RecordingConfiguration resource.

An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

Default : "" (empty string, recording is disabled)

setRecordingConfigurationArn

@Stability(value=Stable)
public void setRecordingConfigurationArn(@Nullable
                                                                  String value)

The ARN of a RecordingConfiguration resource.

An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

Default : "" (empty string, recording is disabled)

getType

@Stability(value=Stable)
 @Nullable
public String getType()

The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

• STANDARD : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
• BASIC : delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Default : STANDARD

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

• STANDARD : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
• BASIC : delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Default : STANDARD