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. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)

    The name of the Amazon 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 Amazon 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 \'/\'.

Returns:

  • (String)

    [Optional] The prefix used to create the keys of the channel data objects.

#role_arnString

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

Returns:

  • (String)

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