chime/aws.sdk.kotlin.services.chime.model/SipRule

SipRule

class SipRule

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val createdTimestamp: Instant?

The time at which the SIP rule was created, in ISO 8601 format.

Link copied to clipboard
val disabled: Boolean?

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

Link copied to clipboard
val name: String?

The name of the SIP rule.

Link copied to clipboard
val sipRuleId: String?

The SIP rule ID.

Link copied to clipboard
val targetApplications: List<SipRuleTargetApplication>?

Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

Link copied to clipboard
val triggerType: SipRuleTriggerType?

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

Link copied to clipboard
val triggerValue: 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.

Link copied to clipboard
val updatedTimestamp: Instant?

The time at which the SIP rule was last updated, in ISO 8601 format.

Functions

Link copied to clipboard
inline fun copy(block: SipRule.Builder.() -> Unit = {}): SipRule
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String