Package software.amazon.awscdk.services.iot

Interface CfnStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:11.837Z")
@Stability(Stable)
public interface CfnStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStream.

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.iot.*;
 CfnStreamProps cfnStreamProps = CfnStreamProps.builder()
         .files(List.of(StreamFileProperty.builder()
                 .fileId(123)
                 .s3Location(S3LocationProperty.builder()
                         .bucket("bucket")
                         .key("key")
                         .version("version")
                         .build())
                 .build()))
         .roleArn("roleArn")
         .streamId("streamId")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStreamProps.Builder	builder()
default String	getDescription()	The description of the stream.
Object	getFiles()	The files to stream.
String	getRoleArn()	An IAM role that allows the IoT service principal to access your S3 files.
String	getStreamId()	The stream ID.
default List<CfnTag>	getTags()	Metadata which can be used to manage streams.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFiles

@Stability(Stable)
@NotNull
Object getFiles()

The files to stream.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStream.StreamFileProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html#cfn-iot-stream-files

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

An IAM role that allows the IoT service principal to access your S3 files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html#cfn-iot-stream-rolearn

getStreamId

@Stability(Stable)
@NotNull
String getStreamId()

The stream ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html#cfn-iot-stream-streamid

getDescription

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

The description of the stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html#cfn-iot-stream-description

getTags

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

Metadata which can be used to manage streams.

See Also:

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

builder

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

Returns:

a CfnStreamProps.Builder of CfnStreamProps