Struct IngestConfigurationSummary 

#[non_exhaustive]
pub struct IngestConfigurationSummary {
    pub name: Option<String>,
    pub arn: String,
    pub ingest_protocol: IngestProtocol,
    pub stage_arn: String,
    pub participant_id: String,
    pub state: IngestConfigurationState,
    pub user_id: Option<String>,
}

Summary information about an IngestConfiguration.

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.

name: Option<String>

Ingest name.

arn: String

Ingest configuration ARN.

ingest_protocol: IngestProtocol

Type of ingest protocol that the user employs for broadcasting.

stage_arn: String

ARN of the stage with which the IngestConfiguration is associated.

participant_id: String

ID of the participant within the stage.

state: IngestConfigurationState

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

user_id: Option<String>

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. 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.

Implementations

impl IngestConfigurationSummary

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

Ingest name.

pub fn arn(&self) -> &str

Ingest configuration ARN.

pub fn ingest_protocol(&self) -> &IngestProtocol

Type of ingest protocol that the user employs for broadcasting.

pub fn stage_arn(&self) -> &str

ARN of the stage with which the IngestConfiguration is associated.

pub fn participant_id(&self) -> &str

ID of the participant within the stage.

pub fn state(&self) -> &IngestConfigurationState

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

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

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. 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.

impl IngestConfigurationSummary

pub fn builder() -> IngestConfigurationSummaryBuilder

Creates a new builder-style object to manufacture IngestConfigurationSummary.

Trait Implementations

impl Clone for IngestConfigurationSummary

fn clone(&self) -> IngestConfigurationSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IngestConfigurationSummary

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

Formats the value using the given formatter.

impl PartialEq for IngestConfigurationSummary

fn eq(&self, other: &IngestConfigurationSummary) -> 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 IngestConfigurationSummary