You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTAnalytics::Types::UpdateChannelRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateChannelRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  channel_name: "ChannelName", # required
  channel_storage: {
    service_managed_s3: {
    },
    customer_managed_s3: {
      bucket: "BucketName", # required
      key_prefix: "S3KeyPrefix",
      role_arn: "RoleArn", # required
    },
  },
  retention_period: {
    unlimited: false,
    number_of_days: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#channel_name ⇒ String

The name of the channel to be updated.

Returns:

  • (String) —

    The name of the channel to be updated.

#channel_storage ⇒ Types::ChannelStorage

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the channel is created.

Returns:

#retention_period ⇒ Types::RetentionPeriod

How long, in days, message data is kept for the channel. The retention period cannot be updated if the channel\'s S3 storage is customer-managed.

Returns: