Interface Output.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Output.Builder,
,Output> SdkBuilder<Output.Builder,
,Output> SdkPojo
- Enclosing class:
Output
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the bridge added to this output.bridgePorts
(Integer... bridgePorts) The bridge output ports currently in use.bridgePorts
(Collection<Integer> bridgePorts) The bridge output ports currently in use.dataTransferSubscriberFeePercent
(Integer dataTransferSubscriberFeePercent) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.description
(String description) A description of the output.destination
(String destination) The address where you want to send the output.default Output.Builder
encryption
(Consumer<Encryption.Builder> encryption) The type of key used for the encryption.encryption
(Encryption encryption) The type of key used for the encryption.entitlementArn
(String entitlementArn) The ARN of the entitlement on the originator''s flow.listenerAddress
(String listenerAddress) The IP address that the receiver requires in order to establish a connection with the flow.mediaLiveInputArn
(String mediaLiveInputArn) The input ARN of the MediaLive channel.mediaStreamOutputConfigurations
(Collection<MediaStreamOutputConfiguration> mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.mediaStreamOutputConfigurations
(Consumer<MediaStreamOutputConfiguration.Builder>... mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.mediaStreamOutputConfigurations
(MediaStreamOutputConfiguration... mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.The name of the output.The ARN of the output.outputStatus
(String outputStatus) An indication of whether the output is transmitting data or not.outputStatus
(OutputStatus outputStatus) An indication of whether the output is transmitting data or not.peerIpAddress
(String peerIpAddress) The IP address of the device that is currently receiving content from this output.The port to use when content is distributed to this output.default Output.Builder
transport
(Consumer<Transport.Builder> transport) Attributes related to the transport stream that are used in the output.Attributes related to the transport stream that are used in the output.default Output.Builder
vpcInterfaceAttachment
(Consumer<VpcInterfaceAttachment.Builder> vpcInterfaceAttachment) The name of the VPC interface attachment to use for this output.vpcInterfaceAttachment
(VpcInterfaceAttachment vpcInterfaceAttachment) The name of the VPC interface attachment to use for this output.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
- Parameters:
dataTransferSubscriberFeePercent
- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the output.
- Parameters:
description
- A description of the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destination
The address where you want to send the output.
- Parameters:
destination
- The address where you want to send the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
- Parameters:
encryption
- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
This is a convenience method that creates an instance of theEncryption.Builder
avoiding the need to create one manually viaEncryption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryption(Encryption)
.- Parameters:
encryption
- a consumer that will call methods onEncryption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
entitlementArn
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
- Parameters:
entitlementArn
- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
listenerAddress
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
- Parameters:
listenerAddress
- The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaLiveInputArn
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
- Parameters:
mediaLiveInputArn
- The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaStreamOutputConfigurations
Output.Builder mediaStreamOutputConfigurations(Collection<MediaStreamOutputConfiguration> mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.
- Parameters:
mediaStreamOutputConfigurations
- The configuration for each media stream that is associated with the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaStreamOutputConfigurations
Output.Builder mediaStreamOutputConfigurations(MediaStreamOutputConfiguration... mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.
- Parameters:
mediaStreamOutputConfigurations
- The configuration for each media stream that is associated with the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaStreamOutputConfigurations
Output.Builder mediaStreamOutputConfigurations(Consumer<MediaStreamOutputConfiguration.Builder>... mediaStreamOutputConfigurations) The configuration for each media stream that is associated with the output.
This is a convenience method that creates an instance of theMediaStreamOutputConfiguration.Builder
avoiding the need to create one manually viaMediaStreamOutputConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomediaStreamOutputConfigurations(List<MediaStreamOutputConfiguration>)
.- Parameters:
mediaStreamOutputConfigurations
- a consumer that will call methods onMediaStreamOutputConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The name of the output. This value must be unique within the current flow.
- Parameters:
name
- The name of the output. This value must be unique within the current flow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArn
The ARN of the output.
- Parameters:
outputArn
- The ARN of the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
The port to use when content is distributed to this output.
- Parameters:
port
- The port to use when content is distributed to this output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transport
Attributes related to the transport stream that are used in the output.
- Parameters:
transport
- Attributes related to the transport stream that are used in the output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transport
Attributes related to the transport stream that are used in the output.
This is a convenience method that creates an instance of theTransport.Builder
avoiding the need to create one manually viaTransport.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totransport(Transport)
.- Parameters:
transport
- a consumer that will call methods onTransport.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcInterfaceAttachment
The name of the VPC interface attachment to use for this output.
- Parameters:
vpcInterfaceAttachment
- The name of the VPC interface attachment to use for this output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcInterfaceAttachment
default Output.Builder vpcInterfaceAttachment(Consumer<VpcInterfaceAttachment.Builder> vpcInterfaceAttachment) The name of the VPC interface attachment to use for this output.
This is a convenience method that creates an instance of theVpcInterfaceAttachment.Builder
avoiding the need to create one manually viaVpcInterfaceAttachment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcInterfaceAttachment(VpcInterfaceAttachment)
.- Parameters:
vpcInterfaceAttachment
- a consumer that will call methods onVpcInterfaceAttachment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bridgeArn
The ARN of the bridge added to this output.
- Parameters:
bridgeArn
- The ARN of the bridge added to this output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bridgePorts
The bridge output ports currently in use.
- Parameters:
bridgePorts
- The bridge output ports currently in use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bridgePorts
The bridge output ports currently in use.
- Parameters:
bridgePorts
- The bridge output ports currently in use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputStatus
An indication of whether the output is transmitting data or not.
- Parameters:
outputStatus
- An indication of whether the output is transmitting data or not.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputStatus
An indication of whether the output is transmitting data or not.
- Parameters:
outputStatus
- An indication of whether the output is transmitting data or not.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
peerIpAddress
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
- Parameters:
peerIpAddress
- The IP address of the device that is currently receiving content from this output.-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-