Class: Aws::Chime::Types::CreateSipRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

When making an API call, you may pass CreateSipRuleRequest data as a hash:

{
  name: "SipRuleName", # required
  trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
  trigger_value: "NonEmptyString", # required
  disabled: false,
  target_applications: [ # required
    {
      sip_media_application_id: "NonEmptyString",
      priority: 1,
      aws_region: "String",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#disabledBoolean

Enables or disables a rule. You must disable rules before you can delete them.

Returns:

  • (Boolean)


3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 3065

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

#nameString

The name of the SIP rule.

Returns:

  • (String)


3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 3065

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

#target_applicationsArray<Types::SipRuleTargetApplication>

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



3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 3065

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

#trigger_typeString

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

Returns:

  • (String)


3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 3065

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

#trigger_valueString

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime 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)


3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 3065

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