AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotanalytics.Channel

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

Example Usage

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IoTAnalytics.Channel("channel", new()
    {
        ChannelName = "SimpleChannel",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotanalytics.NewChannel(ctx, "channel", &iotanalytics.ChannelArgs{
			ChannelName: pulumi.String("SimpleChannel"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "SimpleChannel"});

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.iotanalytics.Channel("channel", channel_name="SimpleChannel")

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IoTAnalytics.Channel("channel", new()
    {
        ChannelName = "SimpleChannel",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotanalytics.NewChannel(ctx, "channel", &iotanalytics.ChannelArgs{
			ChannelName: pulumi.String("SimpleChannel"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "SimpleChannel"});

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.iotanalytics.Channel("channel", channel_name="SimpleChannel")

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IoTAnalytics.Channel("channel", new()
    {
        ChannelName = "ComplexChannel",
        RetentionPeriod = new AwsNative.IoTAnalytics.Inputs.ChannelRetentionPeriodArgs
        {
            Unlimited = false,
            NumberOfDays = 10,
        },
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "keyname1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "keyname2",
                Value = "value2",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotanalytics.NewChannel(ctx, "channel", &iotanalytics.ChannelArgs{
			ChannelName: pulumi.String("ComplexChannel"),
			RetentionPeriod: &iotanalytics.ChannelRetentionPeriodArgs{
				Unlimited:    pulumi.Bool(false),
				NumberOfDays: pulumi.Int(10),
			},
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("keyname1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("keyname2"),
					Value: pulumi.String("value2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.iotanalytics.Channel("channel", {
    channelName: "ComplexChannel",
    retentionPeriod: {
        unlimited: false,
        numberOfDays: 10,
    },
    tags: [
        {
            key: "keyname1",
            value: "value1",
        },
        {
            key: "keyname2",
            value: "value2",
        },
    ],
});

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.iotanalytics.Channel("channel",
    channel_name="ComplexChannel",
    retention_period={
        "unlimited": False,
        "number_of_days": 10,
    },
    tags=[
        {
            "key": "keyname1",
            "value": "value1",
        },
        {
            "key": "keyname2",
            "value": "value2",
        },
    ])

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IoTAnalytics.Channel("channel", new()
    {
        ChannelName = "ComplexChannel",
        RetentionPeriod = new AwsNative.IoTAnalytics.Inputs.ChannelRetentionPeriodArgs
        {
            Unlimited = false,
            NumberOfDays = 10,
        },
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "keyname1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "keyname2",
                Value = "value2",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotanalytics.NewChannel(ctx, "channel", &iotanalytics.ChannelArgs{
			ChannelName: pulumi.String("ComplexChannel"),
			RetentionPeriod: &iotanalytics.ChannelRetentionPeriodArgs{
				Unlimited:    pulumi.Bool(false),
				NumberOfDays: pulumi.Int(10),
			},
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("keyname1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("keyname2"),
					Value: pulumi.String("value2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.iotanalytics.Channel("channel", {
    channelName: "ComplexChannel",
    retentionPeriod: {
        unlimited: false,
        numberOfDays: 10,
    },
    tags: [
        {
            key: "keyname1",
            value: "value1",
        },
        {
            key: "keyname2",
            value: "value2",
        },
    ],
});

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.iotanalytics.Channel("channel",
    channel_name="ComplexChannel",
    retention_period={
        "unlimited": False,
        "number_of_days": 10,
    },
    tags=[
        {
            "key": "keyname1",
            "value": "value1",
        },
        {
            "key": "keyname2",
            "value": "value2",
        },
    ])

Coming soon!

Create Channel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);

@overload
def Channel(resource_name: str,
            args: Optional[ChannelArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            channel_name: Optional[str] = None,
            channel_storage: Optional[ChannelStorageArgs] = None,
            retention_period: Optional[ChannelRetentionPeriodArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewChannel(ctx *Context, name string, args *ChannelArgs, opts ...ResourceOption) (*Channel, error)

public Channel(string name, ChannelArgs? args = null, CustomResourceOptions? opts = null)

public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

type: aws-native:iotanalytics:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ChannelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ChannelArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ChannelArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ChannelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ChannelArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Channel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Channel resource accepts the following input properties:

ChannelName string

The name of the channel.

ChannelStorage Pulumi.AwsNative.IoTAnalytics.Inputs.ChannelStorage

Where channel data is stored.

RetentionPeriod Pulumi.AwsNative.IoTAnalytics.Inputs.ChannelRetentionPeriod

How long, in days, message data is kept for the channel.

Tags List<Pulumi.AwsNative.Inputs.Tag>

Metadata which can be used to manage the channel.

For more information, see Tag .

ChannelName string

The name of the channel.

ChannelStorage ChannelStorageArgs

Where channel data is stored.

RetentionPeriod ChannelRetentionPeriodArgs

How long, in days, message data is kept for the channel.

Tags TagArgs

Metadata which can be used to manage the channel.

For more information, see Tag .

channelName String

The name of the channel.

channelStorage ChannelStorage

Where channel data is stored.

retentionPeriod ChannelRetentionPeriod

How long, in days, message data is kept for the channel.

tags List<Tag>

Metadata which can be used to manage the channel.

For more information, see Tag .

channelName string

The name of the channel.

channelStorage ChannelStorage

Where channel data is stored.

retentionPeriod ChannelRetentionPeriod

How long, in days, message data is kept for the channel.

tags Tag[]

Metadata which can be used to manage the channel.

For more information, see Tag .

channel_name str

The name of the channel.

channel_storage ChannelStorageArgs

Where channel data is stored.

retention_period ChannelRetentionPeriodArgs

How long, in days, message data is kept for the channel.

tags Sequence[TagArgs]

Metadata which can be used to manage the channel.

For more information, see Tag .

channelName String

The name of the channel.

channelStorage Property Map

Where channel data is stored.

retentionPeriod Property Map

How long, in days, message data is kept for the channel.

tags List<Property Map>

Metadata which can be used to manage the channel.

For more information, see Tag .

Outputs

All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:

AwsId string
Id string: The provider-assigned unique ID for this managed resource.

AwsId string
Id string: The provider-assigned unique ID for this managed resource.

awsId String
id String: The provider-assigned unique ID for this managed resource.

awsId string
id string: The provider-assigned unique ID for this managed resource.

aws_id str
id str: The provider-assigned unique ID for this managed resource.

awsId String
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

ChannelCustomerManagedS3, ChannelCustomerManagedS3Args

Bucket string: The name of the S3 bucket in which channel data is stored.
RoleArn string: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
KeyPrefix string: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

Bucket string: The name of the S3 bucket in which channel data is stored.
RoleArn string: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
KeyPrefix string: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

bucket String: The name of the S3 bucket in which channel data is stored.
roleArn String: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
keyPrefix String: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

bucket string: The name of the S3 bucket in which channel data is stored.
roleArn string: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
keyPrefix string: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

bucket str: The name of the S3 bucket in which channel data is stored.
role_arn str: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
key_prefix str: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

bucket String: The name of the S3 bucket in which channel data is stored.
roleArn String: The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
keyPrefix String: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

ChannelRetentionPeriod, ChannelRetentionPeriodArgs

NumberOfDays int: The number of days that message data is kept. The unlimited parameter must be false.
Unlimited bool: If true, message data is kept indefinitely.

NumberOfDays int: The number of days that message data is kept. The unlimited parameter must be false.
Unlimited bool: If true, message data is kept indefinitely.

numberOfDays Integer: The number of days that message data is kept. The unlimited parameter must be false.
unlimited Boolean: If true, message data is kept indefinitely.

numberOfDays number: The number of days that message data is kept. The unlimited parameter must be false.
unlimited boolean: If true, message data is kept indefinitely.

number_of_days int: The number of days that message data is kept. The unlimited parameter must be false.
unlimited bool: If true, message data is kept indefinitely.

numberOfDays Number: The number of days that message data is kept. The unlimited parameter must be false.
unlimited Boolean: If true, message data is kept indefinitely.

ChannelStorage, ChannelStorageArgs

CustomerManagedS3 Pulumi.AwsNative.IoTAnalytics.Inputs.ChannelCustomerManagedS3: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
ServiceManagedS3 Pulumi.AwsNative.IoTAnalytics.Inputs.ChannelServiceManagedS3: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

CustomerManagedS3 ChannelCustomerManagedS3: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
ServiceManagedS3 ChannelServiceManagedS3: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

customerManagedS3 ChannelCustomerManagedS3: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
serviceManagedS3 ChannelServiceManagedS3: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

customerManagedS3 ChannelCustomerManagedS3: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
serviceManagedS3 ChannelServiceManagedS3: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

customer_managed_s3 ChannelCustomerManagedS3: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
service_managed_s3 ChannelServiceManagedS3: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

customerManagedS3 Property Map: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
serviceManagedS3 Property Map: Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can't change the choice of S3 storage after the data store is created.

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotanalytics.Channel

On this page

On this page

Example Usage

Example

Example

Example

Example

Create Channel Resource

Constructor syntax

Parameters

Channel Resource Properties

Inputs

Outputs

Supporting Types

ChannelCustomerManagedS3, ChannelCustomerManagedS3Args

ChannelRetentionPeriod, ChannelRetentionPeriodArgs

ChannelStorage, ChannelStorageArgs

Tag, TagArgs

Package Details

On this page

On this page