Package software.amazon.awscdk.services.ivs

Interface CfnIngestConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIngestConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:43.702Z")
@Stability(Stable)
public interface CfnIngestConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIngestConfiguration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnIngestConfigurationProps cfnIngestConfigurationProps = CfnIngestConfigurationProps.builder()
         .ingestProtocol("ingestProtocol")
         .insecureIngest(false)
         .name("name")
         .stageArn("stageArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userId("userId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIngestConfigurationProps.Builder	A builder for CfnIngestConfigurationProps
static final class	CfnIngestConfigurationProps.Jsii$Proxy	An implementation for CfnIngestConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnIngestConfigurationProps.Builder	builder()
default String	getIngestProtocol()	Type of ingest protocol that the user employs for broadcasting.
default Object	getInsecureIngest()	Whether the channel allows insecure RTMP ingest.
default String	getName()	Ingest name.
default String	getStageArn()	ARN of the stage with which the IngestConfiguration is associated.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getUserId()	Customer-assigned name to help identify the participant using the IngestConfiguration;

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIngestProtocol

@Stability(Stable)
@Nullable
default String getIngestProtocol()

Type of ingest protocol that the user employs for broadcasting.

Default: - "RTMPS"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-ingestprotocol

getInsecureIngest

@Stability(Stable)
@Nullable
default Object getInsecureIngest()

Whether the channel allows insecure RTMP ingest.

Default: false .

Returns union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-insecureingest

getName

@Stability(Stable)
@Nullable
default String getName()

Ingest name.

Default: - "-"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-name

getStageArn

@Stability(Stable)
@Nullable
default String getStageArn()

ARN of the stage with which the IngestConfiguration is associated.

Default: - ""

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-stagearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-tags

getUserId

@Stability(Stable)
@Nullable
default String getUserId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-userid

builder

@Stability(Stable)
static CfnIngestConfigurationProps.Builder builder()

Returns:

a CfnIngestConfigurationProps.Builder of CfnIngestConfigurationProps