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

equinix.fabric.StreamSubscription

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 Subscriptions

    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/Stream-Subscriptions

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.StreamSubscription;
import com.pulumi.equinix.fabric.StreamSubscriptionArgs;
import com.pulumi.equinix.fabric.inputs.StreamSubscriptionEventSelectorArgs;
import com.pulumi.equinix.fabric.inputs.StreamSubscriptionMetricSelectorArgs;
import com.pulumi.equinix.fabric.inputs.StreamSubscriptionSinkArgs;
import com.pulumi.equinix.fabric.inputs.StreamSubscriptionSinkCredentialArgs;
import com.pulumi.equinix.fabric.inputs.StreamSubscriptionSinkSettingsArgs;
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 sPLUNK = new StreamSubscription("sPLUNK", StreamSubscriptionArgs.builder()
            .description("<description>")
            .enabled(true)
            .eventSelector(StreamSubscriptionEventSelectorArgs.builder()
                .include("equinix.fabric.connection.*")
                .build())
            .metricSelector(StreamSubscriptionMetricSelectorArgs.builder()
                .include("equinix.fabric.connection.*")
                .build())
            .sink(StreamSubscriptionSinkArgs.builder()
                .credential(StreamSubscriptionSinkCredentialArgs.builder()
                    .accessToken("<splunk_access_token>")
                    .type("ACCESS_TOKEN")
                    .build())
                .settings(StreamSubscriptionSinkSettingsArgs.builder()
                    .eventIndex("<splunk_event_index>")
                    .metricIndex("<splunk_metric_index>")
                    .source("<splunk_source>")
                    .build())
                .type("SPLUNK_HEC")
                .uri("<splunk_uri>")
                .build())
            .streamId("<stream_id>")
            .type("STREAM_SUBSCRIPTION")
            .build());

        var sLACK = new StreamSubscription("sLACK", StreamSubscriptionArgs.builder()
            .description("<description>")
            .enabled(true)
            .sink(StreamSubscriptionSinkArgs.builder()
                .type("SLACK")
                .uri("<slack_uri>")
                .build())
            .streamId("<stream_id>")
            .type("STREAM_SUBSCRIPTION")
            .build());

        var pAGERDUTY = new StreamSubscription("pAGERDUTY", StreamSubscriptionArgs.builder()
            .description("<description>")
            .enabled(true)
            .sink(StreamSubscriptionSinkArgs.builder()
                .credential(StreamSubscriptionSinkCredentialArgs.builder()
                    .integrationKey("<pager_duty_integration_key>")
                    .type("INTEGRATION_KEY")
                    .build())
                .host("<pager_duty_host")
                .settings(StreamSubscriptionSinkSettingsArgs.builder()
                    .alertUri("<pager_duty_alert_uri>")
                    .changeUri("<pager_duty_change_uri>")
                    .build())
                .type("PAGERDUTY")
                .build())
            .streamId("<stream_id>")
            .type("STREAM_SUBSCRIPTION")
            .build());

        var dATADOG = new StreamSubscription("dATADOG", StreamSubscriptionArgs.builder()
            .description("<description>")
            .enabled(true)
            .sink(StreamSubscriptionSinkArgs.builder()
                .credential(StreamSubscriptionSinkCredentialArgs.builder()
                    .apiKey("<datadog_api_key>")
                    .type("API_KEY")
                    .build())
                .host("<datadog_host>")
                .settings(StreamSubscriptionSinkSettingsArgs.builder()
                    .applicationKey("<datadog_application_key>")
                    .eventUri("<datadog_event_uri>")
                    .metricUri("<datadog_metric_uri>")
                    .source("Equinix")
                    .build())
                .type("DATADOG")
                .build())
            .streamId("<stream_id>")
            .type("STREAM_SUBSCRIPTION")
            .build());

        var mSTEAMS = new StreamSubscription("mSTEAMS", StreamSubscriptionArgs.builder()
            .description("<description>")
            .enabled(true)
            .sink(StreamSubscriptionSinkArgs.builder()
                .type("TEAMS")
                .uri("<msteams_uri>")
                .build())
            .streamId("<stream_id>")
            .type("STREAM_SUBSCRIPTION")
            .build());

    }
}

    resources:
  sPLUNK:
    type: equinix:fabric:StreamSubscription
    properties:
      description: <description>
      enabled: true
      eventSelector:
        include:
          - equinix.fabric.connection.*
      metricSelector:
        include:
          - equinix.fabric.connection.*
      sink:
        credential:
          accessToken: <splunk_access_token>
          type: ACCESS_TOKEN
        settings:
          eventIndex: <splunk_event_index>
          metricIndex: <splunk_metric_index>
          source: <splunk_source>
        type: SPLUNK_HEC
        uri: <splunk_uri>
      streamId: <stream_id>
      type: STREAM_SUBSCRIPTION
  sLACK:
    type: equinix:fabric:StreamSubscription
    properties:
      description: <description>
      enabled: true
      sink:
        type: SLACK
        uri: <slack_uri>
      streamId: <stream_id>
      type: STREAM_SUBSCRIPTION
  pAGERDUTY:
    type: equinix:fabric:StreamSubscription
    properties:
      description: <description>
      enabled: true
      sink:
        credential:
          integrationKey: <pager_duty_integration_key>
          type: INTEGRATION_KEY
        host: <pager_duty_host
        settings:
          alertUri: <pager_duty_alert_uri>
          changeUri: <pager_duty_change_uri>
        type: PAGERDUTY
      streamId: <stream_id>
      type: STREAM_SUBSCRIPTION
  dATADOG:
    type: equinix:fabric:StreamSubscription
    properties:
      description: <description>
      enabled: true
      sink:
        credential:
          apiKey: <datadog_api_key>
          type: API_KEY
        host: <datadog_host>
        settings:
          applicationKey: <datadog_application_key>
          eventUri: <datadog_event_uri>
          metricUri: <datadog_metric_uri>
          source: Equinix
        type: DATADOG
      streamId: <stream_id>
      type: STREAM_SUBSCRIPTION
  mSTEAMS:
    type: equinix:fabric:StreamSubscription
    properties:
      description: <description>
      enabled: true
      sink:
        type: TEAMS
        uri: <msteams_uri>
      streamId: <stream_id>
      type: STREAM_SUBSCRIPTION

    Create StreamSubscription Resource

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

    Constructor syntax

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

@overload
def StreamSubscription(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       sink: Optional[StreamSubscriptionSinkArgs] = None,
                       stream_id: Optional[str] = None,
                       type: Optional[str] = None,
                       event_selector: Optional[StreamSubscriptionEventSelectorArgs] = None,
                       metric_selector: Optional[StreamSubscriptionMetricSelectorArgs] = None,
                       name: Optional[str] = None,
                       timeouts: Optional[StreamSubscriptionTimeoutsArgs] = None)
    func NewStreamSubscription(ctx *Context, name string, args StreamSubscriptionArgs, opts ...ResourceOption) (*StreamSubscription, error)
    public StreamSubscription(string name, StreamSubscriptionArgs args, CustomResourceOptions? opts = null)
    public StreamSubscription(String name, StreamSubscriptionArgs args)
public StreamSubscription(String name, StreamSubscriptionArgs args, CustomResourceOptions options)

    type: equinix:fabric:StreamSubscription
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 StreamSubscriptionArgs
    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 StreamSubscriptionArgs
    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 StreamSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamSubscriptionArgs
    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 streamSubscriptionResource = new Equinix.Fabric.StreamSubscription("streamSubscriptionResource", new()
{
    Description = "string",
    Enabled = false,
    Sink = new Equinix.Fabric.Inputs.StreamSubscriptionSinkArgs
    {
        Type = "string",
        BatchEnabled = false,
        BatchSizeMax = 0,
        BatchWaitTimeMax = 0,
        Credential = new Equinix.Fabric.Inputs.StreamSubscriptionSinkCredentialArgs
        {
            Type = "string",
            AccessToken = "string",
            ApiKey = "string",
            IntegrationKey = "string",
            Password = "string",
            Username = "string",
        },
        Host = "string",
        Settings = new Equinix.Fabric.Inputs.StreamSubscriptionSinkSettingsArgs
        {
            ApplicationKey = "string",
            EventIndex = "string",
            EventUri = "string",
            MetricIndex = "string",
            MetricUri = "string",
            Source = "string",
        },
        Uri = "string",
    },
    StreamId = "string",
    Type = "string",
    EventSelector = new Equinix.Fabric.Inputs.StreamSubscriptionEventSelectorArgs
    {
        Includes = new[]
        {
            "string",
        },
        Excepts = new[]
        {
            "string",
        },
    },
    MetricSelector = new Equinix.Fabric.Inputs.StreamSubscriptionMetricSelectorArgs
    {
        Includes = new[]
        {
            "string",
        },
        Excepts = new[]
        {
            "string",
        },
    },
    Name = "string",
    Timeouts = new Equinix.Fabric.Inputs.StreamSubscriptionTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := fabric.NewStreamSubscription(ctx, "streamSubscriptionResource", &fabric.StreamSubscriptionArgs{
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Sink: &fabric.StreamSubscriptionSinkArgs{
		Type:             pulumi.String("string"),
		BatchEnabled:     pulumi.Bool(false),
		BatchSizeMax:     pulumi.Int(0),
		BatchWaitTimeMax: pulumi.Int(0),
		Credential: &fabric.StreamSubscriptionSinkCredentialArgs{
			Type:           pulumi.String("string"),
			AccessToken:    pulumi.String("string"),
			ApiKey:         pulumi.String("string"),
			IntegrationKey: pulumi.String("string"),
			Password:       pulumi.String("string"),
			Username:       pulumi.String("string"),
		},
		Host: pulumi.String("string"),
		Settings: &fabric.StreamSubscriptionSinkSettingsArgs{
			ApplicationKey: pulumi.String("string"),
			EventIndex:     pulumi.String("string"),
			EventUri:       pulumi.String("string"),
			MetricIndex:    pulumi.String("string"),
			MetricUri:      pulumi.String("string"),
			Source:         pulumi.String("string"),
		},
		Uri: pulumi.String("string"),
	},
	StreamId: pulumi.String("string"),
	Type:     pulumi.String("string"),
	EventSelector: &fabric.StreamSubscriptionEventSelectorArgs{
		Includes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Excepts: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	MetricSelector: &fabric.StreamSubscriptionMetricSelectorArgs{
		Includes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Excepts: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Timeouts: &fabric.StreamSubscriptionTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var streamSubscriptionResource = new StreamSubscription("streamSubscriptionResource", StreamSubscriptionArgs.builder()
    .description("string")
    .enabled(false)
    .sink(StreamSubscriptionSinkArgs.builder()
        .type("string")
        .batchEnabled(false)
        .batchSizeMax(0)
        .batchWaitTimeMax(0)
        .credential(StreamSubscriptionSinkCredentialArgs.builder()
            .type("string")
            .accessToken("string")
            .apiKey("string")
            .integrationKey("string")
            .password("string")
            .username("string")
            .build())
        .host("string")
        .settings(StreamSubscriptionSinkSettingsArgs.builder()
            .applicationKey("string")
            .eventIndex("string")
            .eventUri("string")
            .metricIndex("string")
            .metricUri("string")
            .source("string")
            .build())
        .uri("string")
        .build())
    .streamId("string")
    .type("string")
    .eventSelector(StreamSubscriptionEventSelectorArgs.builder()
        .includes("string")
        .excepts("string")
        .build())
    .metricSelector(StreamSubscriptionMetricSelectorArgs.builder()
        .includes("string")
        .excepts("string")
        .build())
    .name("string")
    .timeouts(StreamSubscriptionTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    stream_subscription_resource = equinix.fabric.StreamSubscription("streamSubscriptionResource",
    description="string",
    enabled=False,
    sink={
        "type": "string",
        "batch_enabled": False,
        "batch_size_max": 0,
        "batch_wait_time_max": 0,
        "credential": {
            "type": "string",
            "access_token": "string",
            "api_key": "string",
            "integration_key": "string",
            "password": "string",
            "username": "string",
        },
        "host": "string",
        "settings": {
            "application_key": "string",
            "event_index": "string",
            "event_uri": "string",
            "metric_index": "string",
            "metric_uri": "string",
            "source": "string",
        },
        "uri": "string",
    },
    stream_id="string",
    type="string",
    event_selector={
        "includes": ["string"],
        "excepts": ["string"],
    },
    metric_selector={
        "includes": ["string"],
        "excepts": ["string"],
    },
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const streamSubscriptionResource = new equinix.fabric.StreamSubscription("streamSubscriptionResource", {
    description: "string",
    enabled: false,
    sink: {
        type: "string",
        batchEnabled: false,
        batchSizeMax: 0,
        batchWaitTimeMax: 0,
        credential: {
            type: "string",
            accessToken: "string",
            apiKey: "string",
            integrationKey: "string",
            password: "string",
            username: "string",
        },
        host: "string",
        settings: {
            applicationKey: "string",
            eventIndex: "string",
            eventUri: "string",
            metricIndex: "string",
            metricUri: "string",
            source: "string",
        },
        uri: "string",
    },
    streamId: "string",
    type: "string",
    eventSelector: {
        includes: ["string"],
        excepts: ["string"],
    },
    metricSelector: {
        includes: ["string"],
        excepts: ["string"],
    },
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: equinix:fabric:StreamSubscription
properties:
    description: string
    enabled: false
    eventSelector:
        excepts:
            - string
        includes:
            - string
    metricSelector:
        excepts:
            - string
        includes:
            - string
    name: string
    sink:
        batchEnabled: false
        batchSizeMax: 0
        batchWaitTimeMax: 0
        credential:
            accessToken: string
            apiKey: string
            integrationKey: string
            password: string
            type: string
            username: string
        host: string
        settings:
            applicationKey: string
            eventIndex: string
            eventUri: string
            metricIndex: string
            metricUri: string
            source: string
        type: string
        uri: string
    streamId: string
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    type: string

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

    Description string
    Customer-provided stream subscription description
    Enabled bool
    Stream subscription enabled status
    Sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    StreamId string
    The uuid of the stream that is the target of the stream subscription
    Type string
    Type of the stream subscription request
    EventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    MetricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    Name string
    Customer-provided stream subscription name
    Timeouts StreamSubscriptionTimeouts
    Description string
    Customer-provided stream subscription description
    Enabled bool
    Stream subscription enabled status
    Sink StreamSubscriptionSinkArgs
    The details of the subscriber to the Equinix Stream
    StreamId string
    The uuid of the stream that is the target of the stream subscription
    Type string
    Type of the stream subscription request
    EventSelector StreamSubscriptionEventSelectorArgs
    Lists of events to be included/excluded on the stream subscription
    MetricSelector StreamSubscriptionMetricSelectorArgs
    Lists of metrics to be included/excluded on the stream subscription
    Name string
    Customer-provided stream subscription name
    Timeouts StreamSubscriptionTimeoutsArgs
    description String
    Customer-provided stream subscription description
    enabled Boolean
    Stream subscription enabled status
    sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    streamId String
    The uuid of the stream that is the target of the stream subscription
    type String
    Type of the stream subscription request
    eventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    metricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    name String
    Customer-provided stream subscription name
    timeouts StreamSubscriptionTimeouts
    description string
    Customer-provided stream subscription description
    enabled boolean
    Stream subscription enabled status
    sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    streamId string
    The uuid of the stream that is the target of the stream subscription
    type string
    Type of the stream subscription request
    eventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    metricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    name string
    Customer-provided stream subscription name
    timeouts StreamSubscriptionTimeouts
    description str
    Customer-provided stream subscription description
    enabled bool
    Stream subscription enabled status
    sink StreamSubscriptionSinkArgs
    The details of the subscriber to the Equinix Stream
    stream_id str
    The uuid of the stream that is the target of the stream subscription
    type str
    Type of the stream subscription request
    event_selector StreamSubscriptionEventSelectorArgs
    Lists of events to be included/excluded on the stream subscription
    metric_selector StreamSubscriptionMetricSelectorArgs
    Lists of metrics to be included/excluded on the stream subscription
    name str
    Customer-provided stream subscription name
    timeouts StreamSubscriptionTimeoutsArgs
    description String
    Customer-provided stream subscription description
    enabled Boolean
    Stream subscription enabled status
    sink Property Map
    The details of the subscriber to the Equinix Stream
    streamId String
    The uuid of the stream that is the target of the stream subscription
    type String
    Type of the stream subscription request
    eventSelector Property Map
    Lists of events to be included/excluded on the stream subscription
    metricSelector Property Map
    Lists of metrics to be included/excluded on the stream subscription
    name String
    Customer-provided stream subscription name
    timeouts Property Map

    Outputs

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

    ChangeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix assigned URI of the stream subscription resource
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Value representing provisioning status for the stream resource
    Uuid string
    Equinix assigned unique identifier of the stream subscription resource
    ChangeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    Href string
    Equinix assigned URI of the stream subscription resource
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Value representing provisioning status for the stream resource
    Uuid string
    Equinix assigned unique identifier of the stream subscription resource
    changeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    href String
    Equinix assigned URI of the stream subscription resource
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Value representing provisioning status for the stream resource
    uuid String
    Equinix assigned unique identifier of the stream subscription resource
    changeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    href string
    Equinix assigned URI of the stream subscription resource
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Value representing provisioning status for the stream resource
    uuid string
    Equinix assigned unique identifier of the stream subscription resource
    change_log StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    href str
    Equinix assigned URI of the stream subscription resource
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Value representing provisioning status for the stream resource
    uuid str
    Equinix assigned unique identifier of the stream subscription resource
    changeLog Property Map
    Details of the last change on the stream resource
    href String
    Equinix assigned URI of the stream subscription resource
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Value representing provisioning status for the stream resource
    uuid String
    Equinix assigned unique identifier of the stream subscription resource

    Look up Existing StreamSubscription Resource

    Get an existing StreamSubscription 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?: StreamSubscriptionState, opts?: CustomResourceOptions): StreamSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        change_log: Optional[StreamSubscriptionChangeLogArgs] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_selector: Optional[StreamSubscriptionEventSelectorArgs] = None,
        href: Optional[str] = None,
        metric_selector: Optional[StreamSubscriptionMetricSelectorArgs] = None,
        name: Optional[str] = None,
        sink: Optional[StreamSubscriptionSinkArgs] = None,
        state: Optional[str] = None,
        stream_id: Optional[str] = None,
        timeouts: Optional[StreamSubscriptionTimeoutsArgs] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> StreamSubscription
    func GetStreamSubscription(ctx *Context, name string, id IDInput, state *StreamSubscriptionState, opts ...ResourceOption) (*StreamSubscription, error)
    public static StreamSubscription Get(string name, Input<string> id, StreamSubscriptionState? state, CustomResourceOptions? opts = null)
    public static StreamSubscription get(String name, Output<String> id, StreamSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: equinix:fabric:StreamSubscription    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:
    ChangeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    Description string
    Customer-provided stream subscription description
    Enabled bool
    Stream subscription enabled status
    EventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    Href string
    Equinix assigned URI of the stream subscription resource
    MetricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    Name string
    Customer-provided stream subscription name
    Sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    State string
    Value representing provisioning status for the stream resource
    StreamId string
    The uuid of the stream that is the target of the stream subscription
    Timeouts StreamSubscriptionTimeouts
    Type string
    Type of the stream subscription request
    Uuid string
    Equinix assigned unique identifier of the stream subscription resource
    ChangeLog StreamSubscriptionChangeLogArgs
    Details of the last change on the stream resource
    Description string
    Customer-provided stream subscription description
    Enabled bool
    Stream subscription enabled status
    EventSelector StreamSubscriptionEventSelectorArgs
    Lists of events to be included/excluded on the stream subscription
    Href string
    Equinix assigned URI of the stream subscription resource
    MetricSelector StreamSubscriptionMetricSelectorArgs
    Lists of metrics to be included/excluded on the stream subscription
    Name string
    Customer-provided stream subscription name
    Sink StreamSubscriptionSinkArgs
    The details of the subscriber to the Equinix Stream
    State string
    Value representing provisioning status for the stream resource
    StreamId string
    The uuid of the stream that is the target of the stream subscription
    Timeouts StreamSubscriptionTimeoutsArgs
    Type string
    Type of the stream subscription request
    Uuid string
    Equinix assigned unique identifier of the stream subscription resource
    changeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    description String
    Customer-provided stream subscription description
    enabled Boolean
    Stream subscription enabled status
    eventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    href String
    Equinix assigned URI of the stream subscription resource
    metricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    name String
    Customer-provided stream subscription name
    sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    state String
    Value representing provisioning status for the stream resource
    streamId String
    The uuid of the stream that is the target of the stream subscription
    timeouts StreamSubscriptionTimeouts
    type String
    Type of the stream subscription request
    uuid String
    Equinix assigned unique identifier of the stream subscription resource
    changeLog StreamSubscriptionChangeLog
    Details of the last change on the stream resource
    description string
    Customer-provided stream subscription description
    enabled boolean
    Stream subscription enabled status
    eventSelector StreamSubscriptionEventSelector
    Lists of events to be included/excluded on the stream subscription
    href string
    Equinix assigned URI of the stream subscription resource
    metricSelector StreamSubscriptionMetricSelector
    Lists of metrics to be included/excluded on the stream subscription
    name string
    Customer-provided stream subscription name
    sink StreamSubscriptionSink
    The details of the subscriber to the Equinix Stream
    state string
    Value representing provisioning status for the stream resource
    streamId string
    The uuid of the stream that is the target of the stream subscription
    timeouts StreamSubscriptionTimeouts
    type string
    Type of the stream subscription request
    uuid string
    Equinix assigned unique identifier of the stream subscription resource
    change_log StreamSubscriptionChangeLogArgs
    Details of the last change on the stream resource
    description str
    Customer-provided stream subscription description
    enabled bool
    Stream subscription enabled status
    event_selector StreamSubscriptionEventSelectorArgs
    Lists of events to be included/excluded on the stream subscription
    href str
    Equinix assigned URI of the stream subscription resource
    metric_selector StreamSubscriptionMetricSelectorArgs
    Lists of metrics to be included/excluded on the stream subscription
    name str
    Customer-provided stream subscription name
    sink StreamSubscriptionSinkArgs
    The details of the subscriber to the Equinix Stream
    state str
    Value representing provisioning status for the stream resource
    stream_id str
    The uuid of the stream that is the target of the stream subscription
    timeouts StreamSubscriptionTimeoutsArgs
    type str
    Type of the stream subscription request
    uuid str
    Equinix assigned unique identifier of the stream subscription resource
    changeLog Property Map
    Details of the last change on the stream resource
    description String
    Customer-provided stream subscription description
    enabled Boolean
    Stream subscription enabled status
    eventSelector Property Map
    Lists of events to be included/excluded on the stream subscription
    href String
    Equinix assigned URI of the stream subscription resource
    metricSelector Property Map
    Lists of metrics to be included/excluded on the stream subscription
    name String
    Customer-provided stream subscription name
    sink Property Map
    The details of the subscriber to the Equinix Stream
    state String
    Value representing provisioning status for the stream resource
    streamId String
    The uuid of the stream that is the target of the stream subscription
    timeouts Property Map
    type String
    Type of the stream subscription request
    uuid String
    Equinix assigned unique identifier of the stream subscription resource

    Supporting Types

    StreamSubscriptionChangeLog, StreamSubscriptionChangeLogArgs

    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    Last update time of the stream resource
    createdBy string
    User name of creator of the stream resource
    createdByEmail string
    Email of creator of the stream resource
    createdByFullName string
    Legal name of creator of the stream resource
    createdDateTime string
    Creation time of the stream resource
    deletedBy string
    User name of deleter of the stream resource
    deletedByEmail string
    Email of deleter of the stream resource
    deletedByFullName string
    Legal name of deleter of the stream resource
    deletedDateTime string
    Deletion time of the stream resource
    updatedBy string
    User name of last updater of the stream resource
    updatedByEmail string
    Email of last updater of the stream resource
    updatedByFullName string
    Legal name of last updater of the stream resource
    updatedDateTime string
    Last update time of the stream resource
    created_by str
    User name of creator of the stream resource
    created_by_email str
    Email of creator of the stream resource
    created_by_full_name str
    Legal name of creator of the stream resource
    created_date_time str
    Creation time of the stream resource
    deleted_by str
    User name of deleter of the stream resource
    deleted_by_email str
    Email of deleter of the stream resource
    deleted_by_full_name str
    Legal name of deleter of the stream resource
    deleted_date_time str
    Deletion time of the stream resource
    updated_by str
    User name of last updater of the stream resource
    updated_by_email str
    Email of last updater of the stream resource
    updated_by_full_name str
    Legal name of last updater of the stream resource
    updated_date_time str
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    Last update time of the stream resource

    StreamSubscriptionEventSelector, StreamSubscriptionEventSelectorArgs

    Includes List<string>
    List of events to include
    Excepts List<string>
    List of events to exclude
    Includes []string
    List of events to include
    Excepts []string
    List of events to exclude
    includes List<String>
    List of events to include
    excepts List<String>
    List of events to exclude
    includes string[]
    List of events to include
    excepts string[]
    List of events to exclude
    includes Sequence[str]
    List of events to include
    excepts Sequence[str]
    List of events to exclude
    includes List<String>
    List of events to include
    excepts List<String>
    List of events to exclude

    StreamSubscriptionMetricSelector, StreamSubscriptionMetricSelectorArgs

    Includes List<string>
    List of metrics to include
    Excepts List<string>
    List of metrics to exclude
    Includes []string
    List of metrics to include
    Excepts []string
    List of metrics to exclude
    includes List<String>
    List of metrics to include
    excepts List<String>
    List of metrics to exclude
    includes string[]
    List of metrics to include
    excepts string[]
    List of metrics to exclude
    includes Sequence[str]
    List of metrics to include
    excepts Sequence[str]
    List of metrics to exclude
    includes List<String>
    List of metrics to include
    excepts List<String>
    List of metrics to exclude

    StreamSubscriptionSink, StreamSubscriptionSinkArgs

    Type string
    Type of the subscriber
    BatchEnabled bool
    Boolean switch enabling batch delivery of data
    BatchSizeMax int
    Maximum size of the batch delivery if enabled
    BatchWaitTimeMax int
    Maximum time to wait for batch delivery if enabled
    Credential StreamSubscriptionSinkCredential
    Access details for the specified sink type
    Host string
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    Settings StreamSubscriptionSinkSettings
    Stream subscription sink settings
    Uri string
    Publicly reachable http endpoint destination for data stream
    Type string
    Type of the subscriber
    BatchEnabled bool
    Boolean switch enabling batch delivery of data
    BatchSizeMax int
    Maximum size of the batch delivery if enabled
    BatchWaitTimeMax int
    Maximum time to wait for batch delivery if enabled
    Credential StreamSubscriptionSinkCredential
    Access details for the specified sink type
    Host string
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    Settings StreamSubscriptionSinkSettings
    Stream subscription sink settings
    Uri string
    Publicly reachable http endpoint destination for data stream
    type String
    Type of the subscriber
    batchEnabled Boolean
    Boolean switch enabling batch delivery of data
    batchSizeMax Integer
    Maximum size of the batch delivery if enabled
    batchWaitTimeMax Integer
    Maximum time to wait for batch delivery if enabled
    credential StreamSubscriptionSinkCredential
    Access details for the specified sink type
    host String
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    settings StreamSubscriptionSinkSettings
    Stream subscription sink settings
    uri String
    Publicly reachable http endpoint destination for data stream
    type string
    Type of the subscriber
    batchEnabled boolean
    Boolean switch enabling batch delivery of data
    batchSizeMax number
    Maximum size of the batch delivery if enabled
    batchWaitTimeMax number
    Maximum time to wait for batch delivery if enabled
    credential StreamSubscriptionSinkCredential
    Access details for the specified sink type
    host string
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    settings StreamSubscriptionSinkSettings
    Stream subscription sink settings
    uri string
    Publicly reachable http endpoint destination for data stream
    type str
    Type of the subscriber
    batch_enabled bool
    Boolean switch enabling batch delivery of data
    batch_size_max int
    Maximum size of the batch delivery if enabled
    batch_wait_time_max int
    Maximum time to wait for batch delivery if enabled
    credential StreamSubscriptionSinkCredential
    Access details for the specified sink type
    host str
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    settings StreamSubscriptionSinkSettings
    Stream subscription sink settings
    uri str
    Publicly reachable http endpoint destination for data stream
    type String
    Type of the subscriber
    batchEnabled Boolean
    Boolean switch enabling batch delivery of data
    batchSizeMax Number
    Maximum size of the batch delivery if enabled
    batchWaitTimeMax Number
    Maximum time to wait for batch delivery if enabled
    credential Property Map
    Access details for the specified sink type
    host String
    Known hostname of certain data stream subscription products. Not to be confused with a variable URI
    settings Property Map
    Stream subscription sink settings
    uri String
    Publicly reachable http endpoint destination for data stream

    StreamSubscriptionSinkCredential, StreamSubscriptionSinkCredentialArgs

    Type string
    Type of the credential being passed
    AccessToken string
    Passed as Authorization header value
    ApiKey string
    Passed as Authorization header value
    IntegrationKey string
    Passed as Authorization header value
    Password string
    Passed as Authorization header value
    Username string
    Passed as Authorization header value
    Type string
    Type of the credential being passed
    AccessToken string
    Passed as Authorization header value
    ApiKey string
    Passed as Authorization header value
    IntegrationKey string
    Passed as Authorization header value
    Password string
    Passed as Authorization header value
    Username string
    Passed as Authorization header value
    type String
    Type of the credential being passed
    accessToken String
    Passed as Authorization header value
    apiKey String
    Passed as Authorization header value
    integrationKey String
    Passed as Authorization header value
    password String
    Passed as Authorization header value
    username String
    Passed as Authorization header value
    type string
    Type of the credential being passed
    accessToken string
    Passed as Authorization header value
    apiKey string
    Passed as Authorization header value
    integrationKey string
    Passed as Authorization header value
    password string
    Passed as Authorization header value
    username string
    Passed as Authorization header value
    type str
    Type of the credential being passed
    access_token str
    Passed as Authorization header value
    api_key str
    Passed as Authorization header value
    integration_key str
    Passed as Authorization header value
    password str
    Passed as Authorization header value
    username str
    Passed as Authorization header value
    type String
    Type of the credential being passed
    accessToken String
    Passed as Authorization header value
    apiKey String
    Passed as Authorization header value
    integrationKey String
    Passed as Authorization header value
    password String
    Passed as Authorization header value
    username String
    Passed as Authorization header value

    StreamSubscriptionSinkSettings, StreamSubscriptionSinkSettingsArgs

    ApplicationKey string
    EventIndex string
    EventUri string
    MetricIndex string
    MetricUri string
    Source string
    ApplicationKey string
    EventIndex string
    EventUri string
    MetricIndex string
    MetricUri string
    Source string
    applicationKey String
    eventIndex String
    eventUri String
    metricIndex String
    metricUri String
    source String
    applicationKey string
    eventIndex string
    eventUri string
    metricIndex string
    metricUri string
    source string
    applicationKey String
    eventIndex String
    eventUri String
    metricIndex String
    metricUri String
    source String

    StreamSubscriptionTimeouts, StreamSubscriptionTimeoutsArgs

    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