Package software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose

Interface CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStreamPropsMixin

@Stability(Stable)
public static interface CfnDeliveryStreamPropsMixin.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.cfnpropertymixins.services.kinesisfirehose.*;
 MSKSourceConfigurationProperty mSKSourceConfigurationProperty = MSKSourceConfigurationProperty.builder()
         .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                 .connectivity("connectivity")
                 .roleArn("roleArn")
                 .build())
         .mskClusterArn("mskClusterArn")
         .readFromTimestamp("readFromTimestamp")
         .topicName("topicName")
         .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	CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty.Builder	A builder for CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty
static final class	CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty.Builder	builder()
default Object	getAuthenticationConfiguration()	The authentication configuration of the Amazon MSK cluster.
default 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.
default 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)
@Nullable
default Object getAuthenticationConfiguration()

The authentication configuration of the Amazon MSK cluster.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.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)
@Nullable
default 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

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

getTopicName

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty.Builder of CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty