Struct CreateParticipantTokenInput 

#[non_exhaustive]
pub struct CreateParticipantTokenInput {
    pub stage_arn: Option<String>,
    pub duration: Option<i32>,
    pub user_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub capabilities: Option<Vec<ParticipantTokenCapability>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stage_arn: Option<String>

ARN of the stage to which this token is scoped.

duration: Option<i32>

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

user_id: Option<String>

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.

attributes: Option<HashMap<String, String>>

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.

capabilities: Option<Vec<ParticipantTokenCapability>>

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Implementations

impl CreateParticipantTokenInput

pub fn stage_arn(&self) -> Option<&str>

ARN of the stage to which this token is scoped.

pub fn duration(&self) -> Option<i32>

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

pub fn user_id(&self) -> Option<&str>

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.

pub fn attributes(&self) -> Option<&HashMap<String, String>>

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.

pub fn capabilities(&self) -> &[ParticipantTokenCapability]

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capabilities.is_none().

impl CreateParticipantTokenInput

pub fn builder() -> CreateParticipantTokenInputBuilder

Creates a new builder-style object to manufacture CreateParticipantTokenInput.

Trait Implementations

impl Clone for CreateParticipantTokenInput

fn clone(&self) -> CreateParticipantTokenInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateParticipantTokenInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateParticipantTokenInput

fn eq(&self, other: &CreateParticipantTokenInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateParticipantTokenInput