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, 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.910Z")
 @Stability(value=Stable)
public class CfnInput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaLive::Input`.

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()
                 .streamName("streamName")
                 .build()))
         .inputDevices(List.of(InputDeviceSettingsProperty.builder()
                 .id("id")
                 .build()))
         .inputSecurityGroups(List.of("inputSecurityGroups"))
         .mediaConnectFlows(List.of(MediaConnectFlowRequestProperty.builder()
                 .flowArn("flowArn")
                 .build()))
         .name("name")
         .roleArn("roleArn")
         .sources(List.of(InputSourceRequestProperty.builder()
                 .passwordParam("passwordParam")
                 .url("url")
                 .username("username")
                 .build()))
         .tags(tags)
         .type("type")
         .vpc(InputVpcRequestProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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 This entity is not used.
static interface	CfnInput.InputDeviceSettingsProperty Settings that apply only if the input is an Elemental Link input.
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.

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
	CfnInput(software.constructs.Construct scope, String id) Create a new `AWS::MediaLive::Input`.
	CfnInput(software.constructs.Construct scope, String id, CfnInputProps props) Create a new `AWS::MediaLive::Input`.
protected	CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the MediaLive input.
List<String>	getAttrDestinations() For a push input, the the destination or destinations for the input.
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.
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.
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.
Object	getSources() Settings that apply only if the input is a pull type of input.
TagManager	getTags() 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(IResolvable value) Settings that apply only if the input is a push type of input.
void	setDestinations(List<Object> value) Settings that apply only if the input is a push type of input.
void	setInputDevices(IResolvable value) Settings that apply only if the input is an Elemental Link input.
void	setInputDevices(List<Object> value) Settings that apply only if the input is an Elemental Link input.
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(IResolvable value) Settings that apply only if the input is a MediaConnect input.
void	setMediaConnectFlows(List<Object> value) Settings that apply only if the input is a MediaConnect input.
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	setSources(IResolvable value) Settings that apply only if the input is a pull type of input.
void	setSources(List<Object> value) Settings that apply only if the input is a pull type of input.
void	setType(String value) The type for this input.
void	setVpc(CfnInput.InputVpcRequestProperty value) Settings that apply only if the input is an push input where the source is on Amazon VPC.
void	setVpc(IResolvable 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, 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

CfnInput

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

CfnInput

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

CfnInput

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

Create a new `AWS::MediaLive::Input`.

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.

CfnInput

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

Create a new `AWS::MediaLive::Input`.

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 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(value=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.

getAttrSources

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

A collection of tags for this input.

Each tag is a key-value pair.

getDestinations

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

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

setDestinations

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

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

setDestinations

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

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

getInputDevices

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

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

setInputDevices

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

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

setInputDevices

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

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

getInputSecurityGroups

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getMediaConnectFlows()

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

setMediaConnectFlows

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

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

setMediaConnectFlows

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

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

getName

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

A name for the input.

setName

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

A name for the input.

getRoleArn

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

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

This doesn't apply to other types of inputs. The role is identified by its ARN.

setRoleArn

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

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

This doesn't apply to other types of inputs. The role is identified by its ARN.

getSources

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

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

setSources

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

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

setSources

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

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

getType

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

The type for this input.

setType

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

The type for this input.

getVpc

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

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

setVpc

@Stability(value=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.

setVpc

@Stability(value=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.