1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. ConnectAttachment
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Resource for managing an AWS NetworkManager ConnectAttachment.

    Create ConnectAttachment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConnectAttachment(name: string, args: ConnectAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectAttachment(resource_name: str,
                          args: ConnectAttachmentArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectAttachment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          core_network_id: Optional[str] = None,
                          edge_location: Optional[str] = None,
                          options: Optional[ConnectAttachmentOptionsArgs] = None,
                          transport_attachment_id: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewConnectAttachment(ctx *Context, name string, args ConnectAttachmentArgs, opts ...ResourceOption) (*ConnectAttachment, error)
    public ConnectAttachment(string name, ConnectAttachmentArgs args, CustomResourceOptions? opts = null)
    public ConnectAttachment(String name, ConnectAttachmentArgs args)
    public ConnectAttachment(String name, ConnectAttachmentArgs args, CustomResourceOptions options)
    
    type: aws:networkmanager:ConnectAttachment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConnectAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectAttachmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var connectAttachmentResource = new Aws.NetworkManager.ConnectAttachment("connectAttachmentResource", new()
    {
        CoreNetworkId = "string",
        EdgeLocation = "string",
        Options = new Aws.NetworkManager.Inputs.ConnectAttachmentOptionsArgs
        {
            Protocol = "string",
        },
        TransportAttachmentId = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := networkmanager.NewConnectAttachment(ctx, "connectAttachmentResource", &networkmanager.ConnectAttachmentArgs{
    	CoreNetworkId: pulumi.String("string"),
    	EdgeLocation:  pulumi.String("string"),
    	Options: &networkmanager.ConnectAttachmentOptionsArgs{
    		Protocol: pulumi.String("string"),
    	},
    	TransportAttachmentId: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var connectAttachmentResource = new ConnectAttachment("connectAttachmentResource", ConnectAttachmentArgs.builder()
        .coreNetworkId("string")
        .edgeLocation("string")
        .options(ConnectAttachmentOptionsArgs.builder()
            .protocol("string")
            .build())
        .transportAttachmentId("string")
        .tags(Map.of("string", "string"))
        .build());
    
    connect_attachment_resource = aws.networkmanager.ConnectAttachment("connectAttachmentResource",
        core_network_id="string",
        edge_location="string",
        options={
            "protocol": "string",
        },
        transport_attachment_id="string",
        tags={
            "string": "string",
        })
    
    const connectAttachmentResource = new aws.networkmanager.ConnectAttachment("connectAttachmentResource", {
        coreNetworkId: "string",
        edgeLocation: "string",
        options: {
            protocol: "string",
        },
        transportAttachmentId: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:networkmanager:ConnectAttachment
    properties:
        coreNetworkId: string
        edgeLocation: string
        options:
            protocol: string
        tags:
            string: string
        transportAttachmentId: string
    

    ConnectAttachment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ConnectAttachment resource accepts the following input properties:

    CoreNetworkId string
    The ID of a core network where you want to create the attachment.
    EdgeLocation string
    The Region where the edge is located.
    Options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    TransportAttachmentId string
    The ID of the attachment between the two connections.
    Tags Dictionary<string, string>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CoreNetworkId string
    The ID of a core network where you want to create the attachment.
    EdgeLocation string
    The Region where the edge is located.
    Options ConnectAttachmentOptionsArgs

    Options for creating an attachment.

    The following arguments are optional:

    TransportAttachmentId string
    The ID of the attachment between the two connections.
    Tags map[string]string
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId String
    The ID of a core network where you want to create the attachment.
    edgeLocation String
    The Region where the edge is located.
    options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    transportAttachmentId String
    The ID of the attachment between the two connections.
    tags Map<String,String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId string
    The ID of a core network where you want to create the attachment.
    edgeLocation string
    The Region where the edge is located.
    options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    transportAttachmentId string
    The ID of the attachment between the two connections.
    tags {[key: string]: string}
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    core_network_id str
    The ID of a core network where you want to create the attachment.
    edge_location str
    The Region where the edge is located.
    options ConnectAttachmentOptionsArgs

    Options for creating an attachment.

    The following arguments are optional:

    transport_attachment_id str
    The ID of the attachment between the two connections.
    tags Mapping[str, str]
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId String
    The ID of a core network where you want to create the attachment.
    edgeLocation String
    The Region where the edge is located.
    options Property Map

    Options for creating an attachment.

    The following arguments are optional:

    transportAttachmentId String
    The ID of the attachment between the two connections.
    tags Map<String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectAttachment resource produces the following output properties:

    Arn string
    The ARN of the attachment.
    AttachmentId string
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    The ARN of the attachment.
    AttachmentId string
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the attachment.
    attachmentId String
    attachmentPolicyRuleNumber Integer
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    The ARN of the attachment.
    attachmentId string
    attachmentPolicyRuleNumber number
    The policy rule number associated with the attachment.
    attachmentType string
    The type of attachment.
    coreNetworkArn string
    The ARN of a core network.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    The ID of the attachment account owner.
    resourceArn string
    The attachment resource ARN.
    segmentName string
    The name of the segment attachment.
    state string
    The state of the attachment.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    The ARN of the attachment.
    attachment_id str
    attachment_policy_rule_number int
    The policy rule number associated with the attachment.
    attachment_type str
    The type of attachment.
    core_network_arn str
    The ARN of a core network.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    The ID of the attachment account owner.
    resource_arn str
    The attachment resource ARN.
    segment_name str
    The name of the segment attachment.
    state str
    The state of the attachment.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the attachment.
    attachmentId String
    attachmentPolicyRuleNumber Number
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing ConnectAttachment Resource

    Get an existing ConnectAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConnectAttachmentState, opts?: CustomResourceOptions): ConnectAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            attachment_id: Optional[str] = None,
            attachment_policy_rule_number: Optional[int] = None,
            attachment_type: Optional[str] = None,
            core_network_arn: Optional[str] = None,
            core_network_id: Optional[str] = None,
            edge_location: Optional[str] = None,
            options: Optional[ConnectAttachmentOptionsArgs] = None,
            owner_account_id: Optional[str] = None,
            resource_arn: Optional[str] = None,
            segment_name: Optional[str] = None,
            state: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            transport_attachment_id: Optional[str] = None) -> ConnectAttachment
    func GetConnectAttachment(ctx *Context, name string, id IDInput, state *ConnectAttachmentState, opts ...ResourceOption) (*ConnectAttachment, error)
    public static ConnectAttachment Get(string name, Input<string> id, ConnectAttachmentState? state, CustomResourceOptions? opts = null)
    public static ConnectAttachment get(String name, Output<String> id, ConnectAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: aws:networkmanager:ConnectAttachment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the attachment.
    AttachmentId string
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    CoreNetworkId string
    The ID of a core network where you want to create the attachment.
    EdgeLocation string
    The Region where the edge is located.
    Options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    Tags Dictionary<string, string>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TransportAttachmentId string
    The ID of the attachment between the two connections.
    Arn string
    The ARN of the attachment.
    AttachmentId string
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    CoreNetworkId string
    The ID of a core network where you want to create the attachment.
    EdgeLocation string
    The Region where the edge is located.
    Options ConnectAttachmentOptionsArgs

    Options for creating an attachment.

    The following arguments are optional:

    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    Tags map[string]string
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TransportAttachmentId string
    The ID of the attachment between the two connections.
    arn String
    The ARN of the attachment.
    attachmentId String
    attachmentPolicyRuleNumber Integer
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    coreNetworkId String
    The ID of a core network where you want to create the attachment.
    edgeLocation String
    The Region where the edge is located.
    options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tags Map<String,String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    transportAttachmentId String
    The ID of the attachment between the two connections.
    arn string
    The ARN of the attachment.
    attachmentId string
    attachmentPolicyRuleNumber number
    The policy rule number associated with the attachment.
    attachmentType string
    The type of attachment.
    coreNetworkArn string
    The ARN of a core network.
    coreNetworkId string
    The ID of a core network where you want to create the attachment.
    edgeLocation string
    The Region where the edge is located.
    options ConnectAttachmentOptions

    Options for creating an attachment.

    The following arguments are optional:

    ownerAccountId string
    The ID of the attachment account owner.
    resourceArn string
    The attachment resource ARN.
    segmentName string
    The name of the segment attachment.
    state string
    The state of the attachment.
    tags {[key: string]: string}
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    transportAttachmentId string
    The ID of the attachment between the two connections.
    arn str
    The ARN of the attachment.
    attachment_id str
    attachment_policy_rule_number int
    The policy rule number associated with the attachment.
    attachment_type str
    The type of attachment.
    core_network_arn str
    The ARN of a core network.
    core_network_id str
    The ID of a core network where you want to create the attachment.
    edge_location str
    The Region where the edge is located.
    options ConnectAttachmentOptionsArgs

    Options for creating an attachment.

    The following arguments are optional:

    owner_account_id str
    The ID of the attachment account owner.
    resource_arn str
    The attachment resource ARN.
    segment_name str
    The name of the segment attachment.
    state str
    The state of the attachment.
    tags Mapping[str, str]
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    transport_attachment_id str
    The ID of the attachment between the two connections.
    arn String
    The ARN of the attachment.
    attachmentId String
    attachmentPolicyRuleNumber Number
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    coreNetworkId String
    The ID of a core network where you want to create the attachment.
    edgeLocation String
    The Region where the edge is located.
    options Property Map

    Options for creating an attachment.

    The following arguments are optional:

    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tags Map<String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    transportAttachmentId String
    The ID of the attachment between the two connections.

    Supporting Types

    ConnectAttachmentOptions, ConnectAttachmentOptionsArgs

    Protocol string
    Protocol string
    protocol String
    protocol string
    protocol String

    Import

    aws_networkmanager_connect_attachment can be imported using the attachment ID, e.g.

     $ pulumi import aws:networkmanager/connectAttachment:ConnectAttachment example attachment-0f8fa60d2238d1bd8
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.