Interface CreateChannelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, MediaPackageV2Request.Builder, SdkBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateChannelRequest
@Mutable @NotThreadSafe public static interface CreateChannelRequest.Builder extends MediaPackageV2Request.Builder, SdkPojo, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

  • Method Details

    • channelGroupName

      CreateChannelRequest.Builder channelGroupName(String channelGroupName)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      Parameters:
      channelGroupName - The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelName

      CreateChannelRequest.Builder channelName(String channelName)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

      Parameters:
      channelName - The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateChannelRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputType

      CreateChannelRequest.Builder inputType(String inputType)

      The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      Parameters:
      inputType - The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputType

      CreateChannelRequest.Builder inputType(InputType inputType)

      The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      Parameters:
      inputType - The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateChannelRequest.Builder description(String description)

      Enter any descriptive text that helps you to identify the channel.

      Parameters:
      description - Enter any descriptive text that helps you to identify the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputSwitchConfiguration

      CreateChannelRequest.Builder inputSwitchConfiguration(InputSwitchConfiguration inputSwitchConfiguration)

      The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

      Parameters:
      inputSwitchConfiguration - The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputSwitchConfiguration

      default CreateChannelRequest.Builder inputSwitchConfiguration(Consumer<InputSwitchConfiguration.Builder> inputSwitchConfiguration)

      The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

      This is a convenience method that creates an instance of the InputSwitchConfiguration.Builder avoiding the need to create one manually via InputSwitchConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputSwitchConfiguration(InputSwitchConfiguration).

      Parameters:
      inputSwitchConfiguration - a consumer that will call methods on InputSwitchConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputHeaderConfiguration

      CreateChannelRequest.Builder outputHeaderConfiguration(OutputHeaderConfiguration outputHeaderConfiguration)

      The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

      Parameters:
      outputHeaderConfiguration - The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputHeaderConfiguration

      default CreateChannelRequest.Builder outputHeaderConfiguration(Consumer<OutputHeaderConfiguration.Builder> outputHeaderConfiguration)

      The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

      This is a convenience method that creates an instance of the OutputHeaderConfiguration.Builder avoiding the need to create one manually via OutputHeaderConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputHeaderConfiguration(OutputHeaderConfiguration).

      Parameters:
      outputHeaderConfiguration - a consumer that will call methods on OutputHeaderConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateChannelRequest.Builder tags(Map<String,String> tags)

      A comma-separated list of tag key:value pairs that you define. For example:

      "Key1": "Value1",

      "Key2": "Value2"

      Parameters:
      tags - A comma-separated list of tag key:value pairs that you define. For example:

      "Key1": "Value1",

      "Key2": "Value2"

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateChannelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.