software.amazon.awscdk.services.mediapackage

Class CfnChannel

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediapackage.CfnChannel

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.800Z")
public class CfnChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaPackage::Channel`.

Creates a channel to receive content.

After it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

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.mediapackage.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .id("id")
         // the properties below are optional
         .description("description")
         .egressAccessLogs(LogConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .hlsIngest(HlsIngestProperty.builder()
                 .ingestEndpoints(List.of(IngestEndpointProperty.builder()
                         .id("id")
                         .password("password")
                         .url("url")
                         .username("username")
                         .build()))
                 .build())
         .ingressAccessLogs(LogConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnChannel.Builder A fluent builder for CfnChannel.
static interface	CfnChannel.HlsIngestProperty Example:
static interface	CfnChannel.IngestEndpointProperty Example:
static interface	CfnChannel.LogConfigurationProperty The access log configuration parameters for your channel.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The channel's unique system-generated resource name, based on the AWS record.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() Any descriptive information that you want to add to the channel for future identification purposes.
java.lang.Object	getEgressAccessLogs() Configures egress access logs.
java.lang.Object	getHlsIngest() `AWS::MediaPackage::Channel.HlsIngest`.
java.lang.String	getId() Unique identifier that you assign to the channel.
java.lang.Object	getIngressAccessLogs() Configures ingress access logs.
TagManager	getTags() The tags to assign to the channel.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) Any descriptive information that you want to add to the channel for future identification purposes.
void	setEgressAccessLogs(CfnChannel.LogConfigurationProperty value) Configures egress access logs.
void	setEgressAccessLogs(IResolvable value) Configures egress access logs.
void	setHlsIngest(CfnChannel.HlsIngestProperty value) `AWS::MediaPackage::Channel.HlsIngest`.
void	setHlsIngest(IResolvable value) `AWS::MediaPackage::Channel.HlsIngest`.
void	setId(java.lang.String value) Unique identifier that you assign to the channel.
void	setIngressAccessLogs(CfnChannel.LogConfigurationProperty value) Configures ingress access logs.
void	setIngressAccessLogs(IResolvable value) Configures ingress access logs.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnChannel(Construct scope,
                  java.lang.String id,
                  CfnChannelProps props)

Create a new `AWS::MediaPackage::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. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The channel's unique system-generated resource name, based on the AWS record.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to assign to the channel.

getId

public java.lang.String getId()

Unique identifier that you assign to the channel.

setId

public void setId(java.lang.String value)

Unique identifier that you assign to the channel.

getDescription

public java.lang.String getDescription()

Any descriptive information that you want to add to the channel for future identification purposes.

setDescription

public void setDescription(java.lang.String value)

Any descriptive information that you want to add to the channel for future identification purposes.

getEgressAccessLogs

public java.lang.Object getEgressAccessLogs()

Configures egress access logs.

setEgressAccessLogs

public void setEgressAccessLogs(IResolvable value)

Configures egress access logs.

setEgressAccessLogs

public void setEgressAccessLogs(CfnChannel.LogConfigurationProperty value)

Configures egress access logs.

getHlsIngest

public java.lang.Object getHlsIngest()

`AWS::MediaPackage::Channel.HlsIngest`.

setHlsIngest

public void setHlsIngest(IResolvable value)

`AWS::MediaPackage::Channel.HlsIngest`.

setHlsIngest

public void setHlsIngest(CfnChannel.HlsIngestProperty value)

`AWS::MediaPackage::Channel.HlsIngest`.

getIngressAccessLogs

public java.lang.Object getIngressAccessLogs()

Configures ingress access logs.

setIngressAccessLogs

public void setIngressAccessLogs(IResolvable value)

Configures ingress access logs.

setIngressAccessLogs

public void setIngressAccessLogs(CfnChannel.LogConfigurationProperty value)

Configures ingress access logs.