1. Packages
  2. Impart Security
  3. API Docs
  4. GetConnector
Impart Security v0.7.0 published on Tuesday, Sep 24, 2024 by Impart Security

impart.GetConnector

Explore with Pulumi AI

impart logo
Impart Security v0.7.0 published on Tuesday, Sep 24, 2024 by Impart Security

    Manage a connector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as impart from "@pulumi/impart";
    
    const exampleConnector = impart.GetConnector({
        id: "<id>",
    });
    
    import pulumi
    import pulumi_impart as impart
    
    example_connector = impart.get_connector(id="<id>")
    
    package main
    
    import (
    	"github.com/impart-security/pulumi-impart/sdk/go/impart"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := impart.GetConnector(ctx, &impart.GetConnectorArgs{
    			Id: "<id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Impart = Pulumi.Impart;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleConnector = Impart.GetConnector.Invoke(new()
        {
            Id = "<id>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.impart.ImpartFunctions;
    import com.pulumi.impart.inputs.GetConnectorArgs;
    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) {
            final var exampleConnector = ImpartFunctions.GetConnector(GetConnectorArgs.builder()
                .id("<id>")
                .build());
    
        }
    }
    
    variables:
      exampleConnector:
        fn::invoke:
          Function: impart:GetConnector
          Arguments:
            id: <id>
    

    Using GetConnector

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
    function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
    def get_connector(connector_type_id: Optional[str] = None,
                      id: Optional[str] = None,
                      is_connected: Optional[bool] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConnectorResult
    def get_connector_output(connector_type_id: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      is_connected: Optional[pulumi.Input[bool]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
    func GetConnector(ctx *Context, args *GetConnectorArgs, opts ...InvokeOption) (*GetConnectorResult, error)
    func GetConnectorOutput(ctx *Context, args *GetConnectorOutputArgs, opts ...InvokeOption) GetConnectorResultOutput
    public static class GetConnector 
    {
        public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: impart:GetConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Identifier for this connector.
    ConnectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    IsConnected bool
    Whether or not the connector is authenticated via OAuth2.
    Name string
    Name for this connector.
    Id string
    Identifier for this connector.
    ConnectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    IsConnected bool
    Whether or not the connector is authenticated via OAuth2.
    Name string
    Name for this connector.
    id String
    Identifier for this connector.
    connectorTypeId String
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected Boolean
    Whether or not the connector is authenticated via OAuth2.
    name String
    Name for this connector.
    id string
    Identifier for this connector.
    connectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected boolean
    Whether or not the connector is authenticated via OAuth2.
    name string
    Name for this connector.
    id str
    Identifier for this connector.
    connector_type_id str
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    is_connected bool
    Whether or not the connector is authenticated via OAuth2.
    name str
    Name for this connector.
    id String
    Identifier for this connector.
    connectorTypeId String
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected Boolean
    Whether or not the connector is authenticated via OAuth2.
    name String
    Name for this connector.

    GetConnector Result

    The following output properties are available:

    Id string
    Identifier for this connector.
    ConnectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    IsConnected bool
    Whether or not the connector is authenticated via OAuth2.
    Name string
    Name for this connector.
    Id string
    Identifier for this connector.
    ConnectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    IsConnected bool
    Whether or not the connector is authenticated via OAuth2.
    Name string
    Name for this connector.
    id String
    Identifier for this connector.
    connectorTypeId String
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected Boolean
    Whether or not the connector is authenticated via OAuth2.
    name String
    Name for this connector.
    id string
    Identifier for this connector.
    connectorTypeId string
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected boolean
    Whether or not the connector is authenticated via OAuth2.
    name string
    Name for this connector.
    id str
    Identifier for this connector.
    connector_type_id str
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    is_connected bool
    Whether or not the connector is authenticated via OAuth2.
    name str
    Name for this connector.
    id String
    Identifier for this connector.
    connectorTypeId String
    ID of the connector type (eg. ID for our Slack or Jira connector types).
    isConnected Boolean
    Whether or not the connector is authenticated via OAuth2.
    name String
    Name for this connector.

    Package Details

    Repository
    impart impart-security/pulumi-impart
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the impart Terraform Provider.
    impart logo
    Impart Security v0.7.0 published on Tuesday, Sep 24, 2024 by Impart Security