Package software.amazon.awscdk.services.medialive.alpha

Interface PoisEndpoint

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PoisEndpoint.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.308Z")
@Stability(Experimental)
public interface PoisEndpoint
extends software.amazon.jsii.JsiiSerializable

(experimental) Connection details for an ESAM POIS (Placement Opportunity Information System) endpoint.

Example:

 import software.amazon.awscdk.services.ssm.StringParameter;
 Stack stack;
 IInput input;
 IBucket bucket;
 EncodeConfiguration video;
 StringParameter poisPassword;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder().input(input).build()))
         .availSettings(AvailSettings.esam(EsamSettings.builder()
                 .pois(PoisEndpoint.builder()
                         .url("https://pois.example.com/esam")
                         .username("pois-user")
                         .password(poisPassword)
                         .build())
                 .acquisitionPointId("acquisition-point-1")
                 .adAvailOffset(Duration.millis(200))
                 .build()))
         .scte35SegmentationScope(Scte35SegmentationScope.SCTE35_ENABLED_OUTPUT_GROUPS)
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video)).outputName("hls_out").build()))
                 .build())))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PoisEndpoint.Builder	A builder for PoisEndpoint
static final class	PoisEndpoint.Jsii$Proxy	An implementation for PoisEndpoint

Method Summary

Modifier and Type	Method	Description
static PoisEndpoint.Builder	builder()
default IStringParameter	getPassword()	(experimental) An SSM parameter holding the password for the POIS endpoint.
String	getUrl()	(experimental) The POIS endpoint URL that MediaLive sends signal conditioning information to.
default String	getUsername()	(experimental) The username used to connect to the POIS endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUrl

@Stability(Experimental)
@NotNull
String getUrl()

(experimental) The POIS endpoint URL that MediaLive sends signal conditioning information to.

getPassword

@Stability(Experimental)
@Nullable
default IStringParameter getPassword()

(experimental) An SSM parameter holding the password for the POIS endpoint.

The channel role is granted read access to the parameter automatically.

Default: - no credentials

getUsername

@Stability(Experimental)
@Nullable
default String getUsername()

(experimental) The username used to connect to the POIS endpoint.

Default: - no credentials

builder

@Stability(Experimental)
static PoisEndpoint.Builder builder()

Returns:

a PoisEndpoint.Builder of PoisEndpoint