Class GuKinesisStream

Construct which creates a Kinesis stream.

This resource is stateful.

See

https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

Hierarchy

  • Stream
    • GuKinesisStream

Constructors

constructor

Properties

encryptionKey? env node physicalName stack streamArn streamName

Methods

_enableCrossEnvironment applyRemovalPolicy generatePhysicalName getResourceArnAttribute getResourceNameAttribute grant grantRead grantReadWrite grantWrite metric metricGetRecords metricGetRecordsBytes metricGetRecordsIteratorAgeMilliseconds metricGetRecordsLatency metricGetRecordsSuccess metricIncomingBytes metricIncomingRecords metricPutRecordBytes metricPutRecordLatency metricPutRecordSuccess metricPutRecordsBytes metricPutRecordsFailedRecords metricPutRecordsLatency metricPutRecordsSuccess metricPutRecordsSuccessfulRecords metricPutRecordsThrottledRecords metricPutRecordsTotalRecords metricReadProvisionedThroughputExceeded metricWriteProvisionedThroughputExceeded toString fromStreamArn fromStreamAttributes isConstruct isOwnedResource isResource

Constructors

constructor

Properties

Optional Readonly encryptionKey

encryptionKey?: IKey

Readonly env

env: ResourceEnvironment

Readonly node

node: Node

The tree node.

Protected Readonly physicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Readonly stack

stack: Stack

Readonly streamArn

streamArn: string

Readonly streamName

streamName: string

Methods

_enableCrossEnvironment

  • _enableCrossEnvironment(): void
  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

applyRemovalPolicy

  • applyRemovalPolicy(policy): void

  • Apply the given removal policy to this resource

    The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

    The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

    Parameters

    • policy: RemovalPolicy

    Returns void

Protected generatePhysicalName

  • generatePhysicalName(): string

  • Returns string

Protected getResourceArnAttribute

  • getResourceArnAttribute(arnAttr, arnComponents): string

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

Protected getResourceNameAttribute

  • getResourceNameAttribute(nameAttr): string

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

grant

  • grant(grantee, ...actions): Grant

  • Grant the indicated permissions on this stream to the given IAM principal (Role/Group/User).

    Parameters

    • grantee: IGrantable
    • Rest ...actions: string[]

    Returns Grant

grantRead

  • grantRead(grantee): Grant

  • Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).

    If an encryption key is used, permission to ues the key to decrypt the contents of the stream will also be granted.

    Parameters

    • grantee: IGrantable

    Returns Grant

grantReadWrite

  • grantReadWrite(grantee): Grant

  • Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).

    If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.

    Parameters

    • grantee: IGrantable

    Returns Grant

grantWrite

  • grantWrite(grantee): Grant

  • Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).

    If an encryption key is used, permission to ues the key to encrypt the contents of the stream will also be granted.

    Parameters

    • grantee: IGrantable

    Returns Grant

metric

  • metric(metricName, props?): Metric

  • Return stream metric based from its metric name

    Parameters

    • metricName: string

      name of the stream metric

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricGetRecords

  • metricGetRecords(props?): Metric

  • The number of records retrieved from the shard, measured over the specified time period. Minimum, Maximum, and Average statistics represent the records in a single GetRecords operation for the stream in the specified time period.

    average The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricGetRecordsBytes

  • metricGetRecordsBytes(props?): Metric

  • The number of bytes retrieved from the Kinesis stream, measured over the specified time period. Minimum, Maximum, and Average statistics represent the bytes in a single GetRecords operation for the stream in the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricGetRecordsIteratorAgeMilliseconds

  • metricGetRecordsIteratorAgeMilliseconds(props?): Metric

  • The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period. Age is the difference between the current time and when the last record of the GetRecords call was written to the stream. The Minimum and Maximum statistics can be used to track the progress of Kinesis consumer applications. A value of zero indicates that the records being read are completely caught up with the stream.

    The metric defaults to maximum over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricGetRecordsLatency

  • metricGetRecordsLatency(props?): Metric

  • The number of successful GetRecords operations per stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricGetRecordsSuccess

  • metricGetRecordsSuccess(props?): Metric

  • The number of successful GetRecords operations per stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricIncomingBytes

  • metricIncomingBytes(props?): Metric

  • The number of bytes successfully put to the Kinesis stream over the specified time period. This metric includes bytes from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the bytes in a single put operation for the stream in the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricIncomingRecords

  • metricIncomingRecords(props?): Metric

  • The number of records successfully put to the Kinesis stream over the specified time period. This metric includes record counts from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the records in a single put operation for the stream in the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordBytes

  • metricPutRecordBytes(props?): Metric

  • The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordLatency

  • metricPutRecordLatency(props?): Metric

  • The time taken per PutRecord operation, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordSuccess

  • metricPutRecordSuccess(props?): Metric

  • The number of successful PutRecord operations per Kinesis stream, measured over the specified time period. Average reflects the percentage of successful writes to a stream.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsBytes

  • metricPutRecordsBytes(props?): Metric

  • The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsFailedRecords

  • metricPutRecordsFailedRecords(props?): Metric

  • The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period. Occasional internal failures are to be expected and should be retried.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsLatency

  • metricPutRecordsLatency(props?): Metric

  • The time taken per PutRecords operation, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsSuccess

  • metricPutRecordsSuccess(props?): Metric

  • The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsSuccessfulRecords

  • metricPutRecordsSuccessfulRecords(props?): Metric

  • The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsThrottledRecords

  • metricPutRecordsThrottledRecords(props?): Metric

  • The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricPutRecordsTotalRecords

  • metricPutRecordsTotalRecords(props?): Metric

  • The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricReadProvisionedThroughputExceeded

  • metricReadProvisionedThroughputExceeded(props?): Metric

  • The number of GetRecords calls throttled for the stream over the specified time period. The most commonly used statistic for this metric is Average.

    When the Minimum statistic has a value of 1, all records were throttled for the stream during the specified time period.

    When the Maximum statistic has a value of 0 (zero), no records were throttled for the stream during the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

metricWriteProvisionedThroughputExceeded

  • metricWriteProvisionedThroughputExceeded(props?): Metric

  • The number of records rejected due to throttling for the stream over the specified time period. This metric includes throttling from PutRecord and PutRecords operations.

    When the Minimum statistic has a non-zero value, records were being throttled for the stream during the specified time period.

    When the Maximum statistic has a value of 0 (zero), no records were being throttled for the stream during the specified time period.

    The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

    Parameters

    • Optional props: MetricOptions

      properties of the metric

    Returns Metric

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

Static fromStreamArn

  • fromStreamArn(scope, id, streamArn): IStream

  • Import an existing Kinesis Stream provided an ARN

    Parameters

    • scope: Construct

      The parent creating construct (usually this).

    • id: string

      The construct's name

    • streamArn: string

      Stream ARN (i.e. arn:aws:kinesis:::stream/Foo)

    Returns IStream

Static fromStreamAttributes

  • fromStreamAttributes(scope, id, attrs): IStream

  • Creates a Stream construct that represents an external stream.

    Parameters

    • scope: Construct

      The parent creating construct (usually this).

    • id: string

      The construct's name.

    • attrs: StreamAttributes

      Stream import properties

    Returns IStream

Static isConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Static isOwnedResource

  • isOwnedResource(construct): boolean

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

Static isResource

  • isResource(construct): construct is Resource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

Theme

On This Page

constructorencryptionKeyenvnodephysicalNamestackstreamArnstreamName_enableCrossEnvironmentapplyRemovalPolicygeneratePhysicalNamegetResourceArnAttributegetResourceNameAttributegrantgrantReadgrantReadWritegrantWritemetricmetricGetRecordsmetricGetRecordsBytesmetricGetRecordsIteratorAgeMillisecondsmetricGetRecordsLatencymetricGetRecordsSuccessmetricIncomingBytesmetricIncomingRecordsmetricPutRecordBytesmetricPutRecordLatencymetricPutRecordSuccessmetricPutRecordsBytesmetricPutRecordsFailedRecordsmetricPutRecordsLatencymetricPutRecordsSuccessmetricPutRecordsSuccessfulRecordsmetricPutRecordsThrottledRecordsmetricPutRecordsTotalRecordsmetricReadProvisionedThroughputExceededmetricWriteProvisionedThroughputExceededtoStringfromStreamArnfromStreamAttributesisConstructisOwnedResourceisResource