Struct IngestConfiguration

#[non_exhaustive]
pub struct IngestConfiguration {
    pub name: Option<String>,
    pub arn: String,
    pub ingest_protocol: IngestProtocol,
    pub stream_key: String,
    pub stage_arn: String,
    pub participant_id: String,
    pub state: IngestConfigurationState,
    pub user_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub tags: Option<HashMap<String, String>>,
}

Object specifying an ingest configuration.

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.

stream_key: String

Ingest-key value for the RTMP(S) protocol.

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.

attributes: Option<HashMap<String, String>>

Application-provided attributes to to store in the IngestConfiguration 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.

tags: Option<HashMap<String, String>>

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Implementations

impl IngestConfiguration

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 stream_key(&self) -> &str

Ingest-key value for the RTMP(S) protocol.

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.

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

Application-provided attributes to to store in the IngestConfiguration 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 tags(&self) -> Option<&HashMap<String, String>>

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

impl IngestConfiguration

pub fn builder() -> IngestConfigurationBuilder

Creates a new builder-style object to manufacture IngestConfiguration.

Trait Implementations

impl Clone for IngestConfiguration

fn clone(&self) -> IngestConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IngestConfiguration

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

Formats the value using the given formatter.

impl PartialEq for IngestConfiguration

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