Class CfnStreamConsumer
Use the AWS CloudFormation AWS::Kinesis::StreamConsumer
resource to register a consumer with a Kinesis data stream.
Implements
Inherited Members
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 five 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 .
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStreamConsumer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStreamConsumer(Construct, String, ICfnStreamConsumerProps) |
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 |
AttrId | |
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 | |
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>) |
Constructors
CfnStreamConsumer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStreamConsumer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStreamConsumer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStreamConsumer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStreamConsumer(Construct, String, ICfnStreamConsumerProps)
public CfnStreamConsumer(Construct scope, string id, ICfnStreamConsumerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStreamConsumerProps
Resource properties.
Properties
AttrConsumerArn
When you register a consumer, Kinesis Data Streams generates an ARN for it.
public virtual string AttrConsumerArn { get; }
Property Value
System.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
System.String
Remarks
CloudformationAttribute: ConsumerCreationTimestamp
AttrConsumerName
The name you gave the consumer when you registered it.
public virtual string AttrConsumerName { get; }
Property Value
System.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
System.String
Remarks
CloudformationAttribute: ConsumerStatus
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrStreamArn
The ARN of the data stream with which the consumer is registered.
public virtual string AttrStreamArn { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConsumerName
The name of the consumer is something you choose when you register the consumer.
public virtual string ConsumerName { get; set; }
Property Value
System.String
StreamArn
The ARN of the stream with which you registered the consumer.
public virtual string StreamArn { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>