Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.S3StorageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.S3StorageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

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

S3 storage configuration that describes the destination bucket and how delivered objects are stored.

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.kinesis.*;
 S3StorageConfigurationProperty s3StorageConfigurationProperty = S3StorageConfigurationProperty.builder()
         .bucketArn("bucketArn")
         .compressionType("compressionType")
         .expectedBucketOwner("expectedBucketOwner")
         // the properties below are optional
         .outputKeyTemplate("outputKeyTemplate")
         .storageClass("storageClass")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.S3StorageConfigurationProperty.Builder	builder()
String	getBucketArn()	The ARN of the S3 bucket for record delivery.
String	getCompressionType()	The compression algorithm applied to delivered objects.
String	getExpectedBucketOwner()	The AWS account ID of the expected owner of the destination S3 bucket.
default String	getOutputKeyTemplate()	Optional template for the S3 object key path.
default String	getStorageClass()	The S3 storage class for delivered objects.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketArn

@Stability(Stable)
@NotNull
String getBucketArn()

The ARN of the S3 bucket for record delivery.

Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-bucketarn

getCompressionType

@Stability(Stable)
@NotNull
String getCompressionType()

The compression algorithm applied to delivered objects.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-compressiontype

getExpectedBucketOwner

@Stability(Stable)
@NotNull
String getExpectedBucketOwner()

The AWS account ID of the expected owner of the destination S3 bucket.

Used to verify bucket ownership before delivery.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-expectedbucketowner

getOutputKeyTemplate

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

Optional template for the S3 object key path.

Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-outputkeytemplate

getStorageClass

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

The S3 storage class for delivered objects.

Default: - "STANDARD"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-storageclass

builder

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

Returns:

a CfnChannel.S3StorageConfigurationProperty.Builder of CfnChannel.S3StorageConfigurationProperty