Class: AWSCDK::Events::CfnEndpointProps

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

Overview

Properties for defining a CfnEndpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(event_buses:, routing_config:, description: nil, name: nil, replication_config: nil, role_arn: nil) ⇒ CfnEndpointProps

Returns a new instance of CfnEndpointProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'events/cfn_endpoint_props.rb', line 15

def initialize(event_buses:, routing_config:, description: nil, name: nil, replication_config: nil, role_arn: nil)
  @event_buses = event_buses
  Jsii::Type.check_type(@event_buses, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLkNmbkVuZHBvaW50LkVuZHBvaW50RXZlbnRCdXNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "eventBuses")
  @routing_config = routing_config.is_a?(Hash) ? ::AWSCDK::Events::CfnEndpoint::RoutingConfigProperty.new(**routing_config.transform_keys(&:to_sym)) : routing_config
  Jsii::Type.check_type(@routing_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuRW5kcG9pbnQuUm91dGluZ0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "routingConfig")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @replication_config = replication_config.is_a?(Hash) ? ::AWSCDK::Events::CfnEndpoint::ReplicationConfigProperty.new(**replication_config.transform_keys(&:to_sym)) : replication_config
  Jsii::Type.check_type(@replication_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuRW5kcG9pbnQuUmVwbGljYXRpb25Db25maWdQcm9wZXJ0eSJ9XX19")), "replicationConfig") unless @replication_config.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description for the endpoint.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'events/cfn_endpoint_props.rb', line 46

def description
  @description
end

#event_buses ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Events::CfnEndpoint::EndpointEventBusProperty> (readonly)

The event buses being used by the endpoint.

Exactly : 2

Returns:

See Also:



36
37
38
 
# File 'events/cfn_endpoint_props.rb', line 36

def event_buses
  @event_buses
end

#name ⇒ String? (readonly)

The name of the endpoint.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'events/cfn_endpoint_props.rb', line 51

def name
  @name
end

#replication_config ⇒ AWSCDK::IResolvable, ... (readonly)

Whether event replication was enabled or disabled for this endpoint.

The default state is ENABLED which means you must supply a RoleArn . If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED .

Returns:

See Also:



58
59
60
 
# File 'events/cfn_endpoint_props.rb', line 58

def replication_config
  @replication_config
end

#role_arn ⇒ String? (readonly)

The ARN of the role used by event replication for the endpoint.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'events/cfn_endpoint_props.rb', line 63

def role_arn
  @role_arn
end

#routing_config ⇒ AWSCDK::IResolvable, AWSCDK::Events::CfnEndpoint::RoutingConfigProperty (readonly)

The routing configuration of the endpoint.

Returns:

See Also:



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

def routing_config
  @routing_config
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'events/cfn_endpoint_props.rb', line 65

def self.jsii_properties
  {
    :event_buses => "eventBuses",
    :routing_config => "routingConfig",
    :description => "description",
    :name => "name",
    :replication_config => "replicationConfig",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'events/cfn_endpoint_props.rb', line 76

def to_jsii
  result = {}
  result.merge!({
    "eventBuses" => @event_buses,
    "routingConfig" => @routing_config,
    "description" => @description,
    "name" => @name,
    "replicationConfig" => @replication_config,
    "roleArn" => @role_arn,
  })
  result.compact
end