Amazonka.Chime.Types.OriginationRoute

Documentation

data OriginationRoute

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.

The parameters listed below are not required, but you must use at least one.

See: newOriginationRoute smart constructor.

Constructors

OriginationRoute'

Fields

• host :: Maybe Text

  The FQDN or IP address to contact for origination traffic.

• port :: Maybe Natural

  The designated origination route port. Defaults to 5060.

• priority :: Maybe Natural

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

• protocol :: Maybe OriginationRouteProtocol

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

• weight :: Maybe Natural

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

Instances

FromJSON OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

parseJSON :: Value -> Parser OriginationRoute

parseJSONList :: Value -> Parser [OriginationRoute]

ToJSON OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

toJSON :: OriginationRoute -> Value

toEncoding :: OriginationRoute -> Encoding

toJSONList :: [OriginationRoute] -> Value

toEncodingList :: [OriginationRoute] -> Encoding

Generic OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Associated Types

type Rep OriginationRoute :: Type -> Type

Methods

from :: OriginationRoute -> Rep OriginationRoute x

to :: Rep OriginationRoute x -> OriginationRoute

Read OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

readsPrec :: Int -> ReadS OriginationRoute

readList :: ReadS [OriginationRoute]

readPrec :: ReadPrec OriginationRoute

readListPrec :: ReadPrec [OriginationRoute]

Show OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

showsPrec :: Int -> OriginationRoute -> ShowS

show :: OriginationRoute -> String

showList :: [OriginationRoute] -> ShowS

NFData OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

rnf :: OriginationRoute -> ()

Eq OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

(==) :: OriginationRoute -> OriginationRoute -> Bool

(/=) :: OriginationRoute -> OriginationRoute -> Bool

Hashable OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

Methods

hashWithSalt :: Int -> OriginationRoute -> Int

hash :: OriginationRoute -> Int

type Rep OriginationRoute

Defined in Amazonka.Chime.Types.OriginationRoute

type Rep OriginationRoute = D1 ('MetaData "OriginationRoute" "Amazonka.Chime.Types.OriginationRoute" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "OriginationRoute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OriginationRouteProtocol)) :*: S1 ('MetaSel ('Just "weight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newOriginationRoute :: OriginationRoute

Create a value of OriginationRoute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:host:OriginationRoute', originationRoute_host - The FQDN or IP address to contact for origination traffic.

$sel:port:OriginationRoute', originationRoute_port - The designated origination route port. Defaults to 5060.

$sel:priority:OriginationRoute', originationRoute_priority - The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

$sel:protocol:OriginationRoute', originationRoute_protocol - The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

$sel:weight:OriginationRoute', originationRoute_weight - The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

originationRoute_host :: Lens' OriginationRoute (Maybe Text)

The FQDN or IP address to contact for origination traffic.

originationRoute_port :: Lens' OriginationRoute (Maybe Natural)

The designated origination route port. Defaults to 5060.

originationRoute_priority :: Lens' OriginationRoute (Maybe Natural)

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

originationRoute_protocol :: Lens' OriginationRoute (Maybe OriginationRouteProtocol)

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

originationRoute_weight :: Lens' OriginationRoute (Maybe Natural)

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