Class: AWSCDK::Events::EventBus

Inherits:
Resource
  • Object
show all
Includes:
IEventBus, IAM::IResourceWithPolicy
Defined in:
events/event_bus.rb

Overview

Define an EventBridge EventBus.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ EventBus

Returns a new instance of EventBus.

Parameters:



13
14
15
16
17
18
19
 
# File 'events/event_bus.rb', line 13

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Events::EventBusProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLkV2ZW50QnVzUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_event_bus_arn(scope, id, event_bus_arn) ⇒ AWSCDK::Events::IEventBus

Import an existing event bus resource.

Parameters:

  • scope (Constructs::Construct) —

    Parent construct.

  • id (String) —

    Construct ID.

  • event_bus_arn (String) —

    ARN of imported event bus.

Returns:



52
53
54
55
56
57
 
# File 'events/event_bus.rb', line 52

def self.from_event_bus_arn(scope, id, event_bus_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(event_bus_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventBusArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.EventBus", "fromEventBusArn", [scope, id, event_bus_arn])
end

.from_event_bus_attributes(scope, id, attrs) ⇒ AWSCDK::Events::IEventBus

Import an existing event bus resource.

Parameters:

Returns:



65
66
67
68
69
70
71
 
# File 'events/event_bus.rb', line 65

def self.from_event_bus_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::Events::EventBusAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLkV2ZW50QnVzQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.EventBus", "fromEventBusAttributes", [scope, id, attrs])
end

.from_event_bus_name(scope, id, event_bus_name) ⇒ AWSCDK::Events::IEventBus

Import an existing event bus resource.

Parameters:

  • scope (Constructs::Construct) —

    Parent construct.

  • id (String) —

    Construct ID.

  • event_bus_name (String) —

    Name of imported event bus.

Returns:



79
80
81
82
83
84
 
# File 'events/event_bus.rb', line 79

def self.from_event_bus_name(scope, id, event_bus_name)
  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(event_bus_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventBusName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.EventBus", "fromEventBusName", [scope, id, event_bus_name])
end

.grant_all_put_events(grantee) ⇒ AWSCDK::IAM::Grant

Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

Parameters:

Returns:



90
91
92
93
 
# File 'events/event_bus.rb', line 90

def self.grant_all_put_events(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.EventBus", "grantAllPutEvents", [grantee])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :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_bus_ref => { kind: :property, name: "eventBusRef", is_optional: false },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :event_source_name => { kind: :property, name: "eventSourceName", is_optional: true },
    :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 },
    :archive => { kind: :method, name: "archive", is_optional: false },
    :grant_put_events_to => { kind: :method, name: "grantPutEventsTo", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


141
142
143
 
# File 'events/event_bus.rb', line 141

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_events.EventBus", "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 event bus.

Parameters:

Returns:



281
282
283
284
 
# File 'events/event_bus.rb', line 281

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:



220
221
222
223
 
# File 'events/event_bus.rb', line 220

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:



237
238
239
240
 
# File 'events/event_bus.rb', line 237

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:



294
295
296
297
298
299
 
# File 'events/event_bus.rb', line 294

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:



113
114
115
 
# File 'events/event_bus.rb', line 113

def env()
  jsii_get_property("env")
end

#event_bus_arn ⇒ String

The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1.

Returns:

  • (String) 


148
149
150
 
# File 'events/event_bus.rb', line 148

def event_bus_arn()
  jsii_get_property("eventBusArn")
end

#event_bus_name ⇒ String

The physical ID of this event bus resource.

Returns:

  • (String) 


155
156
157
 
# File 'events/event_bus.rb', line 155

def event_bus_name()
  jsii_get_property("eventBusName")
end

#event_bus_policy ⇒ String

The policy for the event bus in JSON form.

Returns:

  • (String) 


162
163
164
 
# File 'events/event_bus.rb', line 162

def event_bus_policy()
  jsii_get_property("eventBusPolicy")
end

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

A reference to a EventBus resource.

Returns:



169
170
171
 
# File 'events/event_bus.rb', line 169

def event_bus_ref()
  jsii_get_property("eventBusRef")
end

#event_source_name ⇒ String?

The name of the partner event source.

Returns:

  • (String, nil) 


183
184
185
 
# File 'events/event_bus.rb', line 183

def event_source_name()
  jsii_get_property("eventSourceName")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


243
244
245
 
# File 'events/event_bus.rb', line 243

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) 


257
258
259
260
261
262
 
# File 'events/event_bus.rb', line 257

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) 


272
273
274
275
 
# File 'events/event_bus.rb', line 272

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_put_events_to(grantee, sid = nil) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



306
307
308
309
310
 
# File 'events/event_bus.rb', line 306

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

#grants ⇒ AWSCDK::Events::EventBusGrants

Collection of grant methods for an EventBus.

Returns:



176
177
178
 
# File 'events/event_bus.rb', line 176

def grants()
  jsii_get_property("grants")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


98
99
100
 
# File 'events/event_bus.rb', line 98

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) 


127
128
129
 
# File 'events/event_bus.rb', line 127

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



134
135
136
 
# File 'events/event_bus.rb', line 134

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


190
191
192
 
# File 'events/event_bus.rb', line 190

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) 


203
204
205
206
207
208
 
# File 'events/event_bus.rb', line 203

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