Class CfnInput
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnInput
.static interface
Settings that apply only if the input is a push type of input.static interface
This entity is not used.static interface
Settings that apply only if the input is an Elemental Link input.static interface
Settings that apply only if the input is a pull type of input.static interface
Settings that apply only if the input is an push input where the source is on Amazon VPC.static interface
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.core.IConstruct
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
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a newAWS::MediaLive::Input
.CfnInput
(Construct scope, String id, CfnInputProps props) Create a newAWS::MediaLive::Input
.protected
CfnInput
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInput
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the MediaLive input.For a push input, the the destination or destinations for the input.For a pull input, the source or sources for the input.Settings that apply only if the input is a push type of input.Settings that apply only if the input is an Elemental Link input.The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.Settings that apply only if the input is a MediaConnect input.getName()
A name for the input.The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.Settings that apply only if the input is a pull type of input.getTags()
A collection of tags for this input.getType()
The type for this input.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.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
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
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
(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
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
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 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
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 Construct scope, @NotNull String id, @Nullable CfnInputProps props) Create a newAWS::MediaLive::Input
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnInput
Create a newAWS::MediaLive::Input
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
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
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
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
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
A collection of tags for this input.Each tag is a key-value pair.
-
getDestinations
Settings that apply only if the input is a push type of input. -
setDestinations
Settings that apply only if the input is a push type of input. -
setDestinations
Settings that apply only if the input is a push type of input. -
getInputDevices
Settings that apply only if the input is an Elemental Link input. -
setInputDevices
Settings that apply only if the input is an Elemental Link input. -
setInputDevices
Settings that apply only if the input is an Elemental Link input. -
getInputSecurityGroups
The list of input security groups (referenced by IDs) to attach to the input if the input is a push type. -
setInputSecurityGroups
The list of input security groups (referenced by IDs) to attach to the input if the input is a push type. -
getMediaConnectFlows
Settings that apply only if the input is a MediaConnect input. -
setMediaConnectFlows
Settings that apply only if the input is a MediaConnect input. -
setMediaConnectFlows
Settings that apply only if the input is a MediaConnect input. -
getName
A name for the input. -
setName
A name for the input. -
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
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
Settings that apply only if the input is a pull type of input. -
setSources
Settings that apply only if the input is a pull type of input. -
setSources
Settings that apply only if the input is a pull type of input. -
getType
The type for this input. -
setType
The type for this input. -
getVpc
Settings that apply only if the input is an push input where the source is on Amazon VPC. -
setVpc
Settings that apply only if the input is an push input where the source is on Amazon VPC. -
setVpc
Settings that apply only if the input is an push input where the source is on Amazon VPC.
-