Class: AWSCDK::EC2::CfnTransitGatewayConnectPeer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEC2::ITransitGatewayConnectPeerRef
Defined in:
ec2/cfn_transit_gateway_connect_peer.rb

Overview

Describes a transit gateway Connect peer.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTransitGatewayConnectPeer

Create a new AWS::EC2::TransitGatewayConnectPeer.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

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

  • props (AWSCDK::EC2::CfnTransitGatewayConnectPeerProps)

    Resource properties.



18
19
20
21
22
23
24
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTransitGatewayConnectPeerProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYW5zaXRHYXRld2F5Q29ubmVjdFBlZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_transit_gateway_connect_peer(resource) ⇒ String

Parameters:

Returns:

  • (String)


78
79
80
81
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 78

def self.arn_for_transit_gateway_connect_peer(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVRyYW5zaXRHYXRld2F5Q29ubmVjdFBlZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayConnectPeer", "arnForTransitGatewayConnectPeer", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


198
199
200
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 198

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

.from_transit_gateway_connect_peer_id(scope, id, transit_gateway_connect_peer_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITransitGatewayConnectPeerRef

Creates a new ITransitGatewayConnectPeerRef from a transitGatewayConnectPeerId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • transit_gateway_connect_peer_id (String)

Returns:



89
90
91
92
93
94
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 89

def self.from_transit_gateway_connect_peer_id(scope, id, transit_gateway_connect_peer_id)
  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(transit_gateway_connect_peer_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayConnectPeerId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayConnectPeer", "fromTransitGatewayConnectPeerId", [scope, id, transit_gateway_connect_peer_id])
end

.is_cfn_transit_gateway_connect_peer(x) ⇒ Boolean

Checks whether the given object is a CfnTransitGatewayConnectPeer.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


100
101
102
103
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 100

def self.is_cfn_transit_gateway_connect_peer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayConnectPeer", "isCfnTransitGatewayConnectPeer", [x])
end

.jsii_overridable_methodsObject



26
27
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
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 26

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_connect_peer_configuration_bgp_configurations => { kind: :property, name: "attrConnectPeerConfigurationBgpConfigurations", is_optional: false },
    :attr_connect_peer_configuration_protocol => { kind: :property, name: "attrConnectPeerConfigurationProtocol", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_transit_gateway_connect_peer_id => { kind: :property, name: "attrTransitGatewayConnectPeerId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :transit_gateway_connect_peer_ref => { kind: :property, name: "transitGatewayConnectPeerRef", is_optional: false },
    :connect_peer_configuration => { kind: :property, name: "connectPeerConfiguration", is_optional: false },
    :transit_gateway_attachment_id => { kind: :property, name: "transitGatewayAttachmentId", is_optional: false },
    :tags => { kind: :property, name: "tags", 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.



325
326
327
328
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 325

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:



337
338
339
340
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 337

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:



347
348
349
350
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 347

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.



358
359
360
361
362
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 358

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.


415
416
417
418
419
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 415

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.



425
426
427
428
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 425

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.



437
438
439
440
441
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 437

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:



450
451
452
453
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 450

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:



472
473
474
475
476
477
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 472

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_connect_peer_configuration_bgp_configurationsAWSCDK::IResolvable

The BGP configuration details.

Returns:



205
206
207
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 205

def attr_connect_peer_configuration_bgp_configurations()
  jsii_get_property("attrConnectPeerConfigurationBgpConfigurations")
end

#attr_connect_peer_configuration_protocolString

The tunnel protocol.

Returns:

  • (String)


212
213
214
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 212

def attr_connect_peer_configuration_protocol()
  jsii_get_property("attrConnectPeerConfigurationProtocol")
end

#attr_creation_timeString

The creation time.

Returns:

  • (String)


219
220
221
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 219

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_stateString

The state of the Connect peer.

Returns:

  • (String)


226
227
228
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 226

def attr_state()
  jsii_get_property("attrState")
end

#attr_transit_gateway_connect_peer_idString

The ID of the Connect peer.

Returns:

  • (String)


233
234
235
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 233

def attr_transit_gateway_connect_peer_id()
  jsii_get_property("attrTransitGatewayConnectPeerId")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



151
152
153
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


156
157
158
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


481
482
483
484
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 481

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})


161
162
163
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


168
169
170
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connect_peer_configurationAWSCDK::IResolvable, AWSCDK::EC2::CfnTransitGatewayConnectPeer::TransitGatewayConnectPeerConfigurationProperty

The Connect peer details.



254
255
256
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 254

def connect_peer_configuration()
  jsii_get_property("connectPeerConfiguration")
end

#connect_peer_configuration=(value) ⇒ Object



258
259
260
261
262
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 258

def connect_peer_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnTransitGatewayConnectPeer::TransitGatewayConnectPeerConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVHJhbnNpdEdhdGV3YXlDb25uZWN0UGVlci5UcmFuc2l0R2F0ZXdheUNvbm5lY3RQZWVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "connectPeerConfiguration")
  jsii_set_property("connectPeerConfiguration", value)
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


113
114
115
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#envAWSCDK::Interfaces::ResourceEnvironment



173
174
175
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 173

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:



494
495
496
497
498
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 494

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.



505
506
507
508
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 505

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



575
576
577
578
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 575

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)


125
126
127
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


108
109
110
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 108

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:



516
517
518
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 516

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:



523
524
525
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 523

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.



316
317
318
319
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 316

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

#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)


144
145
146
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 144

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:



534
535
536
537
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 534

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})


541
542
543
544
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 541

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:



551
552
553
554
555
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 551

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.



560
561
562
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 560

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:



134
135
136
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 134

def stack()
  jsii_get_property("stack")
end

#tagsArray<AWSCDK::CfnTag>?

The tags for the Connect peer.

Returns:



279
280
281
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 279

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



283
284
285
286
287
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 283

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



292
293
294
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 292

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

#transit_gateway_attachment_idString

The ID of the Connect attachment.

Returns:

  • (String)


267
268
269
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 267

def transit_gateway_attachment_id()
  jsii_get_property("transitGatewayAttachmentId")
end

#transit_gateway_attachment_id=(value) ⇒ Object



271
272
273
274
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 271

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

#transit_gateway_connect_peer_refAWSCDK::Interfaces::AWSEC2::TransitGatewayConnectPeerReference

A reference to a TransitGatewayConnectPeer resource.



247
248
249
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 247

def transit_gateway_connect_peer_ref()
  jsii_get_property("transitGatewayConnectPeerRef")
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})


181
182
183
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 181

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})


191
192
193
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


566
567
568
569
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 566

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)


305
306
307
308
309
310
# File 'ec2/cfn_transit_gateway_connect_peer.rb', line 305

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