Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.DeadLetterQueueS3ConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.DeadLetterQueueS3ConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

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

Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.

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.*;
 DeadLetterQueueS3ConfigurationProperty deadLetterQueueS3ConfigurationProperty = DeadLetterQueueS3ConfigurationProperty.builder()
         .bucketArn("bucketArn")
         .expectedBucketOwner("expectedBucketOwner")
         // the properties below are optional
         .errorOutputPrefix("errorOutputPrefix")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.DeadLetterQueueS3ConfigurationProperty.Builder	builder()
String	getBucketArn()	The ARN of the S3 bucket for storing failed records.
default String	getErrorOutputPrefix()	Optional S3 key prefix under which error records are organized.
String	getExpectedBucketOwner()	The AWS account ID of the expected owner of the dead-letter queue S3 bucket.

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 storing failed records.

See Also:

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

getExpectedBucketOwner

@Stability(Stable)
@NotNull
String getExpectedBucketOwner()

The AWS account ID of the expected owner of the dead-letter queue S3 bucket.

Used to verify bucket ownership before delivery.

See Also:

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

getErrorOutputPrefix

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

Optional S3 key prefix under which error records are organized.

When omitted, the service uses the default 'kinesis-channel/errors///'.

See Also:

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

builder

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

Returns:

a CfnChannel.DeadLetterQueueS3ConfigurationProperty.Builder of CfnChannel.DeadLetterQueueS3ConfigurationProperty