2.233.0

interface MSKSourceConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins.CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskinesisfirehose/mixins#CfnDeliveryStreamPropsMixin_MSKSourceConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_kinesisfirehose » mixins » CfnDeliveryStreamPropsMixin » MSKSourceConfigurationProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kinesisfirehose_mixins } from '@aws-cdk/mixins-preview/aws-kinesisfirehose';
const mSKSourceConfigurationProperty: kinesisfirehose_mixins.CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty = {
  authenticationConfiguration: {
    connectivity: 'connectivity',
    roleArn: 'roleArn',
  },
  mskClusterArn: 'mskClusterArn',
  readFromTimestamp: 'readFromTimestamp',
  topicName: 'topicName',
};

Properties

NameTypeDescription
authenticationConfiguration?IResolvable | AuthenticationConfigurationPropertyThe authentication configuration of the Amazon MSK cluster.
mskClusterArn?stringThe ARN of the Amazon MSK cluster.
readFromTimestamp?stringThe start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
topicName?stringThe topic name within the Amazon MSK cluster.

authenticationConfiguration?

Type: IResolvable | AuthenticationConfigurationProperty (optional)

The authentication configuration 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-authenticationconfiguration

mskClusterArn?

Type: string (optional)

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

readFromTimestamp?

Type: string (optional)

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

topicName?

Type: string (optional)

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

← PreviousNext →