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.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.869Z")
@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()	Ingest Protocol.
default Object	getInsecureIngest()	Whether ingest configuration allows insecure ingest.
default String	getName()	IngestConfiguration.
default String	getStageArn()	Stage ARN.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the asset model.
default String	getUserId()	User defined indentifier for participant associated with IngestConfiguration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIngestProtocol

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

Ingest Protocol.

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 ingest configuration allows insecure ingest.

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()

IngestConfiguration.

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()

Stage ARN.

A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).

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()

A list of key-value pairs that contain metadata for the asset model.

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()

User defined indentifier for participant associated with IngestConfiguration.

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