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

Class: Aws::Chime::Types::OriginationRoute

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

Overview

Note:

When passing OriginationRoute as input to an Aws::Client method, you can use a vanilla Hash:

{
  host: "String",
  port: 1,
  protocol: "TCP", # accepts TCP, UDP
  priority: 1,
  weight: 1,
}

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

Instance Attribute Summary collapse

Instance Attribute Details

#hostString

The FQDN or IP address to contact for origination traffic.

Returns:

  • (String)

    The FQDN or IP address to contact for origination traffic.

#portInteger

The designated origination route port. Defaults to 5060.

Returns:

  • (Integer)

    The designated origination route port.

#priorityInteger

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Returns:

  • (Integer)

    The priority associated with the host, with 1 being the highest priority.

#protocolString

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

Possible values:

  • TCP
  • UDP

Returns:

  • (String)

    The protocol to use for the origination route.

#weightInteger

The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

Returns:

  • (Integer)

    The weight associated with the host.