Module: AWSCDK::Events::IEventBus

Includes:
IResource, Interfaces::AWSEvents::IEventBusRef
Included in:
EventBus
Defined in:
events/i_event_bus.rb

Overview

Interface which all EventBus based classes MUST implement.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'events/i_event_bus.rb', line 130

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 },
    :event_bus_ref => { kind: :property, name: "eventBusRef", is_optional: false },
    :event_bus_arn => { kind: :property, name: "eventBusArn", is_optional: false },
    :event_bus_name => { kind: :property, name: "eventBusName", is_optional: false },
    :event_bus_policy => { kind: :property, name: "eventBusPolicy", is_optional: false },
    :event_source_name => { kind: :property, name: "eventSourceName", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :archive => { kind: :method, name: "archive", is_optional: false },
    :grant_put_events_to => { kind: :method, name: "grantPutEventsTo", 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:



99
100
101
102
 
# File 'events/i_event_bus.rb', line 99

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

#archive(id, props) ⇒ AWSCDK::Events::Archive

Create an EventBridge archive to send events to.

When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect.

Parameters:

Returns:



112
113
114
115
116
117
 
# File 'events/i_event_bus.rb', line 112

def archive(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::Events::BaseArchiveProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLkJhc2VBcmNoaXZlUHJvcHMifQ==")), "props")
  jsii_call_method("archive", [id, props])
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 'events/i_event_bus.rb', line 27

def env()
  jsii_get_property("env")
end

#event_bus_arn ⇒ String

The ARN of this event bus resource.

Returns:

  • (String) 


48
49
50
 
# File 'events/i_event_bus.rb', line 48

def event_bus_arn()
  jsii_get_property("eventBusArn")
end

#event_bus_name ⇒ String

The physical ID of this event bus resource.

Returns:

  • (String) 


55
56
57
 
# File 'events/i_event_bus.rb', line 55

def event_bus_name()
  jsii_get_property("eventBusName")
end

#event_bus_policy ⇒ String

The JSON policy of this event bus resource.

Returns:

  • (String) 


62
63
64
 
# File 'events/i_event_bus.rb', line 62

def event_bus_policy()
  jsii_get_property("eventBusPolicy")
end

#event_bus_ref ⇒ AWSCDK::Interfaces::AWSEvents::EventBusReference

A reference to a EventBus resource.

Returns:



41
42
43
 
# File 'events/i_event_bus.rb', line 41

def event_bus_ref()
  jsii_get_property("eventBusRef")
end

#event_source_name ⇒ String?

The partner event source to associate with this event bus resource.

Returns:

  • (String, nil) 


69
70
71
 
# File 'events/i_event_bus.rb', line 69

def event_source_name()
  jsii_get_property("eventSourceName")
end

#grant_put_events_to(grantee, sid = nil) ⇒ AWSCDK::IAM::Grant

Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal (no-op if undefined).

  • sid (String, nil) (defaults to: nil) —

    The Statement ID used if we need to add a trust policy on the event bus.

Returns:



124
125
126
127
128
 
# File 'events/i_event_bus.rb', line 124

def grant_put_events_to(grantee, sid = nil)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  Jsii::Type.check_type(sid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sid") unless sid.nil?
  jsii_call_method("grantPutEventsTo", [grantee, sid])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'events/i_event_bus.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 'events/i_event_bus.rb', line 34

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



80
81
82
83
84
85
 
# File 'events/i_event_bus.rb', line 80

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