Class KinesisDestination
Use a Kinesis stream as the destination for a log subscription.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Logs.Destinations
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KinesisDestination : DeputyBase, ILogSubscriptionDestination
Syntax (vb)
Public Class KinesisDestination
Inherits DeputyBase
Implements ILogSubscriptionDestination
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Kinesis;
using Amazon.CDK.AWS.Logs.Destinations;
Role role;
Stream stream;
var kinesisDestination = new KinesisDestination(stream, new KinesisDestinationProps {
Role = role
});
Synopsis
Constructors
KinesisDestination(IStream, IKinesisDestinationProps) | |
KinesisDestination(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
KinesisDestination(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(Construct, ILogGroup) | Return the properties required to send subscription events to this destination. |
Constructors
KinesisDestination(IStream, IKinesisDestinationProps)
public KinesisDestination(IStream stream, IKinesisDestinationProps props = null)
Parameters
- stream IStream
The Kinesis stream to use as destination.
- props IKinesisDestinationProps
The Kinesis Destination properties.
KinesisDestination(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected KinesisDestination(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
KinesisDestination(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected KinesisDestination(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Bind(Construct, ILogGroup)
Return the properties required to send subscription events to this destination.
public virtual ILogSubscriptionDestinationConfig Bind(Construct scope, ILogGroup sourceLogGroup)
Parameters
- scope Constructs.Construct
- sourceLogGroup ILogGroup
Returns
ILogSubscriptionDestinationConfig
Remarks
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.