Class: AWSCDK::Events::APIDestinationAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
events/api_destination_attributes.rb

Overview

The properties to import an existing Api Destination.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_destination_arn:, connection:, api_destination_arn_for_policy: nil) ⇒ APIDestinationAttributes

Returns a new instance of APIDestinationAttributes.

Parameters:

  • api_destination_arn (String) —

    The ARN of the Api Destination.

  • connection (AWSCDK::Interfaces::AWSEvents::IConnectionRef) —

    The Connection to associate with the Api Destination.

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

    The Amazon Resource Name (ARN) of an API destination in resource format.



10
11
12
13
14
15
16
17
 
# File 'events/api_destination_attributes.rb', line 10

def initialize(api_destination_arn:, connection:, api_destination_arn_for_policy: nil)
  @api_destination_arn = api_destination_arn
  Jsii::Type.check_type(@api_destination_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiDestinationArn")
  @connection = connection
  Jsii::Type.check_type(@connection, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ldmVudHMuSUNvbm5lY3Rpb25SZWYifQ==")), "connection")
  @api_destination_arn_for_policy = api_destination_arn_for_policy
  Jsii::Type.check_type(@api_destination_arn_for_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiDestinationArnForPolicy") unless @api_destination_arn_for_policy.nil?
end

Instance Attribute Details

#api_destination_arn ⇒ String (readonly)

The ARN of the Api Destination.

Returns:

  • (String) 


22
23
24
 
# File 'events/api_destination_attributes.rb', line 22

def api_destination_arn
  @api_destination_arn
end

#api_destination_arn_for_policy ⇒ String? (readonly)

Note:

Default: undefined - Imported API destination does not have ARN in resource format

The Amazon Resource Name (ARN) of an API destination in resource format.

Returns:

  • (String, nil) 


31
32
33
 
# File 'events/api_destination_attributes.rb', line 31

def api_destination_arn_for_policy
  @api_destination_arn_for_policy
end

#connection ⇒ AWSCDK::Interfaces::AWSEvents::IConnectionRef (readonly)

The Connection to associate with the Api Destination.

Returns:



26
27
28
 
# File 'events/api_destination_attributes.rb', line 26

def connection
  @connection
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
39
 
# File 'events/api_destination_attributes.rb', line 33

def self.jsii_properties
  {
    :api_destination_arn => "apiDestinationArn",
    :connection => "connection",
    :api_destination_arn_for_policy => "apiDestinationArnForPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'events/api_destination_attributes.rb', line 41

def to_jsii
  result = {}
  result.merge!({
    "apiDestinationArn" => @api_destination_arn,
    "connection" => @connection,
    "apiDestinationArnForPolicy" => @api_destination_arn_for_policy,
  })
  result.compact
end