1. Packages
  2. AWS Native
  3. API Docs
  4. iotanalytics
  5. Channel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.iotanalytics.Channel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Resource Type definition for AWS::IoTAnalytics::Channel

    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 pulumi
    import pulumi_aws_native as aws_native
    
    channel = aws_native.iotanalytics.Channel("channel", channel_name="SimpleChannel")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "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 pulumi
    import pulumi_aws_native as aws_native
    
    channel = aws_native.iotanalytics.Channel("channel", channel_name="SimpleChannel")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "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 pulumi
    import pulumi_aws_native as aws_native
    
    channel = aws_native.iotanalytics.Channel("channel",
        channel_name="ComplexChannel",
        retention_period=aws_native.iotanalytics.ChannelRetentionPeriodArgs(
            unlimited=False,
            number_of_days=10,
        ),
        tags=[
            aws_native.TagArgs(
                key="keyname1",
                value="value1",
            ),
            aws_native.TagArgs(
                key="keyname2",
                value="value2",
            ),
        ])
    
    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",
            },
        ],
    });
    

    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 pulumi
    import pulumi_aws_native as aws_native
    
    channel = aws_native.iotanalytics.Channel("channel",
        channel_name="ComplexChannel",
        retention_period=aws_native.iotanalytics.ChannelRetentionPeriodArgs(
            unlimited=False,
            number_of_days=10,
        ),
        tags=[
            aws_native.TagArgs(
                key="keyname1",
                value="value1",
            ),
            aws_native.TagArgs(
                key="keyname2",
                value="value2",
            ),
        ])
    
    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",
            },
        ],
    });
    

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeChannelResource = new aws_native.iotanalytics.Channel("aws-nativeChannelResource", {
        channelName: "string",
        channelStorage: {
            customerManagedS3: {
                bucket: "string",
                roleArn: "string",
                keyPrefix: "string",
            },
            serviceManagedS3: {},
        },
        retentionPeriod: {
            numberOfDays: 0,
            unlimited: false,
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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

    The Channel resource accepts the following input properties:

    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
    RoleArn string
    KeyPrefix string
    Bucket string
    RoleArn string
    KeyPrefix string
    bucket String
    roleArn String
    keyPrefix String
    bucket string
    roleArn string
    keyPrefix string
    bucket String
    roleArn String
    keyPrefix String

    ChannelRetentionPeriod, ChannelRetentionPeriodArgs

    numberOfDays Integer
    unlimited Boolean
    numberOfDays number
    unlimited boolean
    numberOfDays Number
    unlimited Boolean

    ChannelStorage, ChannelStorageArgs

    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi