AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::IoTAnalytics::Types::CustomerManagedChannelS3Storage

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

Overview

Note:

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

{
  bucket: "BucketName", # required
  key_prefix: "S3KeyPrefix",
  role_arn: "RoleArn", # required
}

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The name of the S3 bucket in which channel data is stored.

Returns:

  • (String)

    The name of the S3 bucket in which channel data is stored.

#key_prefixString

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 in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

Returns:

  • (String)

    Optional.

#role_arnString

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

Returns:

  • (String)

    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.