Class: Aws::ChimeSDKVoice::Types::SipRule

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKVoice::Types::SipRule

Defined in:

gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb

Overview

The details of a SIP rule, 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

  A SIP rule's name.

• #sip_rule_id ⇒ String

  A SIP rule's ID.

• #target_applications ⇒ Array<Types::SipRuleTargetApplication>

  The 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 set for a SIP rule, either a phone number or a URI request host name.

• #trigger_value ⇒ String

  The value set for a SIP rule's trigger type.

• #updated_timestamp ⇒ Time

  The time at which the SIP rule was 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 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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

A SIP rule's name.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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

A SIP rule's ID.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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>

The 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 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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 set for a SIP rule, either a phone number or a URI request host name.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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 updated, in ISO 8601 format.

Returns:

• (Time)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 3160

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