Package software.amazon.awscdk.services.mediapackage

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
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:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:43:33.710Z") @Stability(Stable) public class CfnChannel extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.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
    Description
    static final class 
    CfnChannel.Builder
    A fluent builder for CfnChannel.
    static interface 
    CfnChannel.HlsIngestProperty
    HLS ingest configuration.
    static interface 
    CfnChannel.IngestEndpointProperty
    An endpoint for ingesting source content for a channel.
    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.core.IConstruct

    software.amazon.awscdk.core.IConstruct.Jsii$Default

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

    software.constructs.IConstruct.Jsii$Default

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

    software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.IInspectable.Jsii$Proxy

  • Field Summary

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

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnChannel(software.amazon.awscdk.core.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
    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.
    Object
    getHlsIngest()
    The input URL where the source stream should be sent.
    String
    getId()
    Unique identifier that you assign to the channel.
    Object
    getIngressAccessLogs()
    Configures ingress access logs.
    software.amazon.awscdk.core.TagManager
    getTags()
    The tags to assign to the channel.
    void
    inspect(software.amazon.awscdk.core.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(software.amazon.awscdk.core.IResolvable value)
    Configures egress access logs.
    void
    setEgressAccessLogs(CfnChannel.LogConfigurationProperty value)
    Configures egress access logs.
    void
    setHlsIngest(software.amazon.awscdk.core.IResolvable value)
    The input URL where the source stream should be sent.
    void
    setHlsIngest(CfnChannel.HlsIngestProperty value)
    The input URL where the source stream should be sent.
    void
    setId(String value)
    Unique identifier that you assign to the channel.
    void
    setIngressAccessLogs(software.amazon.awscdk.core.IResolvable value)
    Configures ingress access logs.
    void
    setIngressAccessLogs(CfnChannel.LogConfigurationProperty 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 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 Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannel

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

    • CfnChannel

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

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull software.amazon.awscdk.core.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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull software.amazon.awscdk.core.TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface software.amazon.awscdk.core.IInspectable
      Parameters:
      inspector - - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class software.amazon.awscdk.core.CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The channel's unique system-generated resource name, based on the AWS record.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class software.amazon.awscdk.core.CfnResource

    • getTags

      @Stability(Stable) @NotNull public software.amazon.awscdk.core.TagManager getTags()
      The tags to assign to the channel.

    • getId

      @Stability(Stable) @NotNull public String getId()
      Unique identifier that you assign to the channel.

    • setId

      @Stability(Stable) public void setId(@NotNull String value)
      Unique identifier that you assign to the channel.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Any descriptive information that you want to add to the channel for future identification purposes.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Any descriptive information that you want to add to the channel for future identification purposes.

    • getEgressAccessLogs

      @Stability(Stable) @Nullable public Object getEgressAccessLogs()
      Configures egress access logs.

    • setEgressAccessLogs

      @Stability(Stable) public void setEgressAccessLogs(@Nullable software.amazon.awscdk.core.IResolvable value)
      Configures egress access logs.

    • setEgressAccessLogs

      @Stability(Stable) public void setEgressAccessLogs(@Nullable CfnChannel.LogConfigurationProperty value)
      Configures egress access logs.

    • getHlsIngest

      @Stability(Stable) @Nullable public Object getHlsIngest()
      The input URL where the source stream should be sent.

    • setHlsIngest

      @Stability(Stable) public void setHlsIngest(@Nullable software.amazon.awscdk.core.IResolvable value)
      The input URL where the source stream should be sent.

    • setHlsIngest

      @Stability(Stable) public void setHlsIngest(@Nullable CfnChannel.HlsIngestProperty value)
      The input URL where the source stream should be sent.

    • getIngressAccessLogs

      @Stability(Stable) @Nullable public Object getIngressAccessLogs()
      Configures ingress access logs.

    • setIngressAccessLogs

      @Stability(Stable) public void setIngressAccessLogs(@Nullable software.amazon.awscdk.core.IResolvable value)
      Configures ingress access logs.

    • setIngressAccessLogs

      @Stability(Stable) public void setIngressAccessLogs(@Nullable CfnChannel.LogConfigurationProperty value)
      Configures ingress access logs.