Class: AWSCDK::EC2::CfnTransitGatewayPeeringAttachment

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::ITransitGatewayPeeringAttachmentRef
Defined in:
ec2/cfn_transit_gateway_peering_attachment.rb

Overview

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).

The peer transit gateway can be in your account or a different AWS account .

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTransitGatewayPeeringAttachment

Create a new AWS::EC2::TransitGatewayPeeringAttachment.

Parameters:



22
23
24
25
26
27
28
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 22

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

Class Method Details

.arn_for_transit_gateway_peering_attachment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 85

def self.arn_for_transit_gateway_peering_attachment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVRyYW5zaXRHYXRld2F5UGVlcmluZ0F0dGFjaG1lbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayPeeringAttachment", "arnForTransitGatewayPeeringAttachment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_transit_gateway_attachment_id(scope, id, transit_gateway_attachment_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITransitGatewayPeeringAttachmentRef

Creates a new ITransitGatewayPeeringAttachmentRef from a transitGatewayAttachmentId.

Parameters:

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

Returns:



96
97
98
99
100
101
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 96

def self.from_transit_gateway_attachment_id(scope, id, transit_gateway_attachment_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_attachment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayAttachmentId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayPeeringAttachment", "fromTransitGatewayAttachmentId", [scope, id, transit_gateway_attachment_id])
end

.is_cfn_transit_gateway_peering_attachment(x) ⇒ Boolean

Checks whether the given object is a CfnTransitGatewayPeeringAttachment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 30

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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_code => { kind: :property, name: "attrStatusCode", is_optional: false },
    :attr_status_message => { kind: :property, name: "attrStatusMessage", is_optional: false },
    :attr_transit_gateway_attachment_id => { kind: :property, name: "attrTransitGatewayAttachmentId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :transit_gateway_peering_attachment_ref => { kind: :property, name: "transitGatewayPeeringAttachmentRef", is_optional: false },
    :peer_account_id => { kind: :property, name: "peerAccountId", is_optional: false },
    :peer_region => { kind: :property, name: "peerRegion", is_optional: false },
    :peer_transit_gateway_id => { kind: :property, name: "peerTransitGatewayId", is_optional: false },
    :transit_gateway_id => { kind: :property, name: "transitGatewayId", is_optional: false },
    :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.



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

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:



370
371
372
373
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 370

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:



380
381
382
383
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 380

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



391
392
393
394
395
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 391

def add_metadata(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.


448
449
450
451
452
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 448

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.



458
459
460
461
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 458

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.



470
471
472
473
474
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 470

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:



483
484
485
486
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 483

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:

Parameters:

See Also:



505
506
507
508
509
510
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 505

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_creation_time ⇒ String

The time the transit gateway peering attachment was created.

Returns:

  • (String) 


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

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_state ⇒ String

The state of the transit gateway peering attachment.

Note that the initiating state has been deprecated.

Returns:

  • (String) 


221
222
223
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 221

def attr_state()
  jsii_get_property("attrState")
end

#attr_status ⇒ AWSCDK::IResolvable

Returns:



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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_code ⇒ String

Returns:

  • (String) 


231
232
233
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 231

def attr_status_code()
  jsii_get_property("attrStatusCode")
end

#attr_status_message ⇒ String

Returns:

  • (String) 


236
237
238
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 236

def attr_status_message()
  jsii_get_property("attrStatusMessage")
end

#attr_transit_gateway_attachment_id ⇒ String

The ID of the transit gateway peering attachment.

Returns:

  • (String) 


243
244
245
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 243

def attr_transit_gateway_attachment_id()
  jsii_get_property("attrTransitGatewayAttachmentId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


514
515
516
517
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 514

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 180

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:



527
528
529
530
531
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 527

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



538
539
540
541
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 538

def get_metadata(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:



608
609
610
611
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 608

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

#logical_id ⇒ String

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) 


132
133
134
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 115

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<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:



549
550
551
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 549

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



556
557
558
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 556

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.



349
350
351
352
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 349

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_account_id ⇒ String

The ID of the AWS account that owns the transit gateway.

Returns:

  • (String) 


264
265
266
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 264

def ()
  jsii_get_property("peerAccountId")
end

#peer_account_id=(value) ⇒ Object 



268
269
270
271
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 268

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

#peer_region ⇒ String

The Region where the transit gateway that you want to create the peer for is located.

Returns:

  • (String) 


276
277
278
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 276

def peer_region()
  jsii_get_property("peerRegion")
end

#peer_region=(value) ⇒ Object 



280
281
282
283
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 280

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

#peer_transit_gateway_id ⇒ String

The ID of the transit gateway in the PeerRegion.

Returns:

  • (String) 


288
289
290
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 288

def peer_transit_gateway_id()
  jsii_get_property("peerTransitGatewayId")
end

#peer_transit_gateway_id=(value) ⇒ Object 



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

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

#ref ⇒ String

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) 


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

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:



567
568
569
570
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 567

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


574
575
576
577
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 574

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:



584
585
586
587
588
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 584

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_synthesize ⇒ Boolean

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.



593
594
595
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 593

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



141
142
143
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



250
251
252
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 250

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the transit gateway peering attachment.

Returns:



312
313
314
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 312

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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

#transit_gateway_id ⇒ String

The ID of the transit gateway peering attachment.

Returns:

  • (String) 


300
301
302
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 300

def transit_gateway_id()
  jsii_get_property("transitGatewayId")
end

#transit_gateway_id=(value) ⇒ Object 



304
305
306
307
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 304

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

#transit_gateway_peering_attachment_ref ⇒ AWSCDK::Interfaces::AWSEC2::TransitGatewayPeeringAttachmentReference

A reference to a TransitGatewayPeeringAttachment resource.

Returns:



257
258
259
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 257

def transit_gateway_peering_attachment_ref()
  jsii_get_property("transitGatewayPeeringAttachmentRef")
end

#updated_properites ⇒ Hash{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}) 


188
189
190
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 188

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


599
600
601
602
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 599

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) 


338
339
340
341
342
343
 
# File 'ec2/cfn_transit_gateway_peering_attachment.rb', line 338

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