Package software.amazon.awscdk.services.kinesisfirehose

Interface IDeliveryStream.Jsii$Default

All Superinterfaces:
IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDeliveryStream, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.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.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default 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 IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default 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 IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(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(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(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(Stable) @NotNull default String getDeliveryStreamArn()
      The ARN of the delivery stream.
      Specified by:
      getDeliveryStreamArn in interface IDeliveryStream

    • getDeliveryStreamName

      @Stability(Stable) @NotNull default String getDeliveryStreamName()
      The name of the delivery stream.
      Specified by:
      getDeliveryStreamName in interface IDeliveryStream

    • applyRemovalPolicy

      @Stability(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(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      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(Stable) @NotNull default 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
      Parameters:
      grantee - This parameter is required.

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this delivery stream.

      Specified by:
      metric in interface IDeliveryStream
      Parameters:
      metricName - This parameter is required.
      props -

    • metricBackupToS3Bytes

      @Stability(Stable) @NotNull default 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
      Parameters:
      props -

    • metricBackupToS3DataFreshness

      @Stability(Stable) @NotNull default 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
      Parameters:
      props -

    • metricBackupToS3Records

      @Stability(Stable) @NotNull default 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
      Parameters:
      props -

    • metricIncomingBytes

      @Stability(Stable) @NotNull default 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
      Parameters:
      props -

    • metricIncomingRecords

      @Stability(Stable) @NotNull default 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
      Parameters:
      props -