Class: AWSCDK::AWSEventMetadataProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
aws_event_metadata_props.rb

Overview

Properties for AWS EventBridge event metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(region: nil, resources: nil, version: nil) ⇒ AWSEventMetadataProps

Returns a new instance of AWSEventMetadataProps.

Parameters:

  • region (Array<String>, nil) (defaults to: nil) —

    Identifies the AWS region where the event originated.

  • resources (Array<String>, nil) (defaults to: nil) —

    This JSON array contains ARNs that identify resources that are involved in the event.

  • version (Array<String>, nil) (defaults to: nil) —

    By default, this is set to 0 (zero) in all events.



10
11
12
13
14
15
16
17
 
# File 'aws_event_metadata_props.rb', line 10

def initialize(region: nil, resources: nil, version: nil)
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "region") unless @region.nil?
  @resources = resources
  Jsii::Type.check_type(@resources, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resources") unless @resources.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "version") unless @version.nil?
end

Instance Attribute Details

#region ⇒ Array<String>? (readonly)

Note:

Default: - No filtering on region

Identifies the AWS region where the event originated.

Returns:

  • (Array<String>, nil) 


23
24
25
 
# File 'aws_event_metadata_props.rb', line 23

def region
  @region
end

#resources ⇒ Array<String>? (readonly)

Note:

Default: - No filtering on resource

This JSON array contains ARNs that identify resources that are involved in the event.

Inclusion of these ARNs is at the discretion of the service.

For example, Amazon EC2 instance state-changes include Amazon EC2 instance ARNs, Auto Scaling events include ARNs for both instances and Auto Scaling groups, but API calls with AWS CloudTrail do not include resource ARNs.

Returns:

  • (Array<String>, nil) 


36
37
38
 
# File 'aws_event_metadata_props.rb', line 36

def resources
  @resources
end

#version ⇒ Array<String>? (readonly)

Note:

Default: - No filtering on version

By default, this is set to 0 (zero) in all events.

Returns:

  • (Array<String>, nil) 


41
42
43
 
# File 'aws_event_metadata_props.rb', line 41

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 'aws_event_metadata_props.rb', line 43

def self.jsii_properties
  {
    :region => "region",
    :resources => "resources",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'aws_event_metadata_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "region" => @region,
    "resources" => @resources,
    "version" => @version,
  })
  result.compact
end