aws-cdk-lib.aws_logs_destinations.KinesisDestination

class KinesisDestination

LanguageType name
.NETAmazon.CDK.AWS.Logs.Destinations.KinesisDestination
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslogsdestinations#KinesisDestination
Javasoftware.amazon.awscdk.services.logs.destinations.KinesisDestination
Pythonaws_cdk.aws_logs_destinations.KinesisDestination
TypeScript (source)aws-cdk-lib » aws_logs_destinations » KinesisDestination

Implements ILogSubscriptionDestination

Use a Kinesis stream as the destination for a log subscription.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
import { aws_logs_destinations as logs_destinations } from 'aws-cdk-lib';

declare const role: iam.Role;
declare const stream: kinesis.Stream;
const kinesisDestination = new logs_destinations.KinesisDestination(stream, /* all optional props */ {
  role: role,
});

Initializer

new KinesisDestination(stream: IStream, props?: KinesisDestinationProps)

Parameters

  • stream IStream — The Kinesis stream to use as destination.
  • props KinesisDestinationProps — The Kinesis Destination properties.

Methods

NameDescription
bind(scope, _sourceLogGroup)Return the properties required to send subscription events to this destination.

bind(scope, _sourceLogGroup)

public bind(scope: Construct, _sourceLogGroup: ILogGroup): LogSubscriptionDestinationConfig

Parameters

  • scope Construct
  • _sourceLogGroup ILogGroup

Returns

  • LogSubscriptionDestinationConfig

Return the properties required to send subscription events to this destination.

If necessary, the destination can use the properties of the SubscriptionFilter object itself to configure its permissions to allow the subscription to write to it.

The destination may reconfigure its own permissions in response to this function call.