/*
* 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 ivs-realtime-2020-07-14.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.IVSRealTime.Model
{
///
/// Container for the parameters to the CreateParticipantToken operation.
/// Creates an additional token for a specified stage. This can be done after stage creation
/// or when tokens expire. Tokens always are scoped to the stage for which they are created.
///
///
///
/// Encryption keys are owned by Amazon IVS and never used directly by your application.
///
///
public partial class CreateParticipantTokenRequest : AmazonIVSRealTimeRequest
{
private Dictionary _attributes = new Dictionary();
private List _capabilities = new List();
private int? _duration;
private string _stageArn;
private string _userId;
///
/// Gets and sets the property Attributes.
///
/// Application-provided attributes to encode into the token and attach to a stage. Map
/// keys and values can contain UTF-8 encoded text. The maximum length of this field is
/// 1 KB total. This field is exposed to all stage participants and should not be used
/// for personally identifying, confidential, or sensitive information.
///
///
public Dictionary Attributes
{
get { return this._attributes; }
set { this._attributes = value; }
}
// Check to see if Attributes property is set
internal bool IsSetAttributes()
{
return this._attributes != null && this._attributes.Count > 0;
}
///
/// Gets and sets the property Capabilities.
///
/// Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH,
/// SUBSCRIBE
.
///
///
[AWSProperty(Min=0, Max=2)]
public List Capabilities
{
get { return this._capabilities; }
set { this._capabilities = value; }
}
// Check to see if Capabilities property is set
internal bool IsSetCapabilities()
{
return this._capabilities != null && this._capabilities.Count > 0;
}
///
/// Gets and sets the property Duration.
///
/// Duration (in minutes), after which the token expires. Default: 720 (12 hours).
///
///
[AWSProperty(Min=1, Max=20160)]
public int Duration
{
get { return this._duration.GetValueOrDefault(); }
set { this._duration = value; }
}
// Check to see if Duration property is set
internal bool IsSetDuration()
{
return this._duration.HasValue;
}
///
/// Gets and sets the property StageArn.
///
/// ARN of the stage to which this token is scoped.
///
///
[AWSProperty(Required=true, Min=1, Max=128)]
public string StageArn
{
get { return this._stageArn; }
set { this._stageArn = value; }
}
// Check to see if StageArn property is set
internal bool IsSetStageArn()
{
return this._stageArn != null;
}
///
/// Gets and sets the property UserId.
///
/// Name that can be specified to help identify the token. This can be any UTF-8 encoded
/// text. This field is exposed to all stage participants and should not be used for
/// personally identifying, confidential, or sensitive information.
///
///
[AWSProperty(Min=0, Max=128)]
public string UserId
{
get { return this._userId; }
set { this._userId = value; }
}
// Check to see if UserId property is set
internal bool IsSetUserId()
{
return this._userId != null;
}
}
}