aws_sdk_ivsrealtime/client/

create_ingest_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateIngestConfiguration`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_name):<br>required: **false**<br><p>Optional name that can be specified for the IngestConfiguration being created.</p><br>
    ///   - [`stage_arn(impl Into<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::stage_arn) / [`set_stage_arn(Option<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_stage_arn):<br>required: **false**<br><p>ARN of the stage with which the IngestConfiguration is associated.</p><br>
    ///   - [`user_id(impl Into<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_user_id):<br>required: **false**<br><p>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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_attributes):<br>required: **false**<br><p>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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p><br>
    ///   - [`ingest_protocol(IngestProtocol)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::ingest_protocol) / [`set_ingest_protocol(Option<IngestProtocol>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_ingest_protocol):<br>required: **true**<br><p>Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.</p><br>
    ///   - [`insecure_ingest(bool)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::insecure_ingest) / [`set_insecure_ingest(Option<bool>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_insecure_ingest):<br>required: **false**<br><p>Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::set_tags):<br>required: **false**<br><p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> 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.</p><br>
    /// - On success, responds with [`CreateIngestConfigurationOutput`](crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput) with field(s):
    ///   - [`ingest_configuration(Option<IngestConfiguration>)`](crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput::ingest_configuration): <p>The IngestConfiguration that was created.</p>
    /// - On failure, responds with [`SdkError<CreateIngestConfigurationError>`](crate::operation::create_ingest_configuration::CreateIngestConfigurationError)
    pub fn create_ingest_configuration(&self) -> crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder {
        crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationFluentBuilder::new(self.handle.clone())
    }
}