Interface DestinationEndpoint.Builder

  • Method Details

    • name

      The name of the destination endpoint.

      Parameters:
      name - The name of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • arn

      The Amazon Resource Name (ARN) of the destination endpoint.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • id

      The unique identifier of the destination endpoint.

      Parameters:
      id - The unique identifier of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      DestinationEndpoint.Builder description(String description)

      The description of the destination endpoint.

      Parameters:
      description - The description of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • regionName

      DestinationEndpoint.Builder regionName(String regionName)

      The name of the Amazon Web Services Region in which the destination endpoint is located.

      Parameters:
      regionName - The name of the Amazon Web Services Region in which the destination endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availabilityZone

      DestinationEndpoint.Builder availabilityZone(String availabilityZone)

      The Availability Zone in which the destination endpoint is located.

      Parameters:
      availabilityZone - The Availability Zone in which the destination endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availabilityZoneId

      DestinationEndpoint.Builder availabilityZoneId(String availabilityZoneId)

      The ID of the Availability Zone in which the destination endpoint is located.

      Parameters:
      availabilityZoneId - The ID of the Availability Zone in which the destination endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdAt

      DestinationEndpoint.Builder createdAt(Instant createdAt)

      The date and time when the destination endpoint was created.

      Parameters:
      createdAt - The date and time when the destination endpoint was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      DestinationEndpoint.Builder updatedAt(Instant updatedAt)

      The date and time when the destination endpoint was last updated.

      Parameters:
      updatedAt - The date and time when the destination endpoint was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lifecycleManagement

      DestinationEndpoint.Builder lifecycleManagement(String lifecycleManagement)

      The entity that manages the lifecycle of the destination endpoint.

      Parameters:
      lifecycleManagement - The entity that manages the lifecycle of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lifecycleManagement

      DestinationEndpoint.Builder lifecycleManagement(EndpointLifecycle lifecycleManagement)

      The entity that manages the lifecycle of the destination endpoint.

      Parameters:
      lifecycleManagement - The entity that manages the lifecycle of the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • messages

      The status messages for the destination endpoint.

      Parameters:
      messages - The status messages for the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messages

      The status messages for the destination endpoint.

      Parameters:
      messages - The status messages for the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messages

      The status messages for the destination endpoint.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messages(List<DestinationEndpointMessage>).

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

      DestinationEndpoint.Builder destinationType(String destinationType)

      The type of the destination endpoint. Valid values include the following:

      • STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_INPUT – A destination endpoint that represents a router input.

      Parameters:
      destinationType - The type of the destination endpoint. Valid values include the following:

      • STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_INPUT – A destination endpoint that represents a router input.

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

      DestinationEndpoint.Builder destinationType(DestinationEndpointType destinationType)

      The type of the destination endpoint. Valid values include the following:

      • STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_INPUT – A destination endpoint that represents a router input.

      Parameters:
      destinationType - The type of the destination endpoint. Valid values include the following:

      • STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_INPUT – A destination endpoint that represents a router input.

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

      The configuration settings for the destination endpoint.

      Parameters:
      configuration - The configuration settings for the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • configuration

      The configuration settings for the destination endpoint.

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

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

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

      DestinationEndpoint.Builder resourceShareOwnership(String resourceShareOwnership)

      Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.

      Parameters:
      resourceShareOwnership - Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceShareOwnership

      DestinationEndpoint.Builder resourceShareOwnership(ResourceShareOwnership resourceShareOwnership)

      Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.

      Parameters:
      resourceShareOwnership - Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceShareDetails

      DestinationEndpoint.Builder resourceShareDetails(ResourceShareDetails resourceShareDetails)
      Sets the value of the ResourceShareDetails property for this object.
      Parameters:
      resourceShareDetails - The new value for the ResourceShareDetails property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceShareDetails

      default DestinationEndpoint.Builder resourceShareDetails(Consumer<ResourceShareDetails.Builder> resourceShareDetails)
      Sets the value of the ResourceShareDetails property for this object. This is a convenience method that creates an instance of the ResourceShareDetails.Builder avoiding the need to create one manually via ResourceShareDetails.builder().

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

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

      DestinationEndpoint.Builder registrationState(String registrationState)

      The registration state of the destination endpoint. Valid values include the following:

      • REGISTERED – The destination endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.

      Parameters:
      registrationState - The registration state of the destination endpoint. Valid values include the following:

      • REGISTERED – The destination endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.

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

      The registration state of the destination endpoint. Valid values include the following:

      • REGISTERED – The destination endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.

      Parameters:
      registrationState - The registration state of the destination endpoint. Valid values include the following:

      • REGISTERED – The destination endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.

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

      The connection details for the destination endpoint.

      Parameters:
      connectionDetails - The connection details for the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • connectionDetails

      The connection details for the destination endpoint.

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

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

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

      DestinationEndpoint.Builder connectionState(String connectionState)

      The connection state of the destination endpoint. Valid values include the following:

      • CONNECTED – The destination endpoint is connected to a source endpoint.

      • DISCONNECTED – The destination endpoint isn't connected to a source endpoint.

      • CONNECTING – The destination endpoint is connecting to a source endpoint.

      • DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

      Parameters:
      connectionState - The connection state of the destination endpoint. Valid values include the following:

      • CONNECTED – The destination endpoint is connected to a source endpoint.

      • DISCONNECTED – The destination endpoint isn't connected to a source endpoint.

      • CONNECTING – The destination endpoint is connecting to a source endpoint.

      • DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

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

      The connection state of the destination endpoint. Valid values include the following:

      • CONNECTED – The destination endpoint is connected to a source endpoint.

      • DISCONNECTED – The destination endpoint isn't connected to a source endpoint.

      • CONNECTING – The destination endpoint is connecting to a source endpoint.

      • DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

      Parameters:
      connectionState - The connection state of the destination endpoint. Valid values include the following:

      • CONNECTED – The destination endpoint is connected to a source endpoint.

      • DISCONNECTED – The destination endpoint isn't connected to a source endpoint.

      • CONNECTING – The destination endpoint is connecting to a source endpoint.

      • DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

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

      DestinationEndpoint.Builder connectedSource(String connectedSource)

      The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

      Parameters:
      connectedSource - The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • decryptionType

      DestinationEndpoint.Builder decryptionType(String decryptionType)

      The type of decryption used for the destination endpoint connection.

      Parameters:
      decryptionType - The type of decryption used for the destination endpoint connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • decryptionType

      DestinationEndpoint.Builder decryptionType(EndpointEncryptionType decryptionType)

      The type of decryption used for the destination endpoint connection.

      Parameters:
      decryptionType - The type of decryption used for the destination endpoint connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • decryptionConfiguration

      DestinationEndpoint.Builder decryptionConfiguration(EndpointEncryptionConfiguration decryptionConfiguration)
      Sets the value of the DecryptionConfiguration property for this object.
      Parameters:
      decryptionConfiguration - The new value for the DecryptionConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • decryptionConfiguration

      default DestinationEndpoint.Builder decryptionConfiguration(Consumer<EndpointEncryptionConfiguration.Builder> decryptionConfiguration)
      Sets the value of the DecryptionConfiguration property for this object. This is a convenience method that creates an instance of the EndpointEncryptionConfiguration.Builder avoiding the need to create one manually via EndpointEncryptionConfiguration.builder().

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

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

      DestinationEndpoint.Builder associatedResourceDetails(DestinationEndpointAssociatedResourceDetails associatedResourceDetails)

      The details of the resource that is associated with the destination endpoint.

      Parameters:
      associatedResourceDetails - The details of the resource that is associated with the destination endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associatedResourceDetails

      default DestinationEndpoint.Builder associatedResourceDetails(Consumer<DestinationEndpointAssociatedResourceDetails.Builder> associatedResourceDetails)

      The details of the resource that is associated with the destination endpoint.

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

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

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

      The tags associated with the destination endpoint. Each tag is a key-value pair.

      Parameters:
      tags - The tags associated with the destination endpoint. Each tag is a key-value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.