Class: AWSCDK::Directconnect::CfnPrivateVirtualInterfaceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
directconnect/cfn_private_virtual_interface_props.rb

Overview

Properties for defining a CfnPrivateVirtualInterface.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bgp_peers:, connection_id:, virtual_interface_name:, vlan:, allocate_private_virtual_interface_role_arn: nil, direct_connect_gateway_id: nil, enable_site_link: nil, mtu: nil, tags: nil, virtual_gateway_id: nil) ⇒ CfnPrivateVirtualInterfaceProps

Returns a new instance of CfnPrivateVirtualInterfaceProps.

Parameters:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 19

def initialize(bgp_peers:, connection_id:, virtual_interface_name:, vlan:, allocate_private_virtual_interface_role_arn: nil, direct_connect_gateway_id: nil, enable_site_link: nil, mtu: nil, tags: nil, virtual_gateway_id: nil)
  @bgp_peers = bgp_peers
  Jsii::Type.check_type(@bgp_peers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGlyZWN0Y29ubmVjdC5DZm5Qcml2YXRlVmlydHVhbEludGVyZmFjZS5CZ3BQZWVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "bgpPeers")
  @connection_id = connection_id
  Jsii::Type.check_type(@connection_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kaXJlY3Rjb25uZWN0LklDb25uZWN0aW9uUmVmIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kaXJlY3Rjb25uZWN0LklMYWdSZWYifV19fQ==")), "connectionId")
  @virtual_interface_name = virtual_interface_name
  Jsii::Type.check_type(@virtual_interface_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualInterfaceName")
  @vlan = vlan
  Jsii::Type.check_type(@vlan, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "vlan")
  @allocate_private_virtual_interface_role_arn = allocate_private_virtual_interface_role_arn
  Jsii::Type.check_type(@allocate_private_virtual_interface_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allocatePrivateVirtualInterfaceRoleArn") unless @allocate_private_virtual_interface_role_arn.nil?
  @direct_connect_gateway_id = direct_connect_gateway_id
  Jsii::Type.check_type(@direct_connect_gateway_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kaXJlY3Rjb25uZWN0LklEaXJlY3RDb25uZWN0R2F0ZXdheVJlZiJ9XX19")), "directConnectGatewayId") unless @direct_connect_gateway_id.nil?
  @enable_site_link = enable_site_link
  Jsii::Type.check_type(@enable_site_link, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableSiteLink") unless @enable_site_link.nil?
  @mtu = mtu
  Jsii::Type.check_type(@mtu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "mtu") unless @mtu.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @virtual_gateway_id = virtual_gateway_id
  Jsii::Type.check_type(@virtual_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualGatewayId") unless @virtual_gateway_id.nil?
end

Instance Attribute Details

#allocate_private_virtual_interface_role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.

Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 68

def allocate_private_virtual_interface_role_arn
  @allocate_private_virtual_interface_role_arn
end

#bgp_peers ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Directconnect::CfnPrivateVirtualInterface::BgpPeerProperty> (readonly)

The BGP peers configured on this virtual interface.

Returns:

See Also:



46
47
48
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 46

def bgp_peers
  @bgp_peers
end

#connection_id ⇒ String, ... (readonly)

Returns:

See Also:



49
50
51
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 49

def connection_id
  @connection_id
end

#direct_connect_gateway_id ⇒ String, ... (readonly)

Returns:

See Also:



71
72
73
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 71

def direct_connect_gateway_id
  @direct_connect_gateway_id
end

#enable_site_link ⇒ Boolean, ... (readonly)

Indicates whether to enable or disable SiteLink.

Returns:

See Also:



76
77
78
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 76

def enable_site_link
  @enable_site_link
end

#mtu ⇒ Numeric? (readonly)

The maximum transmission unit (MTU), in bytes.

The supported values are 1500 and 9001. The default value is 1500.

Returns:

  • (Numeric, nil)

See Also:



83
84
85
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 83

def mtu
  @mtu
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags associated with the private virtual interface.

Returns:

See Also:



88
89
90
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 88

def tags
  @tags
end

#virtual_gateway_id ⇒ String? (readonly)

The ID or ARN of the virtual private gateway.

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 93

def virtual_gateway_id
  @virtual_gateway_id
end

#virtual_interface_name ⇒ String (readonly)

The name of the virtual interface assigned by the customer network.

The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Returns:

  • (String)

See Also:



56
57
58
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 56

def virtual_interface_name
  @virtual_interface_name
end

#vlan ⇒ Numeric (readonly)

The ID of the VLAN.

Returns:

  • (Numeric)

See Also:



61
62
63
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 61

def vlan
  @vlan
end

Class Method Details

.jsii_properties ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 95

def self.jsii_properties
  {
    :bgp_peers => "bgpPeers",
    :connection_id => "connectionId",
    :virtual_interface_name => "virtualInterfaceName",
    :vlan => "vlan",
    :allocate_private_virtual_interface_role_arn => "allocatePrivateVirtualInterfaceRoleArn",
    :direct_connect_gateway_id => "directConnectGatewayId",
    :enable_site_link => "enableSiteLink",
    :mtu => "mtu",
    :tags => "tags",
    :virtual_gateway_id => "virtualGatewayId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'directconnect/cfn_private_virtual_interface_props.rb', line 110

def to_jsii
  result = {}
  result.merge!({
    "bgpPeers" => @bgp_peers,
    "connectionId" => @connection_id,
    "virtualInterfaceName" => @virtual_interface_name,
    "vlan" => @vlan,
    "allocatePrivateVirtualInterfaceRoleArn" => @allocate_private_virtual_interface_role_arn,
    "directConnectGatewayId" => @direct_connect_gateway_id,
    "enableSiteLink" => @enable_site_link,
    "mtu" => @mtu,
    "tags" => @tags,
    "virtualGatewayId" => @virtual_gateway_id,
  })
  result.compact
end