software.amazon.awscdk.services.kinesisfirehose

Interface IDeliveryStream.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDeliveryStream, IDependable, IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDeliveryStream.Jsii$Proxy

Enclosing interface:

IDeliveryStream

@Internal
public static interface IDeliveryStream.Jsii$Default
extends IDeliveryStream, IResource.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default

Internal default implementation for IDeliveryStream.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream

IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default Connections	getConnections() The network connections associated with this resource.
default String	getDeliveryStreamArn() (experimental) The ARN of the delivery stream.
default String	getDeliveryStreamName() (experimental) The name of the delivery stream.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default IPrincipal	getGrantPrincipal() The principal to grant permissions to.
default ConstructNode	getNode() The construct tree node for this construct.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the `grantee` identity permissions to perform `actions`.
default Grant	grantPutRecords(IGrantable grantee) (experimental) Grant the `grantee` identity permissions to perform `firehose:PutRecord` and `firehose:PutRecordBatch` actions on this delivery stream.
default Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this delivery stream.
default Metric	metricBackupToS3Bytes(MetricOptions props) (experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
default Metric	metricBackupToS3DataFreshness(MetricOptions props) (experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
default Metric	metricBackupToS3Records(MetricOptions props) (experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
default Metric	metricIncomingBytes(MetricOptions props) (experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
default Metric	metricIncomingRecords(MetricOptions props) (experimental) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

Methods inherited from interface software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream

metric, metricBackupToS3Bytes, metricBackupToS3DataFreshness, metricBackupToS3Records, metricIncomingBytes, metricIncomingRecords

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
default IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getConnections

@Stability(value=Stable)
 @NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getDeliveryStreamArn

@Stability(value=Experimental)
 @NotNull
default String getDeliveryStreamArn()

(experimental) The ARN of the delivery stream.

Specified by:

getDeliveryStreamArn in interface IDeliveryStream

getDeliveryStreamName

@Stability(value=Experimental)
 @NotNull
default String getDeliveryStreamName()

(experimental) The name of the delivery stream.

Specified by:

getDeliveryStreamName in interface IDeliveryStream

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

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

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(value=Experimental)
 @NotNull
default Grant grant(@NotNull
                                                             IGrantable grantee,
                                                             @NotNull
                                                             String... actions)

(experimental) Grant the `grantee` identity permissions to perform `actions`.

Specified by:

grant in interface IDeliveryStream

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPutRecords

@Stability(value=Experimental)
 @NotNull
default Grant grantPutRecords(@NotNull
                                                                       IGrantable grantee)

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

Specified by:

grantPutRecords in interface IDeliveryStream

Parameters:

grantee - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
default Metric metric(@NotNull
                                                               String metricName,
                                                               @Nullable
                                                               MetricOptions props)

(experimental) Return the given named metric for this delivery stream.

Specified by:

metric in interface IDeliveryStream

Parameters:

metricName - This parameter is required.

props -

metricBackupToS3Bytes

@Stability(value=Experimental)
 @NotNull
default Metric metricBackupToS3Bytes(@Nullable
                                                                              MetricOptions props)

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

Specified by:

metricBackupToS3Bytes in interface IDeliveryStream

Parameters:

props -

metricBackupToS3DataFreshness

@Stability(value=Experimental)
 @NotNull
default Metric metricBackupToS3DataFreshness(@Nullable
                                                                                      MetricOptions props)

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

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream

Parameters:

props -

metricBackupToS3Records

@Stability(value=Experimental)
 @NotNull
default Metric metricBackupToS3Records(@Nullable
                                                                                MetricOptions props)

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

Specified by:

metricBackupToS3Records in interface IDeliveryStream

Parameters:

props -

metricIncomingBytes

@Stability(value=Experimental)
 @NotNull
default Metric metricIncomingBytes(@Nullable
                                                                            MetricOptions props)

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

Specified by:

metricIncomingBytes in interface IDeliveryStream

Parameters:

props -

metricIncomingRecords

@Stability(value=Experimental)
 @NotNull
default Metric metricIncomingRecords(@Nullable
                                                                              MetricOptions props)

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

Specified by:

metricIncomingRecords in interface IDeliveryStream

Parameters:

props -