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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestampTime

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

Returns:

  • (Time)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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

#disabledBoolean

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

Returns:

  • (Boolean)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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

#nameString

The name of the SIP rule.

Returns:

  • (String)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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_idString

The SIP rule ID.

Returns:

  • (String)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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_applicationsArray<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.



8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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_typeString

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

Returns:

  • (String)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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_valueString

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)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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_timestampTime

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

Returns:

  • (Time)


8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8531

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