Struct CreateIngestConfigurationInput 

#[non_exhaustive]
pub struct CreateIngestConfigurationInput {
    pub name: Option<String>,
    pub stage_arn: Option<String>,
    pub user_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub ingest_protocol: Option<IngestProtocol>,
    pub insecure_ingest: Option<bool>,
    pub tags: Option<HashMap<String, String>>,
}

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>

Optional name that can be specified for the IngestConfiguration being created.

stage_arn: Option<String>

ARN of the stage with which the IngestConfiguration is associated.

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 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.

ingest_protocol: Option<IngestProtocol>

Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

insecure_ingest: Option<bool>

Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

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 CreateIngestConfigurationInput

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

Optional name that can be specified for the IngestConfiguration being created.

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

ARN of the stage with which the IngestConfiguration is associated.

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 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 ingest_protocol(&self) -> Option<&IngestProtocol>

Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

pub fn insecure_ingest(&self) -> Option<bool>

Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

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 CreateIngestConfigurationInput

pub fn builder() -> CreateIngestConfigurationInputBuilder

Creates a new builder-style object to manufacture CreateIngestConfigurationInput.

Trait Implementations

impl Clone for CreateIngestConfigurationInput

fn clone(&self) -> CreateIngestConfigurationInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIngestConfigurationInput

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

Formats the value using the given formatter.

impl PartialEq for CreateIngestConfigurationInput

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