Class CfnStreamConsumer

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnStreamConsumer

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Kinesis

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStreamConsumer : CfnResource, IInspectable

Syntax (vb)

Public Class CfnStreamConsumer Inherits CfnResource Implements IInspectable

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

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.Kinesis;

             var cfnStreamConsumer = new CfnStreamConsumer(this, "MyCfnStreamConsumer", new CfnStreamConsumerProps {
                 ConsumerName = "consumerName",
                 StreamArn = "streamArn"
             });

Synopsis

Constructors

CfnStreamConsumer(Construct, string, ICfnStreamConsumerProps)

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

Properties

AttrConsumerArn	When you register a consumer, Kinesis Data Streams generates an ARN for it.
AttrConsumerCreationTimestamp	The time at which the consumer was created.
AttrConsumerName	The name you gave the consumer when you registered it.
AttrConsumerStatus	A consumer can't read data while in the CREATING or DELETING states.
AttrId	Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.
AttrStreamArn	The ARN of the data stream with which the consumer is registered.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.
ConsumerName	The name of the consumer is something you choose when you register the consumer.
StreamArn	The ARN of the stream with which you registered the consumer.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

Constructors

CfnStreamConsumer(Construct, string, ICfnStreamConsumerProps)

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

public CfnStreamConsumer(Construct scope, string id, ICfnStreamConsumerProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnStreamConsumerProps

Resource properties.

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

Properties

AttrConsumerArn

When you register a consumer, Kinesis Data Streams generates an ARN for it.

public virtual string AttrConsumerArn { get; }

Property Value

string

Remarks

You need this ARN to be able to call SubscribeToShard .

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

CloudformationAttribute: ConsumerARN

AttrConsumerCreationTimestamp

The time at which the consumer was created.

public virtual string AttrConsumerCreationTimestamp { get; }

Property Value

string

Remarks

CloudformationAttribute: ConsumerCreationTimestamp

AttrConsumerName

The name you gave the consumer when you registered it.

public virtual string AttrConsumerName { get; }

Property Value

string

Remarks

CloudformationAttribute: ConsumerName

AttrConsumerStatus

A consumer can't read data while in the CREATING or DELETING states.

public virtual string AttrConsumerStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: ConsumerStatus

AttrId

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrStreamArn

The ARN of the data stream with which the consumer is registered.

public virtual string AttrStreamArn { get; }

Property Value

string

Remarks

CloudformationAttribute: StreamARN

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

CfnProperties

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

ConsumerName

The name of the consumer is something you choose when you register the consumer.

public virtual string ConsumerName { get; set; }

Property Value

string

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

StreamArn

The ARN of the stream with which you registered the consumer.

public virtual string StreamArn { get; set; }

Property Value

string

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

CloudformationResource: AWS::Kinesis::StreamConsumer

ExampleMetadata: fixture=_generated

Implements

IInspectable