AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateSipRuleRequest as input to an Aws::Client method, you can use a vanilla 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",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#disabledBoolean

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

Returns:

  • (Boolean)

    Enables or disables a rule.

#nameString

The name of the SIP rule.

Returns:

  • (String)

    The name of the SIP rule.

#target_applicationsArray<Types::SipRuleTargetApplication>

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

Returns:

#trigger_typeString

The type of trigger whose value is assigned to the SIP rule in TriggerValue. Allowed trigger values are RequestUriHostname and ToPhoneNumber.

Possible values:

  • ToPhoneNumber
  • RequestUriHostname

Returns:

  • (String)

    The type of trigger whose value is assigned to the SIP rule in TriggerValue.

#trigger_valueString

If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a If TriggerType is RequestUriHostname, then the value can be the outbound hostname of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a ToPhoneNumber value matches the incoming SIP request.

Returns:

  • (String)

    If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector.