Class: AWSCDK::MediaLive::CfnChannel::HlsAkamaiSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The Akamai settings in an HLS output.

The parent of this entity is HlsCdnSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_retry_interval: nil, filecache_duration: nil, http_transfer_mode: nil, num_retries: nil, restart_delay: nil, salt: nil, token: nil) ⇒ HlsAkamaiSettingsProperty

Returns a new instance of HlsAkamaiSettingsProperty.

Parameters:

  • connection_retry_interval (Numeric, nil) (defaults to: nil) —

    The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

  • filecache_duration (Numeric, nil) (defaults to: nil) —

    The size, in seconds, of the file cache for streaming outputs.

  • http_transfer_mode (String, nil) (defaults to: nil) —

    Specifies whether to use chunked transfer encoding to Akamai.

  • num_retries (Numeric, nil) (defaults to: nil) —

    The number of retry attempts that will be made before the channel is put into an error state.

  • restart_delay (Numeric, nil) (defaults to: nil) —

    If a streaming output fails, the number of seconds to wait until a restart is initiated.

  • salt (String, nil) (defaults to: nil) —

    The salt for authenticated Akamai.

  • token (String, nil) (defaults to: nil) —

    The token parameter for authenticated Akamai.



7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
 
# File 'media_live/cfn_channel.rb', line 7356

def initialize(connection_retry_interval: nil, filecache_duration: nil, http_transfer_mode: nil, num_retries: nil, restart_delay: nil, salt: nil, token: nil)
  @connection_retry_interval = connection_retry_interval
  Jsii::Type.check_type(@connection_retry_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "connectionRetryInterval") unless @connection_retry_interval.nil?
  @filecache_duration = filecache_duration
  Jsii::Type.check_type(@filecache_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "filecacheDuration") unless @filecache_duration.nil?
  @http_transfer_mode = http_transfer_mode
  Jsii::Type.check_type(@http_transfer_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpTransferMode") unless @http_transfer_mode.nil?
  @num_retries = num_retries
  Jsii::Type.check_type(@num_retries, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numRetries") unless @num_retries.nil?
  @restart_delay = restart_delay
  Jsii::Type.check_type(@restart_delay, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "restartDelay") unless @restart_delay.nil?
  @salt = salt
  Jsii::Type.check_type(@salt, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "salt") unless @salt.nil?
  @token = token
  Jsii::Type.check_type(@token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "token") unless @token.nil?
end

Instance Attribute Details

#connection_retry_interval ⇒ Numeric? (readonly)

The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

Returns:

  • (Numeric, nil)

See Also:



7377
7378
7379
 
# File 'media_live/cfn_channel.rb', line 7377

def connection_retry_interval
  @connection_retry_interval
end

#filecache_duration ⇒ Numeric? (readonly)

The size, in seconds, of the file cache for streaming outputs.

Returns:

  • (Numeric, nil)

See Also:



7382
7383
7384
 
# File 'media_live/cfn_channel.rb', line 7382

def filecache_duration
  @filecache_duration
end

#http_transfer_mode ⇒ String? (readonly)

Specifies whether to use chunked transfer encoding to Akamai.

To enable this feature, contact Akamai.

Returns:

  • (String, nil)

See Also:



7389
7390
7391
 
# File 'media_live/cfn_channel.rb', line 7389

def http_transfer_mode
  @http_transfer_mode
end

#num_retries ⇒ Numeric? (readonly)

The number of retry attempts that will be made before the channel is put into an error state.

Returns:

  • (Numeric, nil)

See Also:



7394
7395
7396
 
# File 'media_live/cfn_channel.rb', line 7394

def num_retries
  @num_retries
end

#restart_delay ⇒ Numeric? (readonly)

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

Returns:

  • (Numeric, nil)

See Also:



7401
7402
7403
 
# File 'media_live/cfn_channel.rb', line 7401

def restart_delay
  @restart_delay
end

#salt ⇒ String? (readonly)

The salt for authenticated Akamai.

Returns:

  • (String, nil)

See Also:



7406
7407
7408
 
# File 'media_live/cfn_channel.rb', line 7406

def salt
  @salt
end

#token ⇒ String? (readonly)

The token parameter for authenticated Akamai.

If this is not specified, gda is used.

Returns:

  • (String, nil)

See Also:



7413
7414
7415
 
# File 'media_live/cfn_channel.rb', line 7413

def token
  @token
end

Class Method Details

.jsii_properties ⇒ Object 



7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
 
# File 'media_live/cfn_channel.rb', line 7415

def self.jsii_properties
  {
    :connection_retry_interval => "connectionRetryInterval",
    :filecache_duration => "filecacheDuration",
    :http_transfer_mode => "httpTransferMode",
    :num_retries => "numRetries",
    :restart_delay => "restartDelay",
    :salt => "salt",
    :token => "token",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
 
# File 'media_live/cfn_channel.rb', line 7427

def to_jsii
  result = {}
  result.merge!({
    "connectionRetryInterval" => @connection_retry_interval,
    "filecacheDuration" => @filecache_duration,
    "httpTransferMode" => @http_transfer_mode,
    "numRetries" => @num_retries,
    "restartDelay" => @restart_delay,
    "salt" => @salt,
    "token" => @token,
  })
  result.compact
end