@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.788Z") public class CfnInput extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnInput(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnInput(Construct scope, java.lang.String id, CfnInputProps props)
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.public CfnInput(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example: arn:aws:medialive:us-west-1:111122223333:medialive:input:1234567. MediaLive creates this ARN when it creates the input.
public java.util.List<java.lang.String> getAttrDestinations()
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.
public java.util.List<java.lang.String> getAttrSources()
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.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag is a key-value pair.
public java.lang.Object getDestinations()
public void setDestinations(IResolvable value)
public void setDestinations(java.util.List<java.lang.Object> value)
public java.lang.Object getInputDevices()
public void setInputDevices(IResolvable value)
public void setInputDevices(java.util.List<java.lang.Object> value)
public java.util.List<java.lang.String> getInputSecurityGroups()
public void setInputSecurityGroups(java.util.List<java.lang.String> value)
public java.lang.Object getMediaConnectFlows()
public void setMediaConnectFlows(IResolvable value)
public void setMediaConnectFlows(java.util.List<java.lang.Object> value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getRoleArn()
This doesn't apply to other types of inputs. The role is identified by its ARN.
public void setRoleArn(java.lang.String value)
This doesn't apply to other types of inputs. The role is identified by its ARN.
public java.lang.Object getSources()
public void setSources(IResolvable value)
public void setSources(java.util.List<java.lang.Object> value)
public java.lang.String getType()
public void setType(java.lang.String value)
public java.lang.Object getVpc()
public void setVpc(IResolvable value)
public void setVpc(CfnInput.InputVpcRequestProperty value)