Interface CreateIngestConfigurationRequest.Builder

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

  • Method Details

    • name

      CreateIngestConfigurationRequest.Builder name(String name)

      Optional name that can be specified for the IngestConfiguration being created.

      Parameters:
      name - Optional name that can be specified for the IngestConfiguration being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageArn

      CreateIngestConfigurationRequest.Builder stageArn(String stageArn)

      ARN of the stage with which the IngestConfiguration is associated.

      Parameters:
      stageArn - ARN of the stage with which the IngestConfiguration is associated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      CreateIngestConfigurationRequest.Builder userId(String userId)

      Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      Parameters:
      userId - Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      CreateIngestConfigurationRequest.Builder attributes(Map<String,String> attributes)

      Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      Parameters:
      attributes - Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestProtocol

      CreateIngestConfigurationRequest.Builder ingestProtocol(String ingestProtocol)

      Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

      Parameters:
      ingestProtocol - Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ingestProtocol

      CreateIngestConfigurationRequest.Builder ingestProtocol(IngestProtocol ingestProtocol)

      Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

      Parameters:
      ingestProtocol - Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • insecureIngest

      CreateIngestConfigurationRequest.Builder insecureIngest(Boolean insecureIngest)

      Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

      Parameters:
      insecureIngest - Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

      Parameters:
      tags - Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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