CfnInput

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.788Z")
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 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.

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
	`CfnInput(Construct scope, java.lang.String id)` Create a new `AWS::MediaLive::Input`.
	`CfnInput(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The ARN of the MediaLive input.
`java.util.List<java.lang.String>`	`getAttrDestinations()` For a push input, the the destination or destinations for the input.
`java.util.List<java.lang.String>`	`getAttrSources()` For a pull input, the source or sources for the input.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDestinations()` Settings that apply only if the input is a push type of input.
`java.lang.Object`	`getInputDevices()` Settings that apply only if the input is an Elemental Link input.
`java.util.List<java.lang.String>`	`getInputSecurityGroups()` The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
`java.lang.Object`	`getMediaConnectFlows()` Settings that apply only if the input is a MediaConnect input.
`java.lang.String`	`getName()` A name for the input.
`java.lang.String`	`getRoleArn()` The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.
`java.lang.Object`	`getSources()` Settings that apply only if the input is a pull type of input.
`TagManager`	`getTags()` A collection of tags for this input.
`java.lang.String`	`getType()` The type for this input.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDestinations(IResolvable value)` Settings that apply only if the input is a push type of input.
`void`	`setDestinations(java.util.List<java.lang.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(java.util.List<java.lang.Object> value)` Settings that apply only if the input is an Elemental Link input.
`void`	`setInputSecurityGroups(java.util.List<java.lang.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(java.util.List<java.lang.Object> value)` Settings that apply only if the input is a MediaConnect input.
`void`	`setName(java.lang.String value)` A name for the input.
`void`	`setRoleArn(java.lang.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(java.util.List<java.lang.Object> value)` Settings that apply only if the input is a pull type of input.
`void`	`setType(java.lang.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.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
  - CfnInput
```
protected CfnInput(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnInput
```
protected CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnInput
```
public CfnInput(Construct scope,
                java.lang.String id,
                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
```
public CfnInput(Construct scope,
                java.lang.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
```
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 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
```
public java.util.List<java.lang.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
```
public java.util.List<java.lang.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
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    A collection of tags for this input.
    Each tag is a key-value pair.
  - getDestinations
```
public java.lang.Object getDestinations()
```
    Settings that apply only if the input is a push type of input.
  - setDestinations
```
public void setDestinations(IResolvable value)
```
    Settings that apply only if the input is a push type of input.
  - setDestinations
```
public void setDestinations(java.util.List<java.lang.Object> value)
```
    Settings that apply only if the input is a push type of input.
  - getInputDevices
```
public java.lang.Object getInputDevices()
```
    Settings that apply only if the input is an Elemental Link input.
  - setInputDevices
```
public void setInputDevices(IResolvable value)
```
    Settings that apply only if the input is an Elemental Link input.
  - setInputDevices
```
public void setInputDevices(java.util.List<java.lang.Object> value)
```
    Settings that apply only if the input is an Elemental Link input.
  - getInputSecurityGroups
```
public java.util.List<java.lang.String> getInputSecurityGroups()
```
    The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
  - setInputSecurityGroups
```
public void setInputSecurityGroups(java.util.List<java.lang.String> value)
```
    The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
  - getMediaConnectFlows
```
public java.lang.Object getMediaConnectFlows()
```
    Settings that apply only if the input is a MediaConnect input.
  - setMediaConnectFlows
```
public void setMediaConnectFlows(IResolvable value)
```
    Settings that apply only if the input is a MediaConnect input.
  - setMediaConnectFlows
```
public void setMediaConnectFlows(java.util.List<java.lang.Object> value)
```
    Settings that apply only if the input is a MediaConnect input.
  - getName
```
public java.lang.String getName()
```
    A name for the input.
  - setName
```
public void setName(java.lang.String value)
```
    A name for the input.
  - getRoleArn
```
public java.lang.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
```
public void setRoleArn(java.lang.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
```
public java.lang.Object getSources()
```
    Settings that apply only if the input is a pull type of input.
  - setSources
```
public void setSources(IResolvable value)
```
    Settings that apply only if the input is a pull type of input.
  - setSources
```
public void setSources(java.util.List<java.lang.Object> value)
```
    Settings that apply only if the input is a pull type of input.
  - getType
```
public java.lang.String getType()
```
    The type for this input.
  - setType
```
public void setType(java.lang.String value)
```
    The type for this input.
  - getVpc
```
public java.lang.Object getVpc()
```
    Settings that apply only if the input is an push input where the source is on Amazon VPC.
  - setVpc
```
public void setVpc(IResolvable value)
```
    Settings that apply only if the input is an push input where the source is on Amazon VPC.
  - setVpc
```
public void setVpc(CfnInput.InputVpcRequestProperty value)
```
    Settings that apply only if the input is an push input where the source is on Amazon VPC.

Class CfnInput

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnInput

CfnInput

CfnInput

CfnInput

Method Detail

inspect

renderProperties

getAttrArn

getAttrDestinations

getAttrSources

getCfnProperties

getTags

getDestinations

setDestinations

setDestinations

getInputDevices

setInputDevices

setInputDevices

getInputSecurityGroups

setInputSecurityGroups

getMediaConnectFlows

setMediaConnectFlows

setMediaConnectFlows

getName

setName

getRoleArn

setRoleArn

getSources

setSources

setSources

getType

setType

getVpc

setVpc

setVpc