interface IDeliveryStream
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.KinesisFirehose.IDeliveryStream |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#IDeliveryStream |
 Java | software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream |
 Python | aws_cdk.aws_kinesisfirehose.IDeliveryStream |
 TypeScript (source) | aws-cdk-lib » aws_kinesisfirehose » IDeliveryStream |
Implemented by
Delivery
Obtainable from
Delivery.fromDeliveryStreamArn(), Delivery.fromDeliveryStreamAttributes(), Delivery.fromDeliveryStreamName()
Represents an Amazon Data Firehose delivery stream.
Properties
| Name | Type | Description |
|---|---|---|
| connections | Connections | The network connections associated with this resource. |
| delivery | string | The ARN of the delivery stream. |
| delivery | string | The name of the delivery stream. |
| delivery | Delivery | A reference to a DeliveryStream resource. |
| env | Resource | The environment this resource belongs to. |
| grant | IPrincipal | The principal to grant permissions to. |
| node | Node | The tree node. |
| stack | Stack | The 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.
deliveryStreamRef
Type:
Delivery
A reference to a DeliveryStream resource.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be
different than the stack they were imported into.
grantPrincipal
Type:
IPrincipal
The principal to grant permissions to.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
| grant(grantee, ...actions) | Grant the grantee identity permissions to perform actions. |
| grant | 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. |
| metric | Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period. |
| metric | Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon Data Firehose. |
| metric | Metric for the number of records delivered to Amazon S3 for backup over the specified time period. |
| metric | Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling. |
| metric | 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
- policy
RemovalPolicy
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
- grantee
IGrantable - actions
string
Returns
Grant the grantee identity permissions to perform actions.
grantPutRecords(grantee)
public grantPutRecords(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
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
- metricName
string - props
MetricOptions
Returns
Return the given named metric for this delivery stream.
metricBackupToS3Bytes(props?)
public metricBackupToS3Bytes(props?: MetricOptions): Metric
Parameters
- props
MetricOptions
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
- props
MetricOptions
Returns
Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon 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
- props
MetricOptions
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
- props
MetricOptions
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
- props
MetricOptions
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.