Skip to main content

Aws/ivs

@swamp/aws/ivsv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

AWS IVS infrastructure models

02Release Notes
  • Updated: encoder_configuration, recording_configuration, storage_configuration
03Behaviors11
@swamp/aws/ivs/ad-configurationv2026.10.23.1ad_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringAd configuration name. The value does not need to be unique.
MediaTailorPlaybackConfigurationsarrayList of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration.
PostRollConfiguration?objectConfiguration for the post-roll ad break to use for this ad configuration.
Tags?arrayTags attached to the resource.
fn create()
Create a IVS AdConfiguration
fn get(identifier: string)
Get a IVS AdConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS AdConfiguration
fn update()
Update a IVS AdConfiguration
fn delete(identifier: string)
Delete a IVS AdConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS AdConfiguration
fn sync()
Sync IVS AdConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS AdConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS AdConfiguration resource state
@swamp/aws/ivs/channelv2026.10.23.1channel.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringChannel
Authorized?booleanWhether the channel is authorized.
InsecureIngest?booleanWhether the channel allows insecure ingest.
LatencyMode?enumChannel latency mode.
Type?enumChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
Tags?arrayA list of key-value pairs that contain metadata for the asset model.
RecordingConfigurationArn?stringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
Preset?enumOptional 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
ContainerFormat?enumIndicates 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS Channel
fn update()
Update a IVS Channel
fn delete(identifier: string)
Delete a IVS Channel
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS Channel
fn sync()
Sync IVS Channel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS Channel resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS Channel resource state
@swamp/aws/ivs/encoder-configurationv2026.10.25.1encoder_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Video?objectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
Name?stringEncoder configuration name.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a IVS EncoderConfiguration
fn get(identifier: string)
Get a IVS EncoderConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS EncoderConfiguration
fn update()
Update a IVS EncoderConfiguration
fn delete(identifier: string)
Delete a IVS EncoderConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS EncoderConfiguration
fn sync()
Sync IVS EncoderConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS EncoderConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS EncoderConfiguration resource state
@swamp/aws/ivs/ingest-configurationv2026.10.23.1ingest_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringIngestConfiguration
StageArn?stringStage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
IngestProtocol?enumIngest Protocol.
InsecureIngest?booleanWhether ingest configuration allows insecure ingest.
UserId?stringUser defined indentifier for participant associated with IngestConfiguration.
Tags?arrayA 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS IngestConfiguration
fn update()
Update a IVS IngestConfiguration
fn delete(identifier: string)
Delete a IVS IngestConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS IngestConfiguration
fn sync()
Sync IVS IngestConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS IngestConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS IngestConfiguration resource state
@swamp/aws/ivs/playback-key-pairv2026.10.23.1playback_key_pair.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringAn 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?stringThe public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PlaybackKeyPair resource.
Tags?arrayA 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PlaybackKeyPair
fn update()
Update a IVS PlaybackKeyPair
fn delete(identifier: string)
Delete a IVS PlaybackKeyPair
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PlaybackKeyPair
fn sync()
Sync IVS PlaybackKeyPair state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS PlaybackKeyPair resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS PlaybackKeyPair resource state
@swamp/aws/ivs/playback-restriction-policyv2026.10.23.1playback_restriction_policy.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AllowedCountries?arrayA 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?arrayA 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?booleanWhether channel playback is constrained by origin site.
Name?stringPlayback-restriction-policy name.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a IVS PlaybackRestrictionPolicy
fn get(identifier: string)
Get a IVS PlaybackRestrictionPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PlaybackRestrictionPolicy
fn update()
Update a IVS PlaybackRestrictionPolicy
fn delete(identifier: string)
Delete a IVS PlaybackRestrictionPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PlaybackRestrictionPolicy
fn sync()
Sync IVS PlaybackRestrictionPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS PlaybackRestrictionPolicy resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS PlaybackRestrictionPolicy resource state
@swamp/aws/ivs/public-keyv2026.10.23.1public_key.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringName of the public key to be imported. The value does not need to be unique.
PublicKeyMaterial?stringThe public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PublicKey resource.
Tags?arrayA 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PublicKey
fn update()
Update a IVS PublicKey
fn delete(identifier: string)
Delete a IVS PublicKey
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS PublicKey
fn sync()
Sync IVS PublicKey state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS PublicKey resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS PublicKey resource state
@swamp/aws/ivs/recording-configurationv2026.10.25.1recording_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringRecording Configuration Name.
RecordingReconnectWindowSeconds?numberRecording Reconnect Window Seconds. (0 means disabled)
DestinationConfigurationobjectRecording Destination Configuration.
Tags?arrayA list of key-value pairs that contain metadata for the asset model.
ThumbnailConfiguration?objectRecording Thumbnail Configuration.
RenditionConfiguration?objectRendition Configuration describes which renditions should be recorded for a stream.
fn create()
Create a IVS RecordingConfiguration
fn get(identifier: string)
Get a IVS RecordingConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS RecordingConfiguration
fn update()
Update a IVS RecordingConfiguration
fn delete(identifier: string)
Delete a IVS RecordingConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS RecordingConfiguration
fn sync()
Sync IVS RecordingConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS RecordingConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS RecordingConfiguration resource state
@swamp/aws/ivs/stagev2026.10.23.1stage.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringStage name
AutoParticipantRecordingConfiguration?objectConfiguration object for individual participant recording, to attach to the new stage.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a IVS Stage
fn get(identifier: string)
Get a IVS Stage
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS Stage
fn update()
Update a IVS Stage
fn delete(identifier: string)
Delete a IVS Stage
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS Stage
fn sync()
Sync IVS Stage state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS Stage resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS Stage resource state
@swamp/aws/ivs/storage-configurationv2026.10.25.1storage_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringStorage Configuration Name.
S3objectA complex type that describes an S3 location where recorded videos will be stored.
Tags?arrayA 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS StorageConfiguration
fn update()
Update a IVS StorageConfiguration
fn delete(identifier: string)
Delete a IVS StorageConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS StorageConfiguration
fn sync()
Sync IVS StorageConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS StorageConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS StorageConfiguration resource state
@swamp/aws/ivs/stream-keyv2026.10.23.1stream_key.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ChannelArnstringChannel ARN for the stream.
Tags?arrayA 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
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS StreamKey
fn update()
Update a IVS StreamKey
fn delete(identifier: string)
Delete a IVS StreamKey
ArgumentTypeDescription
identifierstringThe primary identifier of the IVS StreamKey
fn sync()
Sync IVS StreamKey state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IVS StreamKey resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IVS StreamKey resource state
04Previous Versions19
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: ad_configuration, channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key
2026.10.13.1
  • Updated: ad_configuration, channel, encoder_configuration, ingest_configuration, playback_key_pair, playback_restriction_policy, public_key, recording_configuration, stage, storage_configuration, stream_key
2026.10.08.1
2026.10.06.1
  • Added: ad_configuration

Added 1 behaviors

2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
05Stats
A
100 / 100
Downloads
114
Archive size
2.2 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 types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels