/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the chime-sdk-voice-2022-08-03.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.ChimeSDKVoice.Model
{
///
/// Container for the parameters to the CreateSipRule operation.
/// Creates a SIP rule, which can be used to run a SIP media application as a target for
/// a specific trigger type. For more information about SIP rules, see Managing
/// SIP media applications and rules in the Amazon Chime SDK Administrator Guide.
///
public partial class CreateSipRuleRequest : AmazonChimeSDKVoiceRequest
{
private bool? _disabled;
private string _name;
private List _targetApplications = new List();
private SipRuleTriggerType _triggerType;
private string _triggerValue;
///
/// Gets and sets the property Disabled.
///
/// Disables or enables a SIP rule. You must disable SIP rules before you can delete them.
///
///
public bool Disabled
{
get { return this._disabled.GetValueOrDefault(); }
set { this._disabled = value; }
}
// Check to see if Disabled property is set
internal bool IsSetDisabled()
{
return this._disabled.HasValue;
}
///
/// Gets and sets the property Name.
///
/// The name of the SIP rule.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property TargetApplications.
///
/// List of SIP media applications, with priority and AWS Region. Only one SIP application
/// per AWS Region can be used.
///
///
[AWSProperty(Min=1, Max=25)]
public List TargetApplications
{
get { return this._targetApplications; }
set { this._targetApplications = value; }
}
// Check to see if TargetApplications property is set
internal bool IsSetTargetApplications()
{
return this._targetApplications != null && this._targetApplications.Count > 0;
}
///
/// Gets and sets the property TriggerType.
///
/// The type of trigger assigned to the SIP rule in TriggerValue
, currently
/// RequestUriHostname
or ToPhoneNumber
.
///
///
[AWSProperty(Required=true)]
public SipRuleTriggerType TriggerType
{
get { return this._triggerType; }
set { this._triggerType = value; }
}
// Check to see if TriggerType property is set
internal bool IsSetTriggerType()
{
return this._triggerType != null;
}
///
/// Gets and sets the property TriggerValue.
///
/// If TriggerType
is RequestUriHostname
, the value can be the
/// outbound host name of a Voice Connector. If TriggerType
is ToPhoneNumber
,
/// the value can be a customer-owned phone number in the E164 format. The SipMediaApplication
/// specified in the SipRule
is triggered if the request URI in an incoming
/// SIP request matches the RequestUriHostname
, or if the To
/// header in the incoming SIP request matches the ToPhoneNumber
value.
///
///
[AWSProperty(Required=true)]
public string TriggerValue
{
get { return this._triggerValue; }
set { this._triggerValue = value; }
}
// Check to see if TriggerValue property is set
internal bool IsSetTriggerValue()
{
return this._triggerValue != null;
}
}
}