1.204.0

interface IDeliveryStream 🔹

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.IDeliveryStream
Javasoftware.amazon.awscdk.services.kinesisfirehose.IDeliveryStream
Pythonaws_cdk.aws_kinesisfirehose.IDeliveryStream
TypeScript (source)@aws-cdk/aws-kinesisfirehose » IDeliveryStream

Implemented by DeliveryStream

Obtainable from DeliveryStream.fromDeliveryStreamArn(), DeliveryStream.fromDeliveryStreamAttributes(), DeliveryStream.fromDeliveryStreamName()

Represents a Kinesis Data Firehose delivery stream.

Properties

NameTypeDescription
connections🔹ConnectionsThe network connections associated with this resource.
deliveryStreamArn🔹stringThe ARN of the delivery stream.
deliveryStreamName🔹stringThe name of the delivery stream.
env🔹ResourceEnvironmentThe environment this resource belongs to.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
node🔹ConstructNodeThe construct tree node for this construct.
stack🔹StackThe stack in which this resource is defined.

connections🔹

Type: Connections

The network connections associated with this resource.

deliveryStreamArn🔹

Type: string

The ARN of the delivery stream.

deliveryStreamName🔹

Type: string

The name of the delivery stream.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

node🔹

Type: ConstructNode

The construct tree node for this construct.

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹Grant the grantee identity permissions to perform actions.
grantPutRecords(grantee)🔹Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.
metric(metricName, props?)🔹Return the given named metric for this delivery stream.
metricBackupToS3Bytes(props?)🔹Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
metricBackupToS3DataFreshness(props?)🔹Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
metricBackupToS3Records(props?)🔹Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
metricIncomingBytes(props?)🔹Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
metricIncomingRecords(props?)🔹Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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).

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

Returns

Grant the grantee identity permissions to perform actions.

grantPutRecords(grantee)🔹

public grantPutRecords(grantee: IGrantable): Grant

Parameters

Returns

Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

Returns

Return the given named metric for this delivery stream.

metricBackupToS3Bytes(props?)🔹

public metricBackupToS3Bytes(props?: MetricOptions): Metric

Parameters

Returns

Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.

By default, this metric will be calculated as an average over a period of 5 minutes.

metricBackupToS3DataFreshness(props?)🔹

public metricBackupToS3DataFreshness(props?: MetricOptions): Metric

Parameters

Returns

Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.

Any record older than this age has been delivered to the Amazon S3 bucket for backup.

By default, this metric will be calculated as an average over a period of 5 minutes.

metricBackupToS3Records(props?)🔹

public metricBackupToS3Records(props?: MetricOptions): Metric

Parameters

Returns

Metric for the number of records delivered to Amazon S3 for backup over the specified time period.

By default, this metric will be calculated as an average over a period of 5 minutes.

metricIncomingBytes(props?)🔹

public metricIncomingBytes(props?: MetricOptions): Metric

Parameters

Returns

Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.

By default, this metric will be calculated as an average over a period of 5 minutes.

metricIncomingRecords(props?)🔹

public metricIncomingRecords(props?: MetricOptions): Metric

Parameters

Returns

Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

By default, this metric will be calculated as an average over a period of 5 minutes.

← PreviousNext →