Package software.amazon.awscdk.services.medialive

Class CfnInput

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.260Z") @Stability(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();

  • 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 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(Stable) public CfnInput(@NotNull 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 Details

    • 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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A collection of tags for this input.

      Each tag is a key-value pair.

    • getDestinations

      @Stability(Stable) @Nullable public Object getDestinations()
      Settings that apply only if the input is a push type of input.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

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

    • 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.

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

    • getSources

      @Stability(Stable) @Nullable public Object getSources()
      Settings that apply only if the input is a pull type of input.

    • 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.

    • 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.

    • 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.