Interface Composition.Builder

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

  • Method Details

    • arn

      Composition.Builder arn(String arn)

      ARN of the Composition resource.

      Parameters:
      arn - ARN of the Composition resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageArn

      Composition.Builder stageArn(String stageArn)

      ARN of the stage used as input

      Parameters:
      stageArn - ARN of the stage used as input
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Composition.Builder state(String state)

      State of the Composition.

      Parameters:
      state - State of the Composition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Composition.Builder state(CompositionState state)

      State of the Composition.

      Parameters:
      state - State of the Composition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • layout

      Composition.Builder layout(LayoutConfiguration layout)

      Layout object to configure composition parameters.

      Parameters:
      layout - Layout object to configure composition parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • layout

      default Composition.Builder layout(Consumer<LayoutConfiguration.Builder> layout)

      Layout object to configure composition parameters.

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

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

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

    • destinations

      Composition.Builder destinations(Collection<Destination> destinations)

      Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

      Parameters:
      destinations - Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinations

      Composition.Builder destinations(Destination... destinations)

      Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

      Parameters:
      destinations - Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinations

      Composition.Builder destinations(Consumer<Destination.Builder>... destinations)

      Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

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

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

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

    • tags

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

    • startTime

      Composition.Builder startTime(Instant startTime)

      UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      Parameters:
      startTime - UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      Composition.Builder endTime(Instant endTime)

      UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

      Parameters:
      endTime - UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.