Package software.amazon.awscdk.services.iotanalytics

Interface CfnChannel.CustomerManagedS3Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.CustomerManagedS3Property.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.CustomerManagedS3Property
extends software.amazon.jsii.JsiiSerializable

Used to store channel data in an S3 bucket that you manage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotanalytics.*;
 CustomerManagedS3Property customerManagedS3Property = CustomerManagedS3Property.builder()
         .bucket("bucket")
         .roleArn("roleArn")
         // the properties below are optional
         .keyPrefix("keyPrefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannel.CustomerManagedS3Property.Builder	A builder for CfnChannel.CustomerManagedS3Property
static final class	CfnChannel.CustomerManagedS3Property.Jsii$Proxy	An implementation for CfnChannel.CustomerManagedS3Property

Method Summary

Modifier and Type	Method	Description
static CfnChannel.CustomerManagedS3Property.Builder	builder()
String	getBucket()	The name of the S3 bucket in which channel data is stored.
default String	getKeyPrefix()	(Optional) The prefix used to create the keys of the channel data objects.
String	getRoleArn()	The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-bucket

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-rolearn

getKeyPrefix

@Stability(Stable)
@Nullable
default String getKeyPrefix()

(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 (/).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-keyprefix

builder

@Stability(Stable)
static CfnChannel.CustomerManagedS3Property.Builder builder()

Returns:

a CfnChannel.CustomerManagedS3Property.Builder of CfnChannel.CustomerManagedS3Property