software.amazon.awscdk.services.kinesisfirehose

Class IDeliveryStream.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IConnectable, IConnectable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IDeliveryStream, IDeliveryStream.Jsii$Default

Enclosing interface:

IDeliveryStream

public static final class IDeliveryStream.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IDeliveryStream.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IDeliveryStream.Jsii$Default

getEnv

public final 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

Specified by:

getEnv in interface IDeliveryStream.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IDeliveryStream.Jsii$Default

getGrantPrincipal

public final IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

Specified by:

getGrantPrincipal in interface IDeliveryStream.Jsii$Default

getConnections

public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IDeliveryStream.Jsii$Default

getDeliveryStreamArn

public final java.lang.String getDeliveryStreamArn()

(experimental) The ARN of the delivery stream.

Specified by:

getDeliveryStreamArn in interface IDeliveryStream

Specified by:

getDeliveryStreamArn in interface IDeliveryStream.Jsii$Default

getDeliveryStreamName

public final java.lang.String getDeliveryStreamName()

(experimental) The name of the delivery stream.

Specified by:

getDeliveryStreamName in interface IDeliveryStream

Specified by:

getDeliveryStreamName in interface IDeliveryStream.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(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

Specified by:

applyRemovalPolicy in interface IDeliveryStream.Jsii$Default

Parameters:

policy - This parameter is required.

grant

public final Grant grant(IGrantable grantee,
                         java.lang.String... actions)

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

Specified by:

grant in interface IDeliveryStream

Specified by:

grant in interface IDeliveryStream.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPutRecords

public final Grant grantPutRecords(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

Specified by:

grantPutRecords in interface IDeliveryStream.Jsii$Default

Parameters:

grantee - This parameter is required.

metric

public final Metric metric(java.lang.String metricName,
                           MetricOptions props)

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

Specified by:

metric in interface IDeliveryStream

Specified by:

metric in interface IDeliveryStream.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

public final Metric metric(java.lang.String metricName)

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

Specified by:

metric in interface IDeliveryStream

Parameters:

metricName - This parameter is required.

metricBackupToS3Bytes

public final Metric metricBackupToS3Bytes(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

Specified by:

metricBackupToS3Bytes in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricBackupToS3Bytes

public final Metric metricBackupToS3Bytes()

(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

metricBackupToS3DataFreshness

public final 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.

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

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricBackupToS3DataFreshness

public final Metric metricBackupToS3DataFreshness()

(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

metricBackupToS3Records

public final Metric metricBackupToS3Records(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

Specified by:

metricBackupToS3Records in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricBackupToS3Records

public final Metric metricBackupToS3Records()

(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

metricIncomingBytes

public final Metric metricIncomingBytes(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

Specified by:

metricIncomingBytes in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricIncomingBytes

public final Metric metricIncomingBytes()

(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

metricIncomingRecords

public final Metric metricIncomingRecords(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

Specified by:

metricIncomingRecords in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricIncomingRecords

public final Metric metricIncomingRecords()

(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