Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnStreamMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamMixinProps.Jsii$Proxy

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

Properties for CfnStreamPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iot.*;
 CfnStreamMixinProps cfnStreamMixinProps = CfnStreamMixinProps.builder()
         .description("description")
         .files(List.of(StreamFileProperty.builder()
                 .fileId(123)
                 .s3Location(S3LocationProperty.builder()
                         .bucket("bucket")
                         .key("key")
                         .version("version")
                         .build())
                 .build()))
         .roleArn("roleArn")
         .streamId("streamId")
         .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	CfnStreamMixinProps.Builder	A builder for CfnStreamMixinProps
static final class	CfnStreamMixinProps.Jsii$Proxy	An implementation for CfnStreamMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnStreamMixinProps.Builder	builder()
default String	getDescription()	The description of the stream.
default Object	getFiles()	The files to stream.
default String	getRoleArn()	An IAM role that allows the IoT service principal to access your S3 files.
default 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

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

getFiles

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

The files to stream.

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

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default 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)
@Nullable
default String getStreamId()

The stream ID.

See Also:

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

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 CfnStreamMixinProps.Builder builder()

Returns:

a CfnStreamMixinProps.Builder of CfnStreamMixinProps