1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. EdgeConnector
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.EdgeConnector

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_edge_connector" "us_east_datacenter" {
  name = "US-East Datacenter"
}

    Create EdgeConnector Resource

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

    Constructor syntax

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

@overload
def EdgeConnector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  status: Optional[str] = None,
                  subscriptions: Optional[Sequence[str]] = None)
    func NewEdgeConnector(ctx *Context, name string, args *EdgeConnectorArgs, opts ...ResourceOption) (*EdgeConnector, error)
    public EdgeConnector(string name, EdgeConnectorArgs? args = null, CustomResourceOptions? opts = null)
    public EdgeConnector(String name, EdgeConnectorArgs args)
public EdgeConnector(String name, EdgeConnectorArgs args, CustomResourceOptions options)

    type: rootly:EdgeConnector
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 EdgeConnectorArgs
    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 EdgeConnectorArgs
    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 EdgeConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeConnectorArgs
    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 edgeConnectorResource = new Rootly.EdgeConnector("edgeConnectorResource", new()
{
    Description = "string",
    Name = "string",
    Status = "string",
    Subscriptions = new[]
    {
        "string",
    },
});

    example, err := rootly.NewEdgeConnector(ctx, "edgeConnectorResource", &rootly.EdgeConnectorArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Status:      pulumi.String("string"),
	Subscriptions: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var edgeConnectorResource = new EdgeConnector("edgeConnectorResource", EdgeConnectorArgs.builder()
    .description("string")
    .name("string")
    .status("string")
    .subscriptions("string")
    .build());

    edge_connector_resource = rootly.EdgeConnector("edgeConnectorResource",
    description="string",
    name="string",
    status="string",
    subscriptions=["string"])

    const edgeConnectorResource = new rootly.EdgeConnector("edgeConnectorResource", {
    description: "string",
    name: "string",
    status: "string",
    subscriptions: ["string"],
});

    type: rootly:EdgeConnector
properties:
    description: string
    name: string
    status: string
    subscriptions:
        - string

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

    Description string
    Connector description
    Name string
    Connector name
    Status string
    Connector status. Value must be one of active, paused.
    Subscriptions List<string>
    Array of event types to subscribe to
    Description string
    Connector description
    Name string
    Connector name
    Status string
    Connector status. Value must be one of active, paused.
    Subscriptions []string
    Array of event types to subscribe to
    description String
    Connector description
    name String
    Connector name
    status String
    Connector status. Value must be one of active, paused.
    subscriptions List<String>
    Array of event types to subscribe to
    description string
    Connector description
    name string
    Connector name
    status string
    Connector status. Value must be one of active, paused.
    subscriptions string[]
    Array of event types to subscribe to
    description str
    Connector description
    name str
    Connector name
    status str
    Connector status. Value must be one of active, paused.
    subscriptions Sequence[str]
    Array of event types to subscribe to
    description String
    Connector description
    name String
    Connector name
    status String
    Connector status. Value must be one of active, paused.
    subscriptions List<String>
    Array of event types to subscribe to

    Outputs

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

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Online bool
    Whether connector is currently online
    UpdatedAt string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Online bool
    Whether connector is currently online
    UpdatedAt string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    online Boolean
    Whether connector is currently online
    updatedAt String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    online boolean
    Whether connector is currently online
    updatedAt string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    online bool
    Whether connector is currently online
    updated_at str
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    online Boolean
    Whether connector is currently online
    updatedAt String

    Look up Existing EdgeConnector Resource

    Get an existing EdgeConnector 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?: EdgeConnectorState, opts?: CustomResourceOptions): EdgeConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        online: Optional[bool] = None,
        status: Optional[str] = None,
        subscriptions: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> EdgeConnector
    func GetEdgeConnector(ctx *Context, name string, id IDInput, state *EdgeConnectorState, opts ...ResourceOption) (*EdgeConnector, error)
    public static EdgeConnector Get(string name, Input<string> id, EdgeConnectorState? state, CustomResourceOptions? opts = null)
    public static EdgeConnector get(String name, Output<String> id, EdgeConnectorState state, CustomResourceOptions options)
    resources:  _:    type: rootly:EdgeConnector    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:
    CreatedAt string
    Description string
    Connector description
    Name string
    Connector name
    Online bool
    Whether connector is currently online
    Status string
    Connector status. Value must be one of active, paused.
    Subscriptions List<string>
    Array of event types to subscribe to
    UpdatedAt string
    CreatedAt string
    Description string
    Connector description
    Name string
    Connector name
    Online bool
    Whether connector is currently online
    Status string
    Connector status. Value must be one of active, paused.
    Subscriptions []string
    Array of event types to subscribe to
    UpdatedAt string
    createdAt String
    description String
    Connector description
    name String
    Connector name
    online Boolean
    Whether connector is currently online
    status String
    Connector status. Value must be one of active, paused.
    subscriptions List<String>
    Array of event types to subscribe to
    updatedAt String
    createdAt string
    description string
    Connector description
    name string
    Connector name
    online boolean
    Whether connector is currently online
    status string
    Connector status. Value must be one of active, paused.
    subscriptions string[]
    Array of event types to subscribe to
    updatedAt string
    created_at str
    description str
    Connector description
    name str
    Connector name
    online bool
    Whether connector is currently online
    status str
    Connector status. Value must be one of active, paused.
    subscriptions Sequence[str]
    Array of event types to subscribe to
    updated_at str
    createdAt String
    description String
    Connector description
    name String
    Connector name
    online Boolean
    Whether connector is currently online
    status String
    Connector status. Value must be one of active, paused.
    subscriptions List<String>
    Array of event types to subscribe to
    updatedAt String

    Import

    rootly.EdgeConnector can be imported using the import command.

    $ pulumi import rootly:index/edgeConnector:EdgeConnector primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

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

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.