Package 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:

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

Enclosing interface:

IDeliveryStream

@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy

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

IDeliveryStreamRef.Jsii$Default, IDeliveryStreamRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IDeliveryStream

Specified by:

getNode in interface IDeliveryStream.Jsii$Default

Specified by:

getNode in interface IDeliveryStreamRef.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IDeliveryStream

Specified by:

getEnv in interface IDeliveryStream.Jsii$Default

Specified by:

getEnv in interface IDeliveryStreamRef.Jsii$Default

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IDeliveryStream.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(Stable)
@NotNull
public final IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IDeliveryStream.Jsii$Default

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
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

getDeliveryStreamRef

@Stability(Experimental)
@NotNull
public final DeliveryStreamReference getDeliveryStreamRef()

(experimental) A reference to a DeliveryStream resource.

Specified by:

getDeliveryStreamRef in interface IDeliveryStream.Jsii$Default

Specified by:

getDeliveryStreamRef in interface IDeliveryStreamRef

Specified by:

getDeliveryStreamRef in interface IDeliveryStreamRef.Jsii$Default

getDeliveryStreamArn

@Stability(Stable)
@NotNull
public final String getDeliveryStreamArn()

The ARN of the delivery stream.

Specified by:

getDeliveryStreamArn in interface IDeliveryStream

Specified by:

getDeliveryStreamArn in interface IDeliveryStream.Jsii$Default

getDeliveryStreamName

@Stability(Stable)
@NotNull
public final String getDeliveryStreamName()

The name of the delivery stream.

Specified by:

getDeliveryStreamName in interface IDeliveryStream

Specified by:

getDeliveryStreamName in interface IDeliveryStream.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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 IDeliveryStream.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(Stable)
@NotNull
public final Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

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

@Stability(Stable)
@NotNull
public final Grant grantPutRecords(@NotNull
 IGrantable grantee)

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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

Return the given named metric for this delivery stream.

Specified by:

metric in interface IDeliveryStream

Parameters:

metricName - This parameter is required.

metricBackupToS3Bytes

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3Bytes(@Nullable
 MetricOptions props)

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

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3Bytes()

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

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3DataFreshness(@Nullable
 MetricOptions props)

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.

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream.Jsii$Default

Parameters:

props -

metricBackupToS3DataFreshness

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3DataFreshness()

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.

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream

metricBackupToS3Records

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3Records(@Nullable
 MetricOptions props)

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

@Stability(Stable)
@NotNull
public final Metric metricBackupToS3Records()

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

@Stability(Stable)
@NotNull
public final Metric metricIncomingBytes(@Nullable
 MetricOptions props)

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

@Stability(Stable)
@NotNull
public final Metric metricIncomingBytes()

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

@Stability(Stable)
@NotNull
public final Metric metricIncomingRecords(@Nullable
 MetricOptions props)

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

@Stability(Stable)
@NotNull
public final Metric metricIncomingRecords()

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