Package software.amazon.awscdk.services.medialive

Class CfnInput

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.medialive.CfnInput

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.178Z")
@Stability(Stable)
public class CfnInput
extends CfnResource
implements IInspectable, IInputRef, ITaggable

The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input.

A MediaLive input holds information that describes how the MediaLive channel is connected to the upstream system that is providing the source content that is to be transcoded.

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.medialive.*;
 Object tags;
 CfnInput cfnInput = CfnInput.Builder.create(this, "MyCfnInput")
         .destinations(List.of(InputDestinationRequestProperty.builder()
                 .network("network")
                 .networkRoutes(List.of(InputRequestDestinationRouteProperty.builder()
                         .cidr("cidr")
                         .gateway("gateway")
                         .build()))
                 .staticIpAddress("staticIpAddress")
                 .streamName("streamName")
                 .build()))
         .inputDevices(List.of(InputDeviceSettingsProperty.builder()
                 .id("id")
                 .build()))
         .inputNetworkLocation("inputNetworkLocation")
         .inputSecurityGroups(List.of("inputSecurityGroups"))
         .mediaConnectFlows(List.of(MediaConnectFlowRequestProperty.builder()
                 .flowArn("flowArn")
                 .build()))
         .multicastSettings(MulticastSettingsCreateRequestProperty.builder()
                 .sources(List.of(MulticastSourceCreateRequestProperty.builder()
                         .sourceIp("sourceIp")
                         .url("url")
                         .build()))
                 .build())
         .name("name")
         .roleArn("roleArn")
         .sdiSources(List.of("sdiSources"))
         .smpte2110ReceiverGroupSettings(Smpte2110ReceiverGroupSettingsProperty.builder()
                 .smpte2110ReceiverGroups(List.of(Smpte2110ReceiverGroupProperty.builder()
                         .sdpSettings(Smpte2110ReceiverGroupSdpSettingsProperty.builder()
                                 .ancillarySdps(List.of(InputSdpLocationProperty.builder()
                                         .mediaIndex(123)
                                         .sdpUrl("sdpUrl")
                                         .build()))
                                 .audioSdps(List.of(InputSdpLocationProperty.builder()
                                         .mediaIndex(123)
                                         .sdpUrl("sdpUrl")
                                         .build()))
                                 .videoSdp(InputSdpLocationProperty.builder()
                                         .mediaIndex(123)
                                         .sdpUrl("sdpUrl")
                                         .build())
                                 .build())
                         .build()))
                 .build())
         .sources(List.of(InputSourceRequestProperty.builder()
                 .passwordParam("passwordParam")
                 .url("url")
                 .username("username")
                 .build()))
         .srtSettings(SrtSettingsRequestProperty.builder()
                 .srtCallerSources(List.of(SrtCallerSourceRequestProperty.builder()
                         .decryption(SrtCallerDecryptionRequestProperty.builder()
                                 .algorithm("algorithm")
                                 .passphraseSecretArn("passphraseSecretArn")
                                 .build())
                         .minimumLatency(123)
                         .srtListenerAddress("srtListenerAddress")
                         .srtListenerPort("srtListenerPort")
                         .streamId("streamId")
                         .build()))
                 .build())
         .tags(tags)
         .type("type")
         .vpc(InputVpcRequestProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnInput.Builder	A fluent builder for CfnInput.
static interface	CfnInput.InputDestinationRequestProperty	Settings that apply only if the input is a push type of input.
static interface	CfnInput.InputDeviceRequestProperty	Example:
static interface	CfnInput.InputDeviceSettingsProperty	Settings that apply only if the input is an Elemental Link input.
static interface	CfnInput.InputRequestDestinationRouteProperty	Example:
static interface	CfnInput.InputSdpLocationProperty	Example:
static interface	CfnInput.InputSourceRequestProperty	Settings that apply only if the input is a pull type of input.
static interface	CfnInput.InputVpcRequestProperty	Settings that apply only if the input is an push input where the source is on Amazon VPC.
static interface	CfnInput.MediaConnectFlowRequestProperty	Settings that apply only if the input is a MediaConnect input.
static interface	CfnInput.MulticastSettingsCreateRequestProperty	Example:
static interface	CfnInput.MulticastSourceCreateRequestProperty	Example:
static interface	CfnInput.Smpte2110ReceiverGroupProperty	Example:
static interface	CfnInput.Smpte2110ReceiverGroupSdpSettingsProperty	Example:
static interface	CfnInput.Smpte2110ReceiverGroupSettingsProperty	Example:
static interface	CfnInput.SrtCallerDecryptionRequestProperty	Example:
static interface	CfnInput.SrtCallerSourceRequestProperty	Example:
static interface	CfnInput.SrtSettingsRequestProperty	Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.medialive.IInputRef

IInputRef.Jsii$Default, IInputRef.Jsii$Proxy

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.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
protected	CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInput(software.amazon.jsii.JsiiObjectRef objRef)
	CfnInput(software.constructs.Construct scope, String id)
	CfnInput(software.constructs.Construct scope, String id, CfnInputProps props)

Method Summary

Modifier and Type	Method	Description
static IInputRef	fromInputArn(software.constructs.Construct scope, String id, String arn)	Creates a new IInputRef from an ARN.
static IInputRef	fromInputId(software.constructs.Construct scope, String id, String inputId)	Creates a new IInputRef from a inputId.
String	getAttrArn()	The ARN of the MediaLive input.
List<String>	getAttrDestinations()	For a push input, the the destination or destinations for the input.
String	getAttrId()	The unique ID for the device.
List<String>	getAttrSources()	For a pull input, the source or sources for the input.
protected Map<String,Object>	getCfnProperties()
Object	getDestinations()	Settings that apply only if the input is a push type of input.
Object	getInputDevices()	Settings that apply only if the input is an Elemental Link input.
String	getInputNetworkLocation()
InputReference	getInputRef()	A reference to a Input resource.
List<String>	getInputSecurityGroups()	The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
Object	getMediaConnectFlows()	Settings that apply only if the input is a MediaConnect input.
Object	getMulticastSettings()	Returns union: either IResolvable or CfnInput.MulticastSettingsCreateRequestProperty
String	getName()	A name for the input.
String	getRoleArn()	The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.
List<String>	getSdiSources()
Object	getSmpte2110ReceiverGroupSettings()	Returns union: either IResolvable or CfnInput.Smpte2110ReceiverGroupSettingsProperty
Object	getSources()	Settings that apply only if the input is a pull type of input.
Object	getSrtSettings()	Returns union: either IResolvable or CfnInput.SrtSettingsRequestProperty
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Object	getTagsRaw()	A collection of tags for this input.
String	getType()	The type for this input.
Object	getVpc()	Settings that apply only if the input is an push input where the source is on Amazon VPC.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestinations(List<Object> value)	Settings that apply only if the input is a push type of input.
void	setDestinations(IResolvable value)	Settings that apply only if the input is a push type of input.
void	setInputDevices(List<Object> value)	Settings that apply only if the input is an Elemental Link input.
void	setInputDevices(IResolvable value)	Settings that apply only if the input is an Elemental Link input.
void	setInputNetworkLocation(String value)
void	setInputSecurityGroups(List<String> value)	The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
void	setMediaConnectFlows(List<Object> value)	Settings that apply only if the input is a MediaConnect input.
void	setMediaConnectFlows(IResolvable value)	Settings that apply only if the input is a MediaConnect input.
void	setMulticastSettings(IResolvable value)
void	setMulticastSettings(CfnInput.MulticastSettingsCreateRequestProperty value)
void	setName(String value)	A name for the input.
void	setRoleArn(String value)	The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.
void	setSdiSources(List<String> value)
void	setSmpte2110ReceiverGroupSettings(IResolvable value)
void	setSmpte2110ReceiverGroupSettings(CfnInput.Smpte2110ReceiverGroupSettingsProperty value)
void	setSources(List<Object> value)	Settings that apply only if the input is a pull type of input.
void	setSources(IResolvable value)	Settings that apply only if the input is a pull type of input.
void	setSrtSettings(IResolvable value)
void	setSrtSettings(CfnInput.SrtSettingsRequestProperty value)
void	setTagsRaw(Object value)	A collection of tags for this input.
void	setType(String value)	The type for this input.
void	setVpc(IResolvable value)	Settings that apply only if the input is an push input where the source is on Amazon VPC.
void	setVpc(CfnInput.InputVpcRequestProperty value)	Settings that apply only if the input is an push input where the source is on Amazon VPC.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

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

CfnInput

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

CfnInput

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

CfnInput

@Stability(Stable)
public CfnInput(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnInputProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnInput

@Stability(Stable)
public CfnInput(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

fromInputArn

@Stability(Stable)
@NotNull
public static IInputRef fromInputArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IInputRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromInputId

@Stability(Stable)
@NotNull
public static IInputRef fromInputId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String inputId)

Creates a new IInputRef from a inputId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

inputId - This parameter is required.

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrArn()

The ARN of the MediaLive input.

For example: arn:aws:medialive:us-west-1:111122223333:medialive:input:1234567. MediaLive creates this ARN when it creates the input.

getAttrDestinations

@Stability(Stable)
@NotNull
public List<String> getAttrDestinations()

For a push input, the the destination or destinations for the input.

The destinations are the URLs of locations on MediaLive where the upstream system pushes the content to, for this input. MediaLive creates these addresses when it creates the input.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique ID for the device.

getAttrSources

@Stability(Stable)
@NotNull
public List<String> getAttrSources()

For a pull input, the source or sources for the input.

The sources are the URLs of locations on the upstream system where MediaLive pulls the content from, for this input. You included these URLs in the create request.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getInputRef

@Stability(Stable)
@NotNull
public InputReference getInputRef()

A reference to a Input resource.

Specified by:

getInputRef in interface IInputRef

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDestinations

@Stability(Stable)
@Nullable
public Object getDestinations()

Settings that apply only if the input is a push type of input.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInput.InputDestinationRequestProperty>

setDestinations

@Stability(Stable)
public void setDestinations(@Nullable
 IResolvable value)

Settings that apply only if the input is a push type of input.

setDestinations

@Stability(Stable)
public void setDestinations(@Nullable
 List<Object> value)

Settings that apply only if the input is a push type of input.

getInputDevices

@Stability(Stable)
@Nullable
public Object getInputDevices()

Settings that apply only if the input is an Elemental Link input.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInput.InputDeviceSettingsProperty>

setInputDevices

@Stability(Stable)
public void setInputDevices(@Nullable
 IResolvable value)

Settings that apply only if the input is an Elemental Link input.

setInputDevices

@Stability(Stable)
public void setInputDevices(@Nullable
 List<Object> value)

Settings that apply only if the input is an Elemental Link input.

getInputNetworkLocation

@Stability(Stable)
@Nullable
public String getInputNetworkLocation()

setInputNetworkLocation

@Stability(Stable)
public void setInputNetworkLocation(@Nullable
 String value)

getInputSecurityGroups

@Stability(Stable)
@Nullable
public List<String> getInputSecurityGroups()

The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.

setInputSecurityGroups

@Stability(Stable)
public void setInputSecurityGroups(@Nullable
 List<String> value)

The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.

getMediaConnectFlows

@Stability(Stable)
@Nullable
public Object getMediaConnectFlows()

Settings that apply only if the input is a MediaConnect input.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInput.MediaConnectFlowRequestProperty>

setMediaConnectFlows

@Stability(Stable)
public void setMediaConnectFlows(@Nullable
 IResolvable value)

Settings that apply only if the input is a MediaConnect input.

setMediaConnectFlows

@Stability(Stable)
public void setMediaConnectFlows(@Nullable
 List<Object> value)

Settings that apply only if the input is a MediaConnect input.

getMulticastSettings

@Stability(Stable)
@Nullable
public Object getMulticastSettings()

Returns union: either IResolvable or CfnInput.MulticastSettingsCreateRequestProperty

setMulticastSettings

@Stability(Stable)
public void setMulticastSettings(@Nullable
 IResolvable value)

setMulticastSettings

@Stability(Stable)
public void setMulticastSettings(@Nullable
 CfnInput.MulticastSettingsCreateRequestProperty value)

getName

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

A name for the input.

setName

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

A name for the input.

getRoleArn

@Stability(Stable)
@Nullable
public String getRoleArn()

The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.

setRoleArn

@Stability(Stable)
public void setRoleArn(@Nullable
 String value)

The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.

getSdiSources

@Stability(Stable)
@Nullable
public List<String> getSdiSources()

setSdiSources

@Stability(Stable)
public void setSdiSources(@Nullable
 List<String> value)

getSmpte2110ReceiverGroupSettings

@Stability(Stable)
@Nullable
public Object getSmpte2110ReceiverGroupSettings()

Returns union: either IResolvable or CfnInput.Smpte2110ReceiverGroupSettingsProperty

setSmpte2110ReceiverGroupSettings

@Stability(Stable)
public void setSmpte2110ReceiverGroupSettings(@Nullable
 IResolvable value)

setSmpte2110ReceiverGroupSettings

@Stability(Stable)
public void setSmpte2110ReceiverGroupSettings(@Nullable
 CfnInput.Smpte2110ReceiverGroupSettingsProperty value)

getSources

@Stability(Stable)
@Nullable
public Object getSources()

Settings that apply only if the input is a pull type of input.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInput.InputSourceRequestProperty>

setSources

@Stability(Stable)
public void setSources(@Nullable
 IResolvable value)

Settings that apply only if the input is a pull type of input.

setSources

@Stability(Stable)
public void setSources(@Nullable
 List<Object> value)

Settings that apply only if the input is a pull type of input.

getSrtSettings

@Stability(Stable)
@Nullable
public Object getSrtSettings()

Returns union: either IResolvable or CfnInput.SrtSettingsRequestProperty

setSrtSettings

@Stability(Stable)
public void setSrtSettings(@Nullable
 IResolvable value)

setSrtSettings

@Stability(Stable)
public void setSrtSettings(@Nullable
 CfnInput.SrtSettingsRequestProperty value)

getTagsRaw

@Stability(Stable)
@Nullable
public Object getTagsRaw()

A collection of tags for this input.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Object value)

A collection of tags for this input.

getType

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

The type for this input.

setType

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

The type for this input.

getVpc

@Stability(Stable)
@Nullable
public Object getVpc()

Settings that apply only if the input is an push input where the source is on Amazon VPC.

Returns union: either IResolvable or CfnInput.InputVpcRequestProperty

setVpc

@Stability(Stable)
public void setVpc(@Nullable
 IResolvable value)

Settings that apply only if the input is an push input where the source is on Amazon VPC.

setVpc

@Stability(Stable)
public void setVpc(@Nullable
 CfnInput.InputVpcRequestProperty value)

Settings that apply only if the input is an push input where the source is on Amazon VPC.