Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotanalytics
  5. getChannel

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.getChannel

Explore with Pulumi AI

aws-native logo

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

    Resource Type definition for AWS::IoTAnalytics::Channel

    Using getChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>
    def get_channel(channel_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetChannelResult
def get_channel_output(channel_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]
    func LookupChannel(ctx *Context, args *LookupChannelArgs, opts ...InvokeOption) (*LookupChannelResult, error)
func LookupChannelOutput(ctx *Context, args *LookupChannelOutputArgs, opts ...InvokeOption) LookupChannelResultOutput

    > Note: This function is named LookupChannel in the Go SDK.

    public static class GetChannel 
{
    public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:iotanalytics:getChannel
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ChannelName string
    The name of the channel.
    ChannelName string
    The name of the channel.
    channelName String
    The name of the channel.
    channelName string
    The name of the channel.
    channel_name str
    The name of the channel.
    channelName String
    The name of the channel.

    getChannel Result

    The following output properties are available:

    ChannelStorage Pulumi.AwsNative.IoTAnalytics.Outputs.ChannelStorage
    Where channel data is stored.
    Id string
    RetentionPeriod Pulumi.AwsNative.IoTAnalytics.Outputs.ChannelRetentionPeriod
    How long, in days, message data is kept for the channel.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    Metadata which can be used to manage the channel.

    For more information, see Tag .

    ChannelStorage ChannelStorage
    Where channel data is stored.
    Id string
    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 .

    channelStorage ChannelStorage
    Where channel data is stored.
    id String
    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 .

    channelStorage ChannelStorage
    Where channel data is stored.
    id string
    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_storage ChannelStorage
    Where channel data is stored.
    id str
    retention_period ChannelRetentionPeriod
    How long, in days, message data is kept for the channel.
    tags Sequence[root_Tag]

    Metadata which can be used to manage the channel.

    For more information, see Tag .

    channelStorage Property Map
    Where channel data is stored.
    id String
    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 .

    Supporting Types

    ChannelCustomerManagedS3

    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

    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

    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

    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

    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