Class: Aws::ChimeSDKVoice::Types::CreateSipRuleRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-chimesdkvoice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#disabled ⇒ Boolean

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

Returns:

  • (Boolean) 


500
501
502
503
504
505
506
507
508
 
# File 'lib/aws-sdk-chimesdkvoice/types.rb', line 500

class CreateSipRuleRequest < Struct.new(
  :name,
  :trigger_type,
  :trigger_value,
  :disabled,
  :target_applications)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the SIP rule.

Returns:

  • (String) 


500
501
502
503
504
505
506
507
508
 
# File 'lib/aws-sdk-chimesdkvoice/types.rb', line 500

class CreateSipRuleRequest < Struct.new(
  :name,
  :trigger_type,
  :trigger_value,
  :disabled,
  :target_applications)
  SENSITIVE = []
  include Aws::Structure
end

#target_applications ⇒ Array<Types::SipRuleTargetApplication>

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

Returns:



500
501
502
503
504
505
506
507
508
 
# File 'lib/aws-sdk-chimesdkvoice/types.rb', line 500

class CreateSipRuleRequest < Struct.new(
  :name,
  :trigger_type,
  :trigger_value,
  :disabled,
  :target_applications)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_type ⇒ String

The type of trigger assigned to the SIP rule in ‘TriggerValue`, currently `RequestUriHostname` or `ToPhoneNumber`.

Returns:

  • (String) 


500
501
502
503
504
505
506
507
508
 
# File 'lib/aws-sdk-chimesdkvoice/types.rb', line 500

class CreateSipRuleRequest < Struct.new(
  :name,
  :trigger_type,
  :trigger_value,
  :disabled,
  :target_applications)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_value ⇒ String

If ‘TriggerType` is `RequestUriHostname`, the value can be the outbound host name of a Voice Connector. If `TriggerType` is `ToPhoneNumber`, the value can be a customer-owned phone number in the E164 format. The `SipMediaApplication` specified in the `SipRule` is triggered if the request URI in an incoming SIP request matches the `RequestUriHostname`, or if the `To` header in the incoming SIP request matches the `ToPhoneNumber` value.

Returns:

  • (String) 


500
501
502
503
504
505
506
507
508
 
# File 'lib/aws-sdk-chimesdkvoice/types.rb', line 500

class CreateSipRuleRequest < Struct.new(
  :name,
  :trigger_type,
  :trigger_value,
  :disabled,
  :target_applications)
  SENSITIVE = []
  include Aws::Structure
end