class CfnConnectAttachment (construct)

Language	Type name
.NET	Amazon.CDK.AWS.NetworkManager.CfnConnectAttachment
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsnetworkmanager#CfnConnectAttachment
Java	software.amazon.awscdk.services.networkmanager.CfnConnectAttachment
Python	aws_cdk.aws_networkmanager.CfnConnectAttachment
TypeScript	aws-cdk-lib » aws_networkmanager » CfnConnectAttachment

Implements IConstruct, IDependable, IInspectable, ITaggable

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_networkmanager as networkmanager } from 'aws-cdk-lib';
const cfnConnectAttachment = new networkmanager.CfnConnectAttachment(this, 'MyCfnConnectAttachment', {
  coreNetworkId: 'coreNetworkId',
  edgeLocation: 'edgeLocation',
  options: {
    protocol: 'protocol',
  },
  transportAttachmentId: 'transportAttachmentId',

  // the properties below are optional
  networkFunctionGroupName: 'networkFunctionGroupName',
  proposedNetworkFunctionGroupChange: {
    attachmentPolicyRuleNumber: 123,
    networkFunctionGroupName: 'networkFunctionGroupName',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  },
  proposedSegmentChange: {
    attachmentPolicyRuleNumber: 123,
    segmentName: 'segmentName',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnConnectAttachment(scope: Construct, id: string, props: CfnConnectAttachmentProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnConnectAttachmentProps — Resource properties.

Construct Props

Name	Type	Description
coreNetworkId	string	The ID of the core network where the Connect attachment is located.
edgeLocation	string	The Region where the edge is located.
options	IResolvable | ConnectAttachmentOptionsProperty	Options for connecting an attachment.
transportAttachmentId	string	The ID of the transport attachment.
networkFunctionGroupName?	string	The name of the network function group.
proposedNetworkFunctionGroupChange?	IResolvable | ProposedNetworkFunctionGroupChangeProperty	Describes proposed changes to a network function group.
proposedSegmentChange?	IResolvable | ProposedSegmentChangeProperty	Describes a proposed segment change.
tags?	CfnTag[]	The tags associated with the Connect attachment.

---

coreNetworkId

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-corenetworkid

---

edgeLocation

Type: string

The Region where the edge is located.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-edgelocation

---

options

Type: IResolvable | ConnectAttachmentOptionsProperty

Options for connecting an attachment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-options

---

transportAttachmentId

Type: string

The ID of the transport attachment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-transportattachmentid

---

networkFunctionGroupName?

Type: string (optional)

The name of the network function group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-networkfunctiongroupname

---

proposedNetworkFunctionGroupChange?

Type: IResolvable | ProposedNetworkFunctionGroupChangeProperty (optional)

Describes proposed changes to a network function group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-proposednetworkfunctiongroupchange

---

proposedSegmentChange?

Type: IResolvable | ProposedSegmentChangeProperty (optional)

Describes a proposed segment change.

In some cases, the segment change must first be evaluated and accepted.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-proposedsegmentchange

---

tags?

Type: CfnTag[] (optional)

The tags associated with the Connect attachment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-tags

Properties

Name	Type	Description
attrAttachmentId	string	The ID of the Connect attachment.
attrAttachmentPolicyRuleNumber	number	The rule number associated with the attachment.
attrAttachmentType	string	The type of attachment.
attrCoreNetworkArn	string	The ARN of the core network.
attrCreatedAt	string	The timestamp when the Connect attachment was created.
attrOwnerAccountId	string	The ID of the Connect attachment owner.
attrResourceArn	string	The resource ARN for the Connect attachment.
attrSegmentName	string	The name of the Connect attachment's segment.
attrState	string	The state of the Connect attachment.
attrUpdatedAt	string	The timestamp when the Connect attachment was last updated.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
coreNetworkId	string	The ID of the core network where the Connect attachment is located.
creationStack	string[]
edgeLocation	string	The Region where the edge is located.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
options	IResolvable | ConnectAttachmentOptionsProperty	Options for connecting an attachment.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
transportAttachmentId	string	The ID of the transport attachment.
networkFunctionGroupName?	string	The name of the network function group.
proposedNetworkFunctionGroupChange?	IResolvable | ProposedNetworkFunctionGroupChangeProperty	Describes proposed changes to a network function group.
proposedSegmentChange?	IResolvable | ProposedSegmentChangeProperty	Describes a proposed segment change.
tagsRaw?	CfnTag[]	The tags associated with the Connect attachment.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrAttachmentId

Type: string

The ID of the Connect attachment.

---

attrAttachmentPolicyRuleNumber

Type: number

The rule number associated with the attachment.

---

attrAttachmentType

Type: string

The type of attachment.

This will be CONNECT .

---

attrCoreNetworkArn

Type: string

The ARN of the core network.

---

attrCreatedAt

Type: string

The timestamp when the Connect attachment was created.

---

attrOwnerAccountId

Type: string

The ID of the Connect attachment owner.

---

attrResourceArn

Type: string

The resource ARN for the Connect attachment.

---

attrSegmentName

Type: string

The name of the Connect attachment's segment.

---

attrState

Type: 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 .

---

attrUpdatedAt

Type: string

The timestamp when the Connect attachment was last updated.

---

cfnOptions

Type: ICfnResourceOptions

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

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

coreNetworkId

Type: string

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

---

creationStack

Type: string[]

---

edgeLocation

Type: string

The Region where the edge is located.

---

logicalId

Type: 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 overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

options

Type: IResolvable | ConnectAttachmentOptionsProperty

Options for connecting an attachment.

---

ref

Type: 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 }).

---

stack

Type: Stack

The stack in which this element is defined.

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

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

transportAttachmentId

Type: string

The ID of the transport attachment.

---

networkFunctionGroupName?

Type: string (optional)

The name of the network function group.

---

proposedNetworkFunctionGroupChange?

Type: IResolvable | ProposedNetworkFunctionGroupChangeProperty (optional)

Describes proposed changes to a network function group.

---

proposedSegmentChange?

Type: IResolvable | ProposedSegmentChangeProperty (optional)

Describes a proposed segment change.

---

tagsRaw?

Type: CfnTag[] (optional)

The tags associated with the Connect attachment.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

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.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

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

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

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

The value argument to addOverride 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.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

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

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

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

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

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:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• 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.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

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

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

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

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

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

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

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.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }