Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. StreamAttachment
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
equinix/pulumi-equinix

equinix.fabric.StreamAttachment

Explore with Pulumi AI

equinix logo
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible resource allows creation and management of Equinix Fabric Stream Attachments

    Additional Documentation:

    • Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
    • API: https://developer.equinix.com/catalog/fabricv4#tag/Streams

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";

const asset = new equinix.fabric.StreamAttachment("asset", {
    asset: "<asset_group>",
    assetId: "<id_of_the_asset_being_attached>",
    streamId: "<id_of_the_stream_asset_is_being_attached_to>",
});

    import pulumi
import pulumi_equinix as equinix

asset = equinix.fabric.StreamAttachment("asset",
    asset="<asset_group>",
    asset_id="<id_of_the_asset_being_attached>",
    stream_id="<id_of_the_stream_asset_is_being_attached_to>")

    package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fabric.NewStreamAttachment(ctx, "asset", &fabric.StreamAttachmentArgs{
			Asset:    pulumi.String("<asset_group>"),
			AssetId:  pulumi.String("<id_of_the_asset_being_attached>"),
			StreamId: pulumi.String("<id_of_the_stream_asset_is_being_attached_to>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var asset = new Equinix.Fabric.StreamAttachment("asset", new()
    {
        Asset = "<asset_group>",
        AssetId = "<id_of_the_asset_being_attached>",
        StreamId = "<id_of_the_stream_asset_is_being_attached_to>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.StreamAttachment;
import com.pulumi.equinix.fabric.StreamAttachmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var asset = new StreamAttachment("asset", StreamAttachmentArgs.builder()
            .asset("<asset_group>")
            .assetId("<id_of_the_asset_being_attached>")
            .streamId("<id_of_the_stream_asset_is_being_attached_to>")
            .build());

    }
}

    resources:
  asset:
    type: equinix:fabric:StreamAttachment
    properties:
      asset: <asset_group>
      assetId: <id_of_the_asset_being_attached>
      streamId: <id_of_the_stream_asset_is_being_attached_to>

    Create StreamAttachment Resource

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

    Constructor syntax

    new StreamAttachment(name: string, args: StreamAttachmentArgs, opts?: CustomResourceOptions);
    @overload
def StreamAttachment(resource_name: str,
                     args: StreamAttachmentArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def StreamAttachment(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     asset: Optional[str] = None,
                     asset_id: Optional[str] = None,
                     stream_id: Optional[str] = None,
                     metrics_enabled: Optional[bool] = None,
                     timeouts: Optional[StreamAttachmentTimeoutsArgs] = None)
    func NewStreamAttachment(ctx *Context, name string, args StreamAttachmentArgs, opts ...ResourceOption) (*StreamAttachment, error)
    public StreamAttachment(string name, StreamAttachmentArgs args, CustomResourceOptions? opts = null)
    public StreamAttachment(String name, StreamAttachmentArgs args)
public StreamAttachment(String name, StreamAttachmentArgs args, CustomResourceOptions options)

    type: equinix:fabric:StreamAttachment
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 StreamAttachmentArgs
    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 StreamAttachmentArgs
    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 StreamAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamAttachmentArgs
    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 streamAttachmentResource = new Equinix.Fabric.StreamAttachment("streamAttachmentResource", new()
{
    Asset = "string",
    AssetId = "string",
    StreamId = "string",
    MetricsEnabled = false,
    Timeouts = new Equinix.Fabric.Inputs.StreamAttachmentTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := fabric.NewStreamAttachment(ctx, "streamAttachmentResource", &fabric.StreamAttachmentArgs{
	Asset:          pulumi.String("string"),
	AssetId:        pulumi.String("string"),
	StreamId:       pulumi.String("string"),
	MetricsEnabled: pulumi.Bool(false),
	Timeouts: &fabric.StreamAttachmentTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var streamAttachmentResource = new StreamAttachment("streamAttachmentResource", StreamAttachmentArgs.builder()
    .asset("string")
    .assetId("string")
    .streamId("string")
    .metricsEnabled(false)
    .timeouts(StreamAttachmentTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    stream_attachment_resource = equinix.fabric.StreamAttachment("streamAttachmentResource",
    asset="string",
    asset_id="string",
    stream_id="string",
    metrics_enabled=False,
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const streamAttachmentResource = new equinix.fabric.StreamAttachment("streamAttachmentResource", {
    asset: "string",
    assetId: "string",
    streamId: "string",
    metricsEnabled: false,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: equinix:fabric:StreamAttachment
properties:
    asset: string
    assetId: string
    metricsEnabled: false
    streamId: string
    timeouts:
        create: string
        delete: string
        read: string
        update: string

    StreamAttachment 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 StreamAttachment resource accepts the following input properties:

    Asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    AssetId string
    Equinix defined UUID of the asset being attached to the stream
    StreamId string
    UUID of the stream that is the target of this asset attachment
    MetricsEnabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    Timeouts StreamAttachmentTimeouts
    Asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    AssetId string
    Equinix defined UUID of the asset being attached to the stream
    StreamId string
    UUID of the stream that is the target of this asset attachment
    MetricsEnabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    Timeouts StreamAttachmentTimeoutsArgs
    asset String
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId String
    Equinix defined UUID of the asset being attached to the stream
    streamId String
    UUID of the stream that is the target of this asset attachment
    metricsEnabled Boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    timeouts StreamAttachmentTimeouts
    asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId string
    Equinix defined UUID of the asset being attached to the stream
    streamId string
    UUID of the stream that is the target of this asset attachment
    metricsEnabled boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    timeouts StreamAttachmentTimeouts
    asset str
    Equinix defined asset category. Matches the product name the asset is a part of
    asset_id str
    Equinix defined UUID of the asset being attached to the stream
    stream_id str
    UUID of the stream that is the target of this asset attachment
    metrics_enabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    timeouts StreamAttachmentTimeoutsArgs
    asset String
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId String
    Equinix defined UUID of the asset being attached to the stream
    streamId String
    UUID of the stream that is the target of this asset attachment
    metricsEnabled Boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    timeouts Property Map

    Outputs

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

    AttachmentStatus string
    Value representing status for the stream attachment
    Href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Equinix defined type for the asset stream attachment
    Uuid string
    Equinix-assigned unique id for the stream attachment
    AttachmentStatus string
    Value representing status for the stream attachment
    Href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Equinix defined type for the asset stream attachment
    Uuid string
    Equinix-assigned unique id for the stream attachment
    attachmentStatus String
    Value representing status for the stream attachment
    href String
    Equinix auto generated URI to the stream attachment in Equinix Portal
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Equinix defined type for the asset stream attachment
    uuid String
    Equinix-assigned unique id for the stream attachment
    attachmentStatus string
    Value representing status for the stream attachment
    href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Equinix defined type for the asset stream attachment
    uuid string
    Equinix-assigned unique id for the stream attachment
    attachment_status str
    Value representing status for the stream attachment
    href str
    Equinix auto generated URI to the stream attachment in Equinix Portal
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Equinix defined type for the asset stream attachment
    uuid str
    Equinix-assigned unique id for the stream attachment
    attachmentStatus String
    Value representing status for the stream attachment
    href String
    Equinix auto generated URI to the stream attachment in Equinix Portal
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Equinix defined type for the asset stream attachment
    uuid String
    Equinix-assigned unique id for the stream attachment

    Look up Existing StreamAttachment Resource

    Get an existing StreamAttachment 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?: StreamAttachmentState, opts?: CustomResourceOptions): StreamAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asset: Optional[str] = None,
        asset_id: Optional[str] = None,
        attachment_status: Optional[str] = None,
        href: Optional[str] = None,
        metrics_enabled: Optional[bool] = None,
        stream_id: Optional[str] = None,
        timeouts: Optional[StreamAttachmentTimeoutsArgs] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> StreamAttachment
    func GetStreamAttachment(ctx *Context, name string, id IDInput, state *StreamAttachmentState, opts ...ResourceOption) (*StreamAttachment, error)
    public static StreamAttachment Get(string name, Input<string> id, StreamAttachmentState? state, CustomResourceOptions? opts = null)
    public static StreamAttachment get(String name, Output<String> id, StreamAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: equinix:fabric:StreamAttachment    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:
    Asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    AssetId string
    Equinix defined UUID of the asset being attached to the stream
    AttachmentStatus string
    Value representing status for the stream attachment
    Href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    MetricsEnabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    StreamId string
    UUID of the stream that is the target of this asset attachment
    Timeouts StreamAttachmentTimeouts
    Type string
    Equinix defined type for the asset stream attachment
    Uuid string
    Equinix-assigned unique id for the stream attachment
    Asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    AssetId string
    Equinix defined UUID of the asset being attached to the stream
    AttachmentStatus string
    Value representing status for the stream attachment
    Href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    MetricsEnabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    StreamId string
    UUID of the stream that is the target of this asset attachment
    Timeouts StreamAttachmentTimeoutsArgs
    Type string
    Equinix defined type for the asset stream attachment
    Uuid string
    Equinix-assigned unique id for the stream attachment
    asset String
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId String
    Equinix defined UUID of the asset being attached to the stream
    attachmentStatus String
    Value representing status for the stream attachment
    href String
    Equinix auto generated URI to the stream attachment in Equinix Portal
    metricsEnabled Boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    streamId String
    UUID of the stream that is the target of this asset attachment
    timeouts StreamAttachmentTimeouts
    type String
    Equinix defined type for the asset stream attachment
    uuid String
    Equinix-assigned unique id for the stream attachment
    asset string
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId string
    Equinix defined UUID of the asset being attached to the stream
    attachmentStatus string
    Value representing status for the stream attachment
    href string
    Equinix auto generated URI to the stream attachment in Equinix Portal
    metricsEnabled boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    streamId string
    UUID of the stream that is the target of this asset attachment
    timeouts StreamAttachmentTimeouts
    type string
    Equinix defined type for the asset stream attachment
    uuid string
    Equinix-assigned unique id for the stream attachment
    asset str
    Equinix defined asset category. Matches the product name the asset is a part of
    asset_id str
    Equinix defined UUID of the asset being attached to the stream
    attachment_status str
    Value representing status for the stream attachment
    href str
    Equinix auto generated URI to the stream attachment in Equinix Portal
    metrics_enabled bool
    Boolean value indicating enablement of metrics for this asset stream attachment
    stream_id str
    UUID of the stream that is the target of this asset attachment
    timeouts StreamAttachmentTimeoutsArgs
    type str
    Equinix defined type for the asset stream attachment
    uuid str
    Equinix-assigned unique id for the stream attachment
    asset String
    Equinix defined asset category. Matches the product name the asset is a part of
    assetId String
    Equinix defined UUID of the asset being attached to the stream
    attachmentStatus String
    Value representing status for the stream attachment
    href String
    Equinix auto generated URI to the stream attachment in Equinix Portal
    metricsEnabled Boolean
    Boolean value indicating enablement of metrics for this asset stream attachment
    streamId String
    UUID of the stream that is the target of this asset attachment
    timeouts Property Map
    type String
    Equinix defined type for the asset stream attachment
    uuid String
    Equinix-assigned unique id for the stream attachment

    Supporting Types

    StreamAttachmentTimeouts, StreamAttachmentTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix
    equinix/pulumi-equinix