Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.MSKSourceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.MSKSourceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.MSKSourceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

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.kinesisfirehose.*;
 MSKSourceConfigurationProperty mSKSourceConfigurationProperty = MSKSourceConfigurationProperty.builder()
         .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                 .connectivity("connectivity")
                 .roleArn("roleArn")
                 .build())
         .mskClusterArn("mskClusterArn")
         .topicName("topicName")
         // the properties below are optional
         .readFromTimestamp("readFromTimestamp")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.MSKSourceConfigurationProperty.Builder	builder()
Object	getAuthenticationConfiguration()	The authentication configuration of the Amazon MSK cluster.
String	getMskClusterArn()	The ARN of the Amazon MSK cluster.
default String	getReadFromTimestamp()	The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
String	getTopicName()	The topic name within the Amazon MSK cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationConfiguration

@Stability(Stable)
@NotNull
Object getAuthenticationConfiguration()

The authentication configuration of the Amazon MSK cluster.

Returns union: either IResolvable or CfnDeliveryStream.AuthenticationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-authenticationconfiguration

getMskClusterArn

@Stability(Stable)
@NotNull
String getMskClusterArn()

The ARN of the Amazon MSK cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-mskclusterarn

getTopicName

@Stability(Stable)
@NotNull
String getTopicName()

The topic name within the Amazon MSK cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-topicname

getReadFromTimestamp

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

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.

By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-readfromtimestamp

builder

@Stability(Stable)
static CfnDeliveryStream.MSKSourceConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.MSKSourceConfigurationProperty.Builder of CfnDeliveryStream.MSKSourceConfigurationProperty