Class: AWSCDK::NetworkManager::CfnConnectPeer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSNetworkmanager::IConnectPeerRef
Defined in:
network_manager/cfn_connect_peer.rb

Overview

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConnectPeer

Create a new AWS::NetworkManager::ConnectPeer.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::NetworkManager::CfnConnectPeerProps)

    Resource properties.



20
21
22
23
24
25
26
# File 'network_manager/cfn_connect_peer.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnConnectPeerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbmV0d29ya21hbmFnZXIuQ2ZuQ29ubmVjdFBlZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


191
192
193
# File 'network_manager/cfn_connect_peer.rb', line 191

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_networkmanager.CfnConnectPeer", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_connect_peer(x) ⇒ Boolean

Checks whether the given object is a CfnConnectPeer.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


93
94
95
96
# File 'network_manager/cfn_connect_peer.rb', line 93

def self.is_cfn_connect_peer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnConnectPeer", "isCfnConnectPeer", [x])
end

.jsii_overridable_methodsObject



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'network_manager/cfn_connect_peer.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_configuration => { kind: :property, name: "attrConfiguration", is_optional: false },
    :attr_configuration_bgp_configurations => { kind: :property, name: "attrConfigurationBgpConfigurations", is_optional: false },
    :attr_configuration_core_network_address => { kind: :property, name: "attrConfigurationCoreNetworkAddress", is_optional: false },
    :attr_configuration_inside_cidr_blocks => { kind: :property, name: "attrConfigurationInsideCidrBlocks", is_optional: false },
    :attr_configuration_peer_address => { kind: :property, name: "attrConfigurationPeerAddress", is_optional: false },
    :attr_configuration_protocol => { kind: :property, name: "attrConfigurationProtocol", is_optional: false },
    :attr_connect_peer_id => { kind: :property, name: "attrConnectPeerId", is_optional: false },
    :attr_core_network_id => { kind: :property, name: "attrCoreNetworkId", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_edge_location => { kind: :property, name: "attrEdgeLocation", is_optional: false },
    :attr_last_modification_errors => { kind: :property, name: "attrLastModificationErrors", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :connect_peer_ref => { kind: :property, name: "connectPeerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :connect_attachment_id => { kind: :property, name: "connectAttachmentId", is_optional: false },
    :peer_address => { kind: :property, name: "peerAddress", is_optional: false },
    :bgp_options => { kind: :property, name: "bgpOptions", is_optional: true },
    :core_network_address => { kind: :property, name: "coreNetworkAddress", is_optional: true },
    :inside_cidr_blocks => { kind: :property, name: "insideCidrBlocks", is_optional: true },
    :subnet_arn => { kind: :property, name: "subnetArn", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



405
406
407
408
# File 'network_manager/cfn_connect_peer.rb', line 405

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



417
418
419
420
# File 'network_manager/cfn_connect_peer.rb', line 417

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



427
428
429
430
# File 'network_manager/cfn_connect_peer.rb', line 427

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



438
439
440
441
442
# File 'network_manager/cfn_connect_peer.rb', line 438

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


495
496
497
498
499
# File 'network_manager/cfn_connect_peer.rb', line 495

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



505
506
507
508
# File 'network_manager/cfn_connect_peer.rb', line 505

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



517
518
519
520
521
# File 'network_manager/cfn_connect_peer.rb', line 517

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



530
531
532
533
# File 'network_manager/cfn_connect_peer.rb', line 530

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



552
553
554
555
556
557
# File 'network_manager/cfn_connect_peer.rb', line 552

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_configurationAWSCDK::IResolvable

Returns:



196
197
198
# File 'network_manager/cfn_connect_peer.rb', line 196

def attr_configuration()
  jsii_get_property("attrConfiguration")
end

#attr_configuration_bgp_configurationsAWSCDK::IResolvable

Returns:



201
202
203
# File 'network_manager/cfn_connect_peer.rb', line 201

def attr_configuration_bgp_configurations()
  jsii_get_property("attrConfigurationBgpConfigurations")
end

#attr_configuration_core_network_addressString

Returns:

  • (String)


206
207
208
# File 'network_manager/cfn_connect_peer.rb', line 206

def attr_configuration_core_network_address()
  jsii_get_property("attrConfigurationCoreNetworkAddress")
end

#attr_configuration_inside_cidr_blocksArray<String>

Returns:

  • (Array<String>)


211
212
213
# File 'network_manager/cfn_connect_peer.rb', line 211

def attr_configuration_inside_cidr_blocks()
  jsii_get_property("attrConfigurationInsideCidrBlocks")
end

#attr_configuration_peer_addressString

Returns:

  • (String)


216
217
218
# File 'network_manager/cfn_connect_peer.rb', line 216

def attr_configuration_peer_address()
  jsii_get_property("attrConfigurationPeerAddress")
end

#attr_configuration_protocolString

Returns:

  • (String)


221
222
223
# File 'network_manager/cfn_connect_peer.rb', line 221

def attr_configuration_protocol()
  jsii_get_property("attrConfigurationProtocol")
end

#attr_connect_peer_idString

The ID of the Connect peer.

Returns:

  • (String)


228
229
230
# File 'network_manager/cfn_connect_peer.rb', line 228

def attr_connect_peer_id()
  jsii_get_property("attrConnectPeerId")
end

#attr_core_network_idString

The core network ID.

Returns:

  • (String)


235
236
237
# File 'network_manager/cfn_connect_peer.rb', line 235

def attr_core_network_id()
  jsii_get_property("attrCoreNetworkId")
end

#attr_created_atString

The timestamp when the Connect peer was created.

Returns:

  • (String)


242
243
244
# File 'network_manager/cfn_connect_peer.rb', line 242

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_edge_locationString

The Connect peer Regions where edges are located.

Returns:

  • (String)


249
250
251
# File 'network_manager/cfn_connect_peer.rb', line 249

def attr_edge_location()
  jsii_get_property("attrEdgeLocation")
end

#attr_last_modification_errorsArray<String>

Describes the error associated with the attachment request.

Returns:

  • (Array<String>)


256
257
258
# File 'network_manager/cfn_connect_peer.rb', line 256

def attr_last_modification_errors()
  jsii_get_property("attrLastModificationErrors")
end

#attr_stateString

The state of the Connect peer.

This will be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING .

Returns:

  • (String)


265
266
267
# File 'network_manager/cfn_connect_peer.rb', line 265

def attr_state()
  jsii_get_property("attrState")
end

#bgp_optionsAWSCDK::IResolvable, ...

Describes the BGP options.



310
311
312
# File 'network_manager/cfn_connect_peer.rb', line 310

def bgp_options()
  jsii_get_property("bgpOptions")
end

#bgp_options=(value) ⇒ Object



314
315
316
317
318
# File 'network_manager/cfn_connect_peer.rb', line 314

def bgp_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnConnectPeer::BgpOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5Db25uZWN0UGVlci5CZ3BPcHRpb25zUHJvcGVydHkifV19fQ==")), "bgpOptions") unless value.nil?
  jsii_set_property("bgpOptions", value)
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



144
145
146
# File 'network_manager/cfn_connect_peer.rb', line 144

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


149
150
151
# File 'network_manager/cfn_connect_peer.rb', line 149

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


561
562
563
564
# File 'network_manager/cfn_connect_peer.rb', line 561

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


154
155
156
# File 'network_manager/cfn_connect_peer.rb', line 154

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


161
162
163
# File 'network_manager/cfn_connect_peer.rb', line 161

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connect_attachment_idString

The ID of the attachment to connect.

Returns:

  • (String)


286
287
288
# File 'network_manager/cfn_connect_peer.rb', line 286

def connect_attachment_id()
  jsii_get_property("connectAttachmentId")
end

#connect_attachment_id=(value) ⇒ Object



290
291
292
293
# File 'network_manager/cfn_connect_peer.rb', line 290

def connect_attachment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectAttachmentId")
  jsii_set_property("connectAttachmentId", value)
end

#connect_peer_refAWSCDK::Interfaces::AWSNetworkmanager::ConnectPeerReference

A reference to a ConnectPeer resource.



272
273
274
# File 'network_manager/cfn_connect_peer.rb', line 272

def connect_peer_ref()
  jsii_get_property("connectPeerRef")
end

#core_network_addressString?

The IP address of a core network.

Returns:

  • (String, nil)


323
324
325
# File 'network_manager/cfn_connect_peer.rb', line 323

def core_network_address()
  jsii_get_property("coreNetworkAddress")
end

#core_network_address=(value) ⇒ Object



327
328
329
330
# File 'network_manager/cfn_connect_peer.rb', line 327

def core_network_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "coreNetworkAddress") unless value.nil?
  jsii_set_property("coreNetworkAddress", value)
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


106
107
108
# File 'network_manager/cfn_connect_peer.rb', line 106

def creation_stack()
  jsii_get_property("creationStack")
end

#envAWSCDK::Interfaces::ResourceEnvironment



166
167
168
# File 'network_manager/cfn_connect_peer.rb', line 166

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



574
575
576
577
578
# File 'network_manager/cfn_connect_peer.rb', line 574

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



585
586
587
588
# File 'network_manager/cfn_connect_peer.rb', line 585

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inside_cidr_blocksArray<String>?

The inside IP addresses used for a Connect peer configuration.

Returns:

  • (Array<String>, nil)


335
336
337
# File 'network_manager/cfn_connect_peer.rb', line 335

def inside_cidr_blocks()
  jsii_get_property("insideCidrBlocks")
end

#inside_cidr_blocks=(value) ⇒ Object



339
340
341
342
# File 'network_manager/cfn_connect_peer.rb', line 339

def inside_cidr_blocks=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "insideCidrBlocks") unless value.nil?
  jsii_set_property("insideCidrBlocks", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



655
656
657
658
# File 'network_manager/cfn_connect_peer.rb', line 655

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


118
119
120
# File 'network_manager/cfn_connect_peer.rb', line 118

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


101
102
103
# File 'network_manager/cfn_connect_peer.rb', line 101

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



596
597
598
# File 'network_manager/cfn_connect_peer.rb', line 596

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



603
604
605
# File 'network_manager/cfn_connect_peer.rb', line 603

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



396
397
398
399
# File 'network_manager/cfn_connect_peer.rb', line 396

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#peer_addressString

The IP address of the Connect peer.

Returns:

  • (String)


298
299
300
# File 'network_manager/cfn_connect_peer.rb', line 298

def peer_address()
  jsii_get_property("peerAddress")
end

#peer_address=(value) ⇒ Object



302
303
304
305
# File 'network_manager/cfn_connect_peer.rb', line 302

def peer_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerAddress")
  jsii_set_property("peerAddress", value)
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


137
138
139
# File 'network_manager/cfn_connect_peer.rb', line 137

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



614
615
616
617
# File 'network_manager/cfn_connect_peer.rb', line 614

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


621
622
623
624
# File 'network_manager/cfn_connect_peer.rb', line 621

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



631
632
633
634
635
# File 'network_manager/cfn_connect_peer.rb', line 631

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



640
641
642
# File 'network_manager/cfn_connect_peer.rb', line 640

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



127
128
129
# File 'network_manager/cfn_connect_peer.rb', line 127

def stack()
  jsii_get_property("stack")
end

#subnet_arnString?

The subnet ARN of the Connect peer.

Returns:

  • (String, nil)


347
348
349
# File 'network_manager/cfn_connect_peer.rb', line 347

def subnet_arn()
  jsii_get_property("subnetArn")
end

#subnet_arn=(value) ⇒ Object



351
352
353
354
# File 'network_manager/cfn_connect_peer.rb', line 351

def subnet_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetArn") unless value.nil?
  jsii_set_property("subnetArn", value)
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



279
280
281
# File 'network_manager/cfn_connect_peer.rb', line 279

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

The list of key-value tags associated with the Connect peer.

Returns:



359
360
361
# File 'network_manager/cfn_connect_peer.rb', line 359

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



363
364
365
366
367
# File 'network_manager/cfn_connect_peer.rb', line 363

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



372
373
374
# File 'network_manager/cfn_connect_peer.rb', line 372

def to_string()
  jsii_call_method("toString", [])
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


174
175
176
# File 'network_manager/cfn_connect_peer.rb', line 174

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


184
185
186
# File 'network_manager/cfn_connect_peer.rb', line 184

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


646
647
648
649
# File 'network_manager/cfn_connect_peer.rb', line 646

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


385
386
387
388
389
390
# File 'network_manager/cfn_connect_peer.rb', line 385

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end