Class: AWSCDK::NetworkManager::CfnConnectAttachment

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

Overview

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConnectAttachment

Create a new AWS::NetworkManager::ConnectAttachment.

Parameters:



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

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

Class Method Details

.arn_for_connect_attachment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'network_manager/cfn_connect_attachment.rb', line 92

def self.arn_for_connect_attachment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19uZXR3b3JrbWFuYWdlci5JQ29ubmVjdEF0dGFjaG1lbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnConnectAttachment", "arnForConnectAttachment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


212
213
214
 
# File 'network_manager/cfn_connect_attachment.rb', line 212

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

.from_attachment_id(scope, id, attachment_id) ⇒ AWSCDK::Interfaces::AWSNetworkmanager::IConnectAttachmentRef

Creates a new IConnectAttachmentRef from a attachmentId.

Parameters:

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

Returns:



103
104
105
106
107
108
 
# File 'network_manager/cfn_connect_attachment.rb', line 103

def self.from_attachment_id(scope, id, 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(attachment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attachmentId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnConnectAttachment", "fromAttachmentId", [scope, id, attachment_id])
end

.is_cfn_connect_attachment(x) ⇒ Boolean

Checks whether the given object is a CfnConnectAttachment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


114
115
116
117
 
# File 'network_manager/cfn_connect_attachment.rb', line 114

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

.jsii_overridable_methods ⇒ Object 



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
88
 
# File 'network_manager/cfn_connect_attachment.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_attachment_id => { kind: :property, name: "attrAttachmentId", is_optional: false },
    :attr_attachment_policy_rule_number => { kind: :property, name: "attrAttachmentPolicyRuleNumber", is_optional: false },
    :attr_attachment_type => { kind: :property, name: "attrAttachmentType", is_optional: false },
    :attr_core_network_arn => { kind: :property, name: "attrCoreNetworkArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_last_modification_errors => { kind: :property, name: "attrLastModificationErrors", is_optional: false },
    :attr_owner_account_id => { kind: :property, name: "attrOwnerAccountId", is_optional: false },
    :attr_resource_arn => { kind: :property, name: "attrResourceArn", is_optional: false },
    :attr_segment_name => { kind: :property, name: "attrSegmentName", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :connect_attachment_ref => { kind: :property, name: "connectAttachmentRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :core_network_id => { kind: :property, name: "coreNetworkId", is_optional: false },
    :edge_location => { kind: :property, name: "edgeLocation", is_optional: false },
    :options => { kind: :property, name: "options", is_optional: false },
    :transport_attachment_id => { kind: :property, name: "transportAttachmentId", is_optional: false },
    :network_function_group_name => { kind: :property, name: "networkFunctionGroupName", is_optional: true },
    :proposed_network_function_group_change => { kind: :property, name: "proposedNetworkFunctionGroupChange", is_optional: true },
    :proposed_segment_change => { kind: :property, name: "proposedSegmentChange", is_optional: true },
    :routing_policy_label => { kind: :property, name: "routingPolicyLabel", 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.



459
460
461
462
 
# File 'network_manager/cfn_connect_attachment.rb', line 459

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:



471
472
473
474
 
# File 'network_manager/cfn_connect_attachment.rb', line 471

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:



481
482
483
484
 
# File 'network_manager/cfn_connect_attachment.rb', line 481

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:



492
493
494
495
496
 
# File 'network_manager/cfn_connect_attachment.rb', line 492

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.


549
550
551
552
553
 
# File 'network_manager/cfn_connect_attachment.rb', line 549

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.



559
560
561
562
 
# File 'network_manager/cfn_connect_attachment.rb', line 559

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.



571
572
573
574
575
 
# File 'network_manager/cfn_connect_attachment.rb', line 571

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:



584
585
586
587
 
# File 'network_manager/cfn_connect_attachment.rb', line 584

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:



606
607
608
609
610
611
 
# File 'network_manager/cfn_connect_attachment.rb', line 606

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

The ID of the Connect attachment.

Returns:

  • (String) 


219
220
221
 
# File 'network_manager/cfn_connect_attachment.rb', line 219

def attr_attachment_id()
  jsii_get_property("attrAttachmentId")
end

#attr_attachment_policy_rule_number ⇒ Numeric

The rule number associated with the attachment.

Returns:

  • (Numeric) 


226
227
228
 
# File 'network_manager/cfn_connect_attachment.rb', line 226

def attr_attachment_policy_rule_number()
  jsii_get_property("attrAttachmentPolicyRuleNumber")
end

#attr_attachment_type ⇒ String

The type of attachment.

This will be CONNECT .

Returns:

  • (String) 


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

def attr_attachment_type()
  jsii_get_property("attrAttachmentType")
end

#attr_core_network_arn ⇒ String

The ARN of the core network.

Returns:

  • (String) 


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

def attr_core_network_arn()
  jsii_get_property("attrCoreNetworkArn")
end

#attr_created_at ⇒ String

The timestamp when the Connect attachment was created.

Returns:

  • (String) 


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

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_last_modification_errors ⇒ Array<String>

Errors from the last modification of the attachment.

Returns:

  • (Array<String>) 


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

def attr_last_modification_errors()
  jsii_get_property("attrLastModificationErrors")
end

#attr_owner_account_id ⇒ String

The ID of the Connect attachment owner.

Returns:

  • (String) 


263
264
265
 
# File 'network_manager/cfn_connect_attachment.rb', line 263

def ()
  jsii_get_property("attrOwnerAccountId")
end

#attr_resource_arn ⇒ String

The resource ARN for the Connect attachment.

Returns:

  • (String) 


270
271
272
 
# File 'network_manager/cfn_connect_attachment.rb', line 270

def attr_resource_arn()
  jsii_get_property("attrResourceArn")
end

#attr_segment_name ⇒ String

The name of the Connect attachment's segment.

Returns:

  • (String) 


277
278
279
 
# File 'network_manager/cfn_connect_attachment.rb', line 277

def attr_segment_name()
  jsii_get_property("attrSegmentName")
end

#attr_state ⇒ String

The state of the Connect attachment.

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

Returns:

  • (String) 


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

def attr_state()
  jsii_get_property("attrState")
end

#attr_updated_at ⇒ String

The timestamp when the Connect attachment was last updated.

Returns:

  • (String) 


293
294
295
 
# File 'network_manager/cfn_connect_attachment.rb', line 293

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



165
166
167
 
# File 'network_manager/cfn_connect_attachment.rb', line 165

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'network_manager/cfn_connect_attachment.rb', line 170

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


615
616
617
618
 
# File 'network_manager/cfn_connect_attachment.rb', line 615

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


175
176
177
 
# File 'network_manager/cfn_connect_attachment.rb', line 175

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


182
183
184
 
# File 'network_manager/cfn_connect_attachment.rb', line 182

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connect_attachment_ref ⇒ AWSCDK::Interfaces::AWSNetworkmanager::ConnectAttachmentReference

A reference to a ConnectAttachment resource.

Returns:



300
301
302
 
# File 'network_manager/cfn_connect_attachment.rb', line 300

def connect_attachment_ref()
  jsii_get_property("connectAttachmentRef")
end

#core_network_id ⇒ String

The ID of the core network where the Connect attachment is located.

Returns:

  • (String) 


314
315
316
 
# File 'network_manager/cfn_connect_attachment.rb', line 314

def core_network_id()
  jsii_get_property("coreNetworkId")
end

#core_network_id=(value) ⇒ Object 



318
319
320
321
 
# File 'network_manager/cfn_connect_attachment.rb', line 318

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#edge_location ⇒ String

The Region where the edge is located.

Returns:

  • (String) 


326
327
328
 
# File 'network_manager/cfn_connect_attachment.rb', line 326

def edge_location()
  jsii_get_property("edgeLocation")
end

#edge_location=(value) ⇒ Object 



330
331
332
333
 
# File 'network_manager/cfn_connect_attachment.rb', line 330

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



187
188
189
 
# File 'network_manager/cfn_connect_attachment.rb', line 187

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:



628
629
630
631
632
 
# File 'network_manager/cfn_connect_attachment.rb', line 628

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:



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

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:



709
710
711
712
 
# File 'network_manager/cfn_connect_attachment.rb', line 709

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) 


139
140
141
 
# File 'network_manager/cfn_connect_attachment.rb', line 139

def logical_id()
  jsii_get_property("logicalId")
end

#network_function_group_name ⇒ String?

The name of the network function group.

Returns:

  • (String, nil) 


363
364
365
 
# File 'network_manager/cfn_connect_attachment.rb', line 363

def network_function_group_name()
  jsii_get_property("networkFunctionGroupName")
end

#network_function_group_name=(value) ⇒ Object 



367
368
369
370
 
# File 'network_manager/cfn_connect_attachment.rb', line 367

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


122
123
124
 
# File 'network_manager/cfn_connect_attachment.rb', line 122

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:



650
651
652
 
# File 'network_manager/cfn_connect_attachment.rb', line 650

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:



657
658
659
 
# File 'network_manager/cfn_connect_attachment.rb', line 657

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

#options ⇒ AWSCDK::IResolvable, AWSCDK::NetworkManager::CfnConnectAttachment::ConnectAttachmentOptionsProperty

Options for connecting an attachment.

Returns:



338
339
340
 
# File 'network_manager/cfn_connect_attachment.rb', line 338

def options()
  jsii_get_property("options")
end

#options=(value) ⇒ Object 



342
343
344
345
346
 
# File 'network_manager/cfn_connect_attachment.rb', line 342

def options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnConnectAttachment::ConnectAttachmentOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5Db25uZWN0QXR0YWNobWVudC5Db25uZWN0QXR0YWNobWVudE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "options")
  jsii_set_property("options", value)
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.



450
451
452
453
 
# File 'network_manager/cfn_connect_attachment.rb', line 450

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

#proposed_network_function_group_change ⇒ AWSCDK::IResolvable, ...

Describes proposed changes to a network function group.

Returns:



375
376
377
 
# File 'network_manager/cfn_connect_attachment.rb', line 375

def proposed_network_function_group_change()
  jsii_get_property("proposedNetworkFunctionGroupChange")
end

#proposed_network_function_group_change=(value) ⇒ Object 



379
380
381
382
383
 
# File 'network_manager/cfn_connect_attachment.rb', line 379

def proposed_network_function_group_change=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnConnectAttachment::ProposedNetworkFunctionGroupChangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5Db25uZWN0QXR0YWNobWVudC5Qcm9wb3NlZE5ldHdvcmtGdW5jdGlvbkdyb3VwQ2hhbmdlUHJvcGVydHkifV19fQ==")), "proposedNetworkFunctionGroupChange") unless value.nil?
  jsii_set_property("proposedNetworkFunctionGroupChange", value)
end

#proposed_segment_change ⇒ AWSCDK::IResolvable, ...

Describes a proposed segment change.

Returns:



388
389
390
 
# File 'network_manager/cfn_connect_attachment.rb', line 388

def proposed_segment_change()
  jsii_get_property("proposedSegmentChange")
end

#proposed_segment_change=(value) ⇒ Object 



392
393
394
395
396
 
# File 'network_manager/cfn_connect_attachment.rb', line 392

def proposed_segment_change=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnConnectAttachment::ProposedSegmentChangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5Db25uZWN0QXR0YWNobWVudC5Qcm9wb3NlZFNlZ21lbnRDaGFuZ2VQcm9wZXJ0eSJ9XX19")), "proposedSegmentChange") unless value.nil?
  jsii_set_property("proposedSegmentChange", 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) 


158
159
160
 
# File 'network_manager/cfn_connect_attachment.rb', line 158

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:



668
669
670
671
 
# File 'network_manager/cfn_connect_attachment.rb', line 668

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


675
676
677
678
 
# File 'network_manager/cfn_connect_attachment.rb', line 675

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:



685
686
687
688
689
 
# File 'network_manager/cfn_connect_attachment.rb', line 685

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

#routing_policy_label ⇒ String?

Routing policy label.

Returns:

  • (String, nil) 


401
402
403
 
# File 'network_manager/cfn_connect_attachment.rb', line 401

def routing_policy_label()
  jsii_get_property("routingPolicyLabel")
end

#routing_policy_label=(value) ⇒ Object 



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

def routing_policy_label=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routingPolicyLabel") unless value.nil?
  jsii_set_property("routingPolicyLabel", value)
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.



694
695
696
 
# File 'network_manager/cfn_connect_attachment.rb', line 694

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:



148
149
150
 
# File 'network_manager/cfn_connect_attachment.rb', line 148

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



307
308
309
 
# File 'network_manager/cfn_connect_attachment.rb', line 307

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags associated with the Connect attachment.

Returns:



413
414
415
 
# File 'network_manager/cfn_connect_attachment.rb', line 413

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



426
427
428
 
# File 'network_manager/cfn_connect_attachment.rb', line 426

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

#transport_attachment_id ⇒ String

The ID of the transport attachment.

Returns:

  • (String) 


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

def transport_attachment_id()
  jsii_get_property("transportAttachmentId")
end

#transport_attachment_id=(value) ⇒ Object 



355
356
357
358
 
# File 'network_manager/cfn_connect_attachment.rb', line 355

def transport_attachment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transportAttachmentId")
  jsii_set_property("transportAttachmentId", value)
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}) 


195
196
197
 
# File 'network_manager/cfn_connect_attachment.rb', line 195

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


205
206
207
 
# File 'network_manager/cfn_connect_attachment.rb', line 205

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


700
701
702
703
 
# File 'network_manager/cfn_connect_attachment.rb', line 700

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) 


439
440
441
442
443
444
 
# File 'network_manager/cfn_connect_attachment.rb', line 439

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