Aws/ivs

@swamp/aws/ivsv2026.04.23.3· 8d agoMODELS

01README

AWS IVS infrastructure models

02Models10

@swamp/aws/ivs/channelv2026.04.23.2channel.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	Channel
Authorized?	boolean	no	Whether the channel is authorized.
InsecureIngest?	boolean	no	Whether the channel allows insecure ingest.
LatencyMode?	enum	no	Channel latency mode.
Type?	enum	no	Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.
RecordingConfigurationArn?	string	no	Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
Preset?	enum	no	Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
MultitrackInputConfiguration?	object	no
ContainerFormat?	enum	no	Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

fn create()

Create a IVS Channel

fn get(identifier: string)

Get a IVS Channel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS Channel

fn update()

Update a IVS Channel

fn delete(identifier: string)

Delete a IVS Channel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS Channel

fn sync()

Sync IVS Channel state from AWS

Resources

state(infinite)— IVS Channel resource state

@swamp/aws/ivs/encoder-configurationv2026.04.23.2encoder_configuration.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Video?	object	no	Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
Name?	string	no	Encoder configuration name.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IVS EncoderConfiguration

fn get(identifier: string)

Get a IVS EncoderConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS EncoderConfiguration

fn update()

Update a IVS EncoderConfiguration

fn delete(identifier: string)

Delete a IVS EncoderConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS EncoderConfiguration

fn sync()

Sync IVS EncoderConfiguration state from AWS

Resources

state(infinite)— IVS EncoderConfiguration resource state

@swamp/aws/ivs/ingest-configurationv2026.04.23.2ingest_configuration.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	IngestConfiguration
StageArn?	string	no	Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
IngestProtocol?	enum	no	Ingest Protocol.
InsecureIngest?	boolean	no	Whether ingest configuration allows insecure ingest.
UserId?	string	no	User defined indentifier for participant associated with IngestConfiguration.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IVS IngestConfiguration

fn get(identifier: string)

Get a IVS IngestConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS IngestConfiguration

fn update()

Update a IVS IngestConfiguration

fn delete(identifier: string)

Delete a IVS IngestConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS IngestConfiguration

fn sync()

Sync IVS IngestConfiguration state from AWS

Resources

state(infinite)— IVS IngestConfiguration resource state

@swamp/aws/ivs/playback-key-pairv2026.04.23.2playback_key_pair.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
PublicKeyMaterial?	string	no	The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PlaybackKeyPair resource.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IVS PlaybackKeyPair

fn get(identifier: string)

Get a IVS PlaybackKeyPair

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PlaybackKeyPair

fn update()

Update a IVS PlaybackKeyPair

fn delete(identifier: string)

Delete a IVS PlaybackKeyPair

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PlaybackKeyPair

fn sync()

Sync IVS PlaybackKeyPair state from AWS

Resources

state(infinite)— IVS PlaybackKeyPair resource state

@swamp/aws/ivs/playback-restriction-policyv2026.04.23.2playback_restriction_policy.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
AllowedCountries?	array	no	A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
AllowedOrigins?	array	no	A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
EnableStrictOriginEnforcement?	boolean	no	Whether channel playback is constrained by origin site.
Name?	string	no	Playback-restriction-policy name.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IVS PlaybackRestrictionPolicy

fn get(identifier: string)

Get a IVS PlaybackRestrictionPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PlaybackRestrictionPolicy

fn update()

Update a IVS PlaybackRestrictionPolicy

fn delete(identifier: string)

Delete a IVS PlaybackRestrictionPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PlaybackRestrictionPolicy

fn sync()

Sync IVS PlaybackRestrictionPolicy state from AWS

Resources

state(infinite)— IVS PlaybackRestrictionPolicy resource state

@swamp/aws/ivs/public-keyv2026.04.23.2public_key.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	Name of the public key to be imported. The value does not need to be unique.
PublicKeyMaterial?	string	no	The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PublicKey resource.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IVS PublicKey

fn get(identifier: string)

Get a IVS PublicKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PublicKey

fn update()

Update a IVS PublicKey

fn delete(identifier: string)

Delete a IVS PublicKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS PublicKey

fn sync()

Sync IVS PublicKey state from AWS

Resources

state(infinite)— IVS PublicKey resource state

@swamp/aws/ivs/recording-configurationv2026.04.23.2recording_configuration.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	Recording Configuration Name.
RecordingReconnectWindowSeconds?	number	no	Recording Reconnect Window Seconds. (0 means disabled)
DestinationConfiguration	object	yes	Recording Destination Configuration.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.
ThumbnailConfiguration?	object	no	Recording Thumbnail Configuration.
RenditionConfiguration?	object	no	Rendition Configuration describes which renditions should be recorded for a stream.

fn create()

Create a IVS RecordingConfiguration

fn get(identifier: string)

Get a IVS RecordingConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS RecordingConfiguration

fn update()

Update a IVS RecordingConfiguration

fn delete(identifier: string)

Delete a IVS RecordingConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS RecordingConfiguration

fn sync()

Sync IVS RecordingConfiguration state from AWS

Resources

state(infinite)— IVS RecordingConfiguration resource state

@swamp/aws/ivs/stagev2026.04.23.2stage.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	Stage name
AutoParticipantRecordingConfiguration?	object	no	Configuration object for individual participant recording, to attach to the new stage.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IVS Stage

fn get(identifier: string)

Get a IVS Stage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS Stage

fn update()

Update a IVS Stage

fn delete(identifier: string)

Delete a IVS Stage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS Stage

fn sync()

Sync IVS Stage state from AWS

Resources

state(infinite)— IVS Stage resource state

@swamp/aws/ivs/storage-configurationv2026.04.23.2storage_configuration.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
Name?	string	no	Storage Configuration Name.
S3	object	yes	A complex type that describes an S3 location where recorded videos will be stored.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IVS StorageConfiguration

fn get(identifier: string)

Get a IVS StorageConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS StorageConfiguration

fn update()

Update a IVS StorageConfiguration

fn delete(identifier: string)

Delete a IVS StorageConfiguration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS StorageConfiguration

fn sync()

Sync IVS StorageConfiguration state from AWS

Resources

state(infinite)— IVS StorageConfiguration resource state

@swamp/aws/ivs/stream-keyv2026.04.23.2stream_key.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ChannelArn	string	yes	Channel ARN for the stream.
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IVS StreamKey

fn get(identifier: string)

Get a IVS StreamKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS StreamKey

fn update()

Update a IVS StreamKey

fn delete(identifier: string)

Delete a IVS StreamKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IVS StreamKey

fn sync()

Sync IVS StreamKey state from AWS

Resources

state(infinite)— IVS StreamKey resource state

03Previous Versions5

2026.04.23.2Apr 23, 2026

Updated: channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key

2026.04.03.2Apr 3, 2026

Updated: channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key

2026.03.19.1Mar 19, 2026

Updated: channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key

2026.03.16.1Mar 16, 2026

Updated: channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key

2026.03.10.5Mar 10, 2026

04Stats

100 / 100

Downloads

Archive size

1.9 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/1earned
Has description1/1earned
At least one platform tag (or universal)1/1earned
Two or more platform tags (or universal)1/1earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/systeminit/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#aws #ivs #cloud #infrastructure