1. Packages
  2. Confluent Cloud
  3. API Docs
  4. NetworkLinkService
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

confluentcloud.NetworkLinkService

Explore with Pulumi AI

confluentcloud logo
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

    Import

    You can import a Network Link Service by using Environment ID and Network Link Service ID, in the format <Environment ID>/<Network Link Service ID>. The following example shows how to import a Network Link Service$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

     $ pulumi import confluentcloud:index/networkLinkService:NetworkLinkService my_nls env-abc123/nls-abc123
    

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    Create NetworkLinkService Resource

    new NetworkLinkService(name: string, args: NetworkLinkServiceArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkLinkService(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           accept: Optional[NetworkLinkServiceAcceptArgs] = None,
                           description: Optional[str] = None,
                           display_name: Optional[str] = None,
                           environment: Optional[NetworkLinkServiceEnvironmentArgs] = None,
                           network: Optional[NetworkLinkServiceNetworkArgs] = None)
    @overload
    def NetworkLinkService(resource_name: str,
                           args: NetworkLinkServiceArgs,
                           opts: Optional[ResourceOptions] = None)
    func NewNetworkLinkService(ctx *Context, name string, args NetworkLinkServiceArgs, opts ...ResourceOption) (*NetworkLinkService, error)
    public NetworkLinkService(string name, NetworkLinkServiceArgs args, CustomResourceOptions? opts = null)
    public NetworkLinkService(String name, NetworkLinkServiceArgs args)
    public NetworkLinkService(String name, NetworkLinkServiceArgs args, CustomResourceOptions options)
    
    type: confluentcloud:NetworkLinkService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args NetworkLinkServiceArgs
    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 NetworkLinkServiceArgs
    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 NetworkLinkServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkLinkServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkLinkServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    NetworkLinkService Resource Properties

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

    Inputs

    The NetworkLinkService resource accepts the following input properties:

    Environment Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Accept Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceAccept
    Description string

    The description of the Network Link Service.

    DisplayName string

    The name of the Network Link Service.

    Environment NetworkLinkServiceEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network NetworkLinkServiceNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Accept NetworkLinkServiceAcceptArgs
    Description string

    The description of the Network Link Service.

    DisplayName string

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    accept NetworkLinkServiceAccept
    description String

    The description of the Network Link Service.

    displayName String

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    accept NetworkLinkServiceAccept
    description string

    The description of the Network Link Service.

    displayName string

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    accept NetworkLinkServiceAcceptArgs
    description str

    The description of the Network Link Service.

    display_name str

    The name of the Network Link Service.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network Property Map

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    accept Property Map
    description String

    The description of the Network Link Service.

    displayName String

    The name of the Network Link Service.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    ResourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    Id string

    The provider-assigned unique ID for this managed resource.

    ResourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    id String

    The provider-assigned unique ID for this managed resource.

    resourceName String

    (Required String) The Confluent Resource Name of the Network Link Service.

    id string

    The provider-assigned unique ID for this managed resource.

    resourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    id str

    The provider-assigned unique ID for this managed resource.

    resource_name str

    (Required String) The Confluent Resource Name of the Network Link Service.

    id String

    The provider-assigned unique ID for this managed resource.

    resourceName String

    (Required String) The Confluent Resource Name of the Network Link Service.

    Look up Existing NetworkLinkService Resource

    Get an existing NetworkLinkService 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?: NetworkLinkServiceState, opts?: CustomResourceOptions): NetworkLinkService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accept: Optional[NetworkLinkServiceAcceptArgs] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            environment: Optional[NetworkLinkServiceEnvironmentArgs] = None,
            network: Optional[NetworkLinkServiceNetworkArgs] = None,
            resource_name: Optional[str] = None) -> NetworkLinkService
    func GetNetworkLinkService(ctx *Context, name string, id IDInput, state *NetworkLinkServiceState, opts ...ResourceOption) (*NetworkLinkService, error)
    public static NetworkLinkService Get(string name, Input<string> id, NetworkLinkServiceState? state, CustomResourceOptions? opts = null)
    public static NetworkLinkService get(String name, Output<String> id, NetworkLinkServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Accept Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceAccept
    Description string

    The description of the Network Link Service.

    DisplayName string

    The name of the Network Link Service.

    Environment Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network Pulumi.ConfluentCloud.Inputs.NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    ResourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    Accept NetworkLinkServiceAcceptArgs
    Description string

    The description of the Network Link Service.

    DisplayName string

    The name of the Network Link Service.

    Environment NetworkLinkServiceEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network NetworkLinkServiceNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    ResourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    accept NetworkLinkServiceAccept
    description String

    The description of the Network Link Service.

    displayName String

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    resourceName String

    (Required String) The Confluent Resource Name of the Network Link Service.

    accept NetworkLinkServiceAccept
    description string

    The description of the Network Link Service.

    displayName string

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    resourceName string

    (Required String) The Confluent Resource Name of the Network Link Service.

    accept NetworkLinkServiceAcceptArgs
    description str

    The description of the Network Link Service.

    display_name str

    The name of the Network Link Service.

    environment NetworkLinkServiceEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network NetworkLinkServiceNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    resource_name str

    (Required String) The Confluent Resource Name of the Network Link Service.

    accept Property Map
    description String

    The description of the Network Link Service.

    displayName String

    The name of the Network Link Service.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network Property Map

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    resourceName String

    (Required String) The Confluent Resource Name of the Network Link Service.

    Supporting Types

    NetworkLinkServiceAccept, NetworkLinkServiceAcceptArgs

    Environments List<string>

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    Networks List<string>

    List of network ids from which connections can be accepted.

    Environments []string

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    Networks []string

    List of network ids from which connections can be accepted.

    environments List<String>

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    networks List<String>

    List of network ids from which connections can be accepted.

    environments string[]

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    networks string[]

    List of network ids from which connections can be accepted.

    environments Sequence[str]

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    networks Sequence[str]

    List of network ids from which connections can be accepted.

    environments List<String>

    List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.

    networks List<String>

    List of network ids from which connections can be accepted.

    NetworkLinkServiceEnvironment, NetworkLinkServiceEnvironmentArgs

    Id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    Id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id str

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    NetworkLinkServiceNetwork, NetworkLinkServiceNetworkArgs

    Id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    Id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id string

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id str

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Network Link Service belongs to, for example, n-abc123.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the confluent Terraform Provider.

    confluentcloud logo
    Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi