Interface IngestConfiguration.Builder

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

  • Method Details

    • name

      IngestConfiguration.Builder name(String name)

      Ingest name

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

    • arn

      IngestConfiguration.Builder arn(String arn)

      Ingest configuration ARN.

      Parameters:
      arn - Ingest configuration ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestProtocol

      IngestConfiguration.Builder ingestProtocol(String ingestProtocol)

      Type of ingest protocol that the user employs for broadcasting.

      Parameters:
      ingestProtocol - Type of ingest protocol that the user employs for broadcasting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ingestProtocol

      IngestConfiguration.Builder ingestProtocol(IngestProtocol ingestProtocol)

      Type of ingest protocol that the user employs for broadcasting.

      Parameters:
      ingestProtocol - Type of ingest protocol that the user employs for broadcasting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamKey

      IngestConfiguration.Builder streamKey(String streamKey)

      Ingest-key value for the RTMP(S) protocol.

      Parameters:
      streamKey - Ingest-key value for the RTMP(S) protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageArn

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

    • participantId

      IngestConfiguration.Builder participantId(String participantId)

      ID of the participant within the stage.

      Parameters:
      participantId - ID of the participant within the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      IngestConfiguration.Builder state(String state)

      State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

      Parameters:
      state - State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      IngestConfiguration.Builder state(IngestConfigurationState state)

      State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

      Parameters:
      state - State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userId

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

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

      Application-provided attributes to 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 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.

    • tags

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