Module: AWSCDK::Kinesis::IStreamConsumer

Includes:
IResource, Interfaces::AWSKinesis::IStreamConsumerRef
Included in:
StreamConsumer
Defined in:
kinesis/i_stream_consumer.rb

Overview

A Kinesis Stream Consumer.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'kinesis/i_stream_consumer.rb', line 132

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 },
    :stream_consumer_ref => { kind: :property, name: "streamConsumerRef", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", 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

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 consumer is imported (StreamConsumer.from), then this is a no-op.

Parameters:

Returns:



105
106
107
108
 
# File 'kinesis/i_stream_consumer.rb', line 105

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



92
93
94
95
 
# File 'kinesis/i_stream_consumer.rb', line 92

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



27
28
29
 
# File 'kinesis/i_stream_consumer.rb', line 27

def env()
  jsii_get_property("env")
end

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

Grant the indicated permissions on this stream consumer to the provided IAM principal.

Parameters:

Returns:



115
116
117
118
119
120
121
 
# File 'kinesis/i_stream_consumer.rb', line 115

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

Parameters:

Returns:



127
128
129
130
 
# File 'kinesis/i_stream_consumer.rb', line 127

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) 


12
13
14
 
# File 'kinesis/i_stream_consumer.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'kinesis/i_stream_consumer.rb', line 34

def stack()
  jsii_get_property("stack")
end

#stream ⇒ AWSCDK::Kinesis::IStream

The stream associated with this consumer.

Returns:



48
49
50
 
# File 'kinesis/i_stream_consumer.rb', line 48

def stream()
  jsii_get_property("stream")
end

#stream_consumer_arn ⇒ String

The ARN of the stream consumer.

Returns:

  • (String) 


55
56
57
 
# File 'kinesis/i_stream_consumer.rb', line 55

def stream_consumer_arn()
  jsii_get_property("streamConsumerArn")
end

#stream_consumer_name ⇒ String

The name of the stream consumer.

Returns:

  • (String) 


62
63
64
 
# File 'kinesis/i_stream_consumer.rb', line 62

def stream_consumer_name()
  jsii_get_property("streamConsumerName")
end

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

A reference to a StreamConsumer resource.

Returns:



41
42
43
 
# File 'kinesis/i_stream_consumer.rb', line 41

def stream_consumer_ref()
  jsii_get_property("streamConsumerRef")
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



73
74
75
76
77
78
 
# File 'kinesis/i_stream_consumer.rb', line 73

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