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

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::SipRule

Includes:

Structure

Defined in:

lib/aws-sdk-chime/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_timestamp ⇒ Time

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

• #disabled ⇒ Boolean

  Indicates whether the SIP rule is enabled or disabled.

• #name ⇒ String

  The name of the SIP rule.

• #sip_rule_id ⇒ String

  The SIP rule ID.

• #target_applications ⇒ Array<Types::SipRuleTargetApplication>

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

• #trigger_type ⇒ String

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

• #trigger_value ⇒ String

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

• #updated_timestamp ⇒ Time

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

Instance Attribute Details

#created_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#disabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the SIP rule.

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#sip_rule_id ⇒ String

The SIP rule ID.

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#target_applications ⇒ Array<Types::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.

Returns:

• (Array<Types::SipRuleTargetApplication>)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#updated_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-chime/types.rb', line 7601

class SipRule < Struct.new(
  :sip_rule_id,
  :name,
  :disabled,
  :trigger_type,
  :trigger_value,
  :target_applications,
  :created_timestamp,
  :updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end