ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/Composition

Composition

class Composition

Object specifying a Composition resource.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

ARN of the Composition resource.

Link copied to clipboard
val destinations: List<Destination>

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

Link copied to clipboard
val endTime: Instant?

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

Link copied to clipboard
val layout: LayoutConfiguration?

Layout object to configure composition parameters.

Link copied to clipboard
val stageArn: String

ARN of the stage used as input

Link copied to clipboard
val startTime: Instant?

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

Link copied to clipboard
val state: CompositionState

State of the Composition.

Link copied to clipboard
val tags: Map<String, String>?

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Functions

Link copied to clipboard
inline fun copy(block: Composition.Builder.() -> Unit = {}): Composition
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String