software.amazon.awscdk.services.mediapackage

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.mediapackage.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.916Z")
 @Stability(value=Stable)
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())
         .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.LogConfigurationProperty The access log configuration parameters for your channel.

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, 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
String	getAttrArn() The channel's unique system-generated resource name, based on the AWS record.
protected Map<String,Object>	getCfnProperties()
String	getDescription() Any descriptive information that you want to add to the channel for future identification purposes.
Object	getEgressAccessLogs() Configures egress access logs.
String	getId() Unique identifier that you assign to the channel.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(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	setId(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.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,
                                           @NotNull
                                           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

@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's unique system-generated resource name, based on the AWS record.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags to assign to the channel.

getId

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

Unique identifier that you assign to the channel.

setId

@Stability(value=Stable)
public void setId(@NotNull
                                           String value)

Unique identifier that you assign to the channel.

getDescription

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

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

setDescription

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

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

getEgressAccessLogs

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

Configures egress access logs.

setEgressAccessLogs

@Stability(value=Stable)
public void setEgressAccessLogs(@Nullable
                                                         CfnChannel.LogConfigurationProperty value)

Configures egress access logs.

setEgressAccessLogs

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

Configures egress access logs.

getIngressAccessLogs

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

Configures ingress access logs.

setIngressAccessLogs

@Stability(value=Stable)
public void setIngressAccessLogs(@Nullable
                                                          CfnChannel.LogConfigurationProperty value)

Configures ingress access logs.

setIngressAccessLogs

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

Configures ingress access logs.