Class: AWSCDK::Interconnect::CfnConnectionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
interconnect/cfn_connection_props.rb

Overview

Properties for defining a CfnConnection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attach_point:, activation_key: nil, bandwidth: nil, description: nil, environment_id: nil, remote_account: nil, remote_owner_account: nil, tags: nil) ⇒ CfnConnectionProps

Returns a new instance of CfnConnectionProps.

Parameters:

  • attach_point (AWSCDK::IResolvable, AWSCDK::Interconnect::CfnConnection::AttachPointProperty) —

    The logical attachment point in your AWS network where the managed connection will be connected.

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

    The activation key for accepting a connection proposal from a partner CSP.

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

    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.

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

    A description of the connection.

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

    The ID of the environment for the connection.

  • remote_account (AWSCDK::IResolvable, AWSCDK::Interconnect::CfnConnection::RemoteAccountProperty, nil) (defaults to: nil) —

    The remote account identifier for the connection.

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

    Deprecated.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'interconnect/cfn_connection_props.rb', line 17

def initialize(attach_point:, activation_key: nil, bandwidth: nil, description: nil, environment_id: nil, remote_account: nil, remote_owner_account: nil, tags: nil)
  @attach_point = attach_point.is_a?(Hash) ? ::AWSCDK::Interconnect::CfnConnection::AttachPointProperty.new(**attach_point.transform_keys(&:to_sym)) : attach_point
  Jsii::Type.check_type(@attach_point, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbnRlcmNvbm5lY3QuQ2ZuQ29ubmVjdGlvbi5BdHRhY2hQb2ludFByb3BlcnR5In1dfX0=")), "attachPoint")
  @activation_key = activation_key
  Jsii::Type.check_type(@activation_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "activationKey") unless @activation_key.nil?
  @bandwidth = bandwidth
  Jsii::Type.check_type(@bandwidth, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bandwidth") unless @bandwidth.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @environment_id = environment_id
  Jsii::Type.check_type(@environment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId") unless @environment_id.nil?
  @remote_account = .is_a?(Hash) ? ::AWSCDK::Interconnect::CfnConnection::RemoteAccountProperty.new(**.transform_keys(&:to_sym)) : 
  Jsii::Type.check_type(@remote_account, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbnRlcmNvbm5lY3QuQ2ZuQ29ubmVjdGlvbi5SZW1vdGVBY2NvdW50UHJvcGVydHkifV19fQ==")), "remoteAccount") unless @remote_account.nil?
  @remote_owner_account = 
  Jsii::Type.check_type(@remote_owner_account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "remoteOwnerAccount") unless @remote_owner_account.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?
end

Instance Attribute Details

#activation_key ⇒ String? (readonly)

The activation key for accepting a connection proposal from a partner CSP.

Mutually exclusive with EnvironmentId.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'interconnect/cfn_connection_props.rb', line 47

def activation_key
  @activation_key
end

#attach_point ⇒ AWSCDK::IResolvable, AWSCDK::Interconnect::CfnConnection::AttachPointProperty (readonly)

The logical attachment point in your AWS network where the managed connection will be connected.

Returns:

See Also:



40
41
42
 
# File 'interconnect/cfn_connection_props.rb', line 40

def attach_point
  @attach_point
end

#bandwidth ⇒ String? (readonly)

The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'interconnect/cfn_connection_props.rb', line 52

def bandwidth
  @bandwidth
end

#description ⇒ String? (readonly)

A description of the connection.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'interconnect/cfn_connection_props.rb', line 57

def description
  @description
end

#environment_id ⇒ String? (readonly)

The ID of the environment for the connection.

Required when creating a connection through AWS. Mutually exclusive with ActivationKey.

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'interconnect/cfn_connection_props.rb', line 64

def environment_id
  @environment_id
end

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

The remote account identifier for the connection.

Required when creating a connection through AWS. Replaces RemoteOwnerAccount.

Returns:

See Also:



71
72
73
 
# File 'interconnect/cfn_connection_props.rb', line 71

def 
  @remote_account
end

#remote_owner_account ⇒ String? (readonly)

Deprecated.

this property has been deprecated

Deprecated.

Use RemoteAccount instead. The account ID of the remote owner. Required when creating a connection through AWS.

Returns:

  • (String, nil)

See Also:



79
80
81
 
# File 'interconnect/cfn_connection_props.rb', line 79

def 
  @remote_owner_account
end

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

An array of key-value pairs to apply to this resource.

Returns:

See Also:



84
85
86
 
# File 'interconnect/cfn_connection_props.rb', line 84

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'interconnect/cfn_connection_props.rb', line 86

def self.jsii_properties
  {
    :attach_point => "attachPoint",
    :activation_key => "activationKey",
    :bandwidth => "bandwidth",
    :description => "description",
    :environment_id => "environmentId",
    :remote_account => "remoteAccount",
    :remote_owner_account => "remoteOwnerAccount",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'interconnect/cfn_connection_props.rb', line 99

def to_jsii
  result = {}
  result.merge!({
    "attachPoint" => @attach_point,
    "activationKey" => @activation_key,
    "bandwidth" => @bandwidth,
    "description" => @description,
    "environmentId" => @environment_id,
    "remoteAccount" => @remote_account,
    "remoteOwnerAccount" => @remote_owner_account,
    "tags" => @tags,
  })
  result.compact
end