Class: AWSCDK::Kinesis::StreamConsumer

Inherits:
Resource
  • Object
show all
Includes:
IStreamConsumer
Defined in:
kinesis/stream_consumer.rb

Overview

A Kinesis Stream Consumer.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ StreamConsumer

Returns a new instance of StreamConsumer.

Parameters:



12
13
14
15
16
17
18
 
# File 'kinesis/stream_consumer.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Kinesis::StreamConsumerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpcy5TdHJlYW1Db25zdW1lclByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_stream_consumer_arn(scope, id, stream_consumer_arn) ⇒ AWSCDK::Kinesis::IStreamConsumer

Imports an existing Kinesis Stream Consumer by its arn.

Parameters:

  • scope (Constructs::Construct) —

    the Construct scope.

  • id (String) —

    the ID of the construct.

  • stream_consumer_arn (String) —

    the arn of the existing stream consumer.

Returns:



50
51
52
53
54
55
 
# File 'kinesis/stream_consumer.rb', line 50

def self.from_stream_consumer_arn(scope, id, stream_consumer_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(stream_consumer_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamConsumerArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesis.StreamConsumer", "fromStreamConsumerArn", [scope, id, stream_consumer_arn])
end

.from_stream_consumer_attributes(scope, id, attrs) ⇒ AWSCDK::Kinesis::IStreamConsumer

Imports an existing Kinesis Stream Consumer by its attributes.

Parameters:

Returns:



63
64
65
66
67
68
69
 
# File 'kinesis/stream_consumer.rb', line 63

def self.from_stream_consumer_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::Kinesis::StreamConsumerAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpcy5TdHJlYW1Db25zdW1lckF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesis.StreamConsumer", "fromStreamConsumerAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'kinesis/stream_consumer.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :auto_create_policy => { kind: :property, name: "autoCreatePolicy", is_optional: false },
    :stream => { kind: :property, name: "stream", is_optional: false },
    :stream_consumer_arn => { kind: :property, name: "streamConsumerArn", is_optional: false },
    :stream_consumer_name => { kind: :property, name: "streamConsumerName", is_optional: false },
    :stream_consumer_ref => { kind: :property, name: "streamConsumerRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


117
118
119
 
# File 'kinesis/stream_consumer.rb', line 117

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_kinesis.StreamConsumer", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_to_resource_policy(statement) ⇒ AWSCDK::IAM::AddToResourcePolicyResult

Adds a statement to the IAM resource policy associated with this stream consumer.

If this stream consumer was created in this stack (new StreamConsumer), a resource policy will be automatically created upon the first call to add_to_resource_policy. If the stream is imported (StreamConsumer.from), then this is a no-op.

Parameters:

Returns:



256
257
258
259
 
# File 'kinesis/stream_consumer.rb', line 256

def add_to_resource_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToResourcePolicy", [statement])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



191
192
193
194
 
# File 'kinesis/stream_consumer.rb', line 191

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

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



208
209
210
211
 
# File 'kinesis/stream_consumer.rb', line 208

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

#auto_create_policy ⇒ Boolean

Indicates if a resource policy should automatically be created upon the first call to addToResourcePolicy.

Set by subclasses.

Returns:

  • (Boolean) 


126
127
128
 
# File 'kinesis/stream_consumer.rb', line 126

def auto_create_policy()
  jsii_get_property("autoCreatePolicy")
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:



89
90
91
 
# File 'kinesis/stream_consumer.rb', line 89

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


214
215
216
 
# File 'kinesis/stream_consumer.rb', line 214

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


228
229
230
231
232
233
 
# File 'kinesis/stream_consumer.rb', line 228

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


243
244
245
246
 
# File 'kinesis/stream_consumer.rb', line 243

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

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

Grant the indicated permissions on this stream consumer to the given IAM principal (Role/Group/User).

[disable-awslint:no-grants]

Parameters:

Returns:



268
269
270
271
272
273
274
 
# File 'kinesis/stream_consumer.rb', line 268

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_read(grantee) ⇒ AWSCDK::IAM::Grant

Grant read permissions for this stream consumer and its associated stream to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

Parameters:

Returns:



282
283
284
285
 
# File 'kinesis/stream_consumer.rb', line 282

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


74
75
76
 
# File 'kinesis/stream_consumer.rb', line 74

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


103
104
105
 
# File 'kinesis/stream_consumer.rb', line 103

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



110
111
112
 
# File 'kinesis/stream_consumer.rb', line 110

def stack()
  jsii_get_property("stack")
end

#stream ⇒ AWSCDK::Kinesis::IStream

The Kinesis data stream this consumer is associated with.

Returns:



133
134
135
 
# File 'kinesis/stream_consumer.rb', line 133

def stream()
  jsii_get_property("stream")
end

#stream_consumer_arn ⇒ String

The Amazon Resource Name (ARN) of the stream consumer.

Returns:

  • (String) 


140
141
142
 
# File 'kinesis/stream_consumer.rb', line 140

def stream_consumer_arn()
  jsii_get_property("streamConsumerArn")
end

#stream_consumer_name ⇒ String

The name of the stream consumer.

Returns:

  • (String) 


147
148
149
 
# File 'kinesis/stream_consumer.rb', line 147

def stream_consumer_name()
  jsii_get_property("streamConsumerName")
end

#stream_consumer_ref ⇒ AWSCDK::Interfaces::AWSKinesis::StreamConsumerReference

A reference to this stream consumer.

Returns:



154
155
156
 
# File 'kinesis/stream_consumer.rb', line 154

def stream_consumer_ref()
  jsii_get_property("streamConsumerRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


161
162
163
 
# File 'kinesis/stream_consumer.rb', line 161

def to_string()
  jsii_call_method("toString", [])
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


174
175
176
177
178
179
 
# File 'kinesis/stream_consumer.rb', line 174

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