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

Class: Aws::Chime::Types::SipRule

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

Overview

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestamp ⇒ Time

The SIP rule created timestamp, in ISO 8601 format.

Returns:

  • (Time) —

    The SIP rule created timestamp, in ISO 8601 format.

#disabled ⇒ Boolean

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Returns:

  • (Boolean) —

    Indicates if the SIP rule is enabled or disabled.

#name ⇒ String

The name of the SIP rule.

Returns:

  • (String) —

    The name of the SIP rule.

#sip_rule_id ⇒ String

The SIP rule ID.

Returns:

  • (String) —

    The SIP rule ID.

#target_applications ⇒ Array<Types::SipRuleTargetApplication>

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

Returns:

#trigger_type ⇒ String

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

Possible values:

  • ToPhoneNumber
  • RequestUriHostname

Returns:

  • (String) —

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

#trigger_value ⇒ String

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

Returns:

  • (String) —

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

#updated_timestamp ⇒ Time

The SIP rule updated timestamp, in ISO 8601 format.

Returns:

  • (Time) —

    The SIP rule updated timestamp, in ISO 8601 format.