Module: AWSCDK::KinesisFirehose::IDeliveryStream

Includes:
EC2::IConnectable, IAM::IGrantable, IResource, Interfaces::AWSKinesisfirehose::IDeliveryStreamRef
Included in:
DeliveryStream
Defined in:
kinesis_firehose/i_delivery_stream.rb

Overview

Represents an Amazon Data Firehose delivery stream.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 202

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :delivery_stream_ref => { kind: :property, name: "deliveryStreamRef", is_optional: false },
    :delivery_stream_arn => { kind: :property, name: "deliveryStreamArn", is_optional: false },
    :delivery_stream_name => { kind: :property, name: "deliveryStreamName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_put_records => { kind: :method, name: "grantPutRecords", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_backup_to_s3_bytes => { kind: :method, name: "metricBackupToS3Bytes", is_optional: false },
    :metric_backup_to_s3_data_freshness => { kind: :method, name: "metricBackupToS3DataFreshness", is_optional: false },
    :metric_backup_to_s3_records => { kind: :method, name: "metricBackupToS3Records", is_optional: false },
    :metric_incoming_bytes => { kind: :method, name: "metricIncomingBytes", is_optional: false },
    :metric_incoming_records => { kind: :method, name: "metricIncomingRecords", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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

Parameters:



101
102
103
104
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 101

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



50
51
52
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 50

def connections()
  jsii_get_property("connections")
end

#delivery_stream_arn ⇒ String

The ARN of the delivery stream.

Returns:

  • (String) 


64
65
66
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 64

def delivery_stream_arn()
  jsii_get_property("deliveryStreamArn")
end

#delivery_stream_name ⇒ String

The name of the delivery stream.

Returns:

  • (String) 


71
72
73
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 71

def delivery_stream_name()
  jsii_get_property("deliveryStreamName")
end

#delivery_stream_ref ⇒ AWSCDK::Interfaces::AWSKinesisfirehose::DeliveryStreamReference

A reference to a DeliveryStream resource.

Returns:



57
58
59
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 57

def delivery_stream_ref()
  jsii_get_property("deliveryStreamRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

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.

Returns:



29
30
31
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 29

def env()
  jsii_get_property("env")
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grant the grantee identity permissions to perform actions.

Parameters:

Returns:



111
112
113
114
115
116
117
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 111

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



43
44
45
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 43

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#grant_put_records(grantee) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



123
124
125
126
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 123

def grant_put_records(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPutRecords", [grantee])
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this delivery stream.

Parameters:

Returns:



133
134
135
136
137
138
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 133

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_backup_to_s3_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



146
147
148
149
150
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 146

def metric_backup_to_s3_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricBackupToS3Bytes", [props])
end

#metric_backup_to_s3_data_freshness(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



160
161
162
163
164
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 160

def metric_backup_to_s3_data_freshness(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricBackupToS3DataFreshness", [props])
end

#metric_backup_to_s3_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



172
173
174
175
176
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 172

def metric_backup_to_s3_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricBackupToS3Records", [props])
end

#metric_incoming_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



184
185
186
187
188
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 184

def metric_incoming_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIncomingBytes", [props])
end

#metric_incoming_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



196
197
198
199
200
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 196

def metric_incoming_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIncomingRecords", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


14
15
16
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 14

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



36
37
38
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 36

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



82
83
84
85
86
87
 
# File 'kinesis_firehose/i_delivery_stream.rb', line 82

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end