Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteEndpoint
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteEndpoint

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a resource for ibm_satellite_endpoint. This allows ibm.SatelliteEndpoint to be created, updated and deleted.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const satelliteEndpoint = new ibm.SatelliteEndpoint("satelliteEndpoint", {
    clientMutualAuth: true,
    clientProtocol: "https",
    connectionType: "cloud",
    createdBy: "My service",
    displayName: "My endpoint",
    location: "location_id",
    rejectUnauth: true,
    serverHost: "example.com",
    serverMutualAuth: true,
    serverPort: 443,
    serverProtocol: "tls",
    sni: "example.com",
    timeout: 60,
});
Copy
import pulumi
import pulumi_ibm as ibm

satellite_endpoint = ibm.SatelliteEndpoint("satelliteEndpoint",
    client_mutual_auth=True,
    client_protocol="https",
    connection_type="cloud",
    created_by="My service",
    display_name="My endpoint",
    location="location_id",
    reject_unauth=True,
    server_host="example.com",
    server_mutual_auth=True,
    server_port=443,
    server_protocol="tls",
    sni="example.com",
    timeout=60)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSatelliteEndpoint(ctx, "satelliteEndpoint", &ibm.SatelliteEndpointArgs{
			ClientMutualAuth: pulumi.Bool(true),
			ClientProtocol:   pulumi.String("https"),
			ConnectionType:   pulumi.String("cloud"),
			CreatedBy:        pulumi.String("My service"),
			DisplayName:      pulumi.String("My endpoint"),
			Location:         pulumi.String("location_id"),
			RejectUnauth:     pulumi.Bool(true),
			ServerHost:       pulumi.String("example.com"),
			ServerMutualAuth: pulumi.Bool(true),
			ServerPort:       pulumi.Float64(443),
			ServerProtocol:   pulumi.String("tls"),
			Sni:              pulumi.String("example.com"),
			Timeout:          pulumi.Float64(60),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var satelliteEndpoint = new Ibm.SatelliteEndpoint("satelliteEndpoint", new()
    {
        ClientMutualAuth = true,
        ClientProtocol = "https",
        ConnectionType = "cloud",
        CreatedBy = "My service",
        DisplayName = "My endpoint",
        Location = "location_id",
        RejectUnauth = true,
        ServerHost = "example.com",
        ServerMutualAuth = true,
        ServerPort = 443,
        ServerProtocol = "tls",
        Sni = "example.com",
        Timeout = 60,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteEndpoint;
import com.pulumi.ibm.SatelliteEndpointArgs;
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 satelliteEndpoint = new SatelliteEndpoint("satelliteEndpoint", SatelliteEndpointArgs.builder()
            .clientMutualAuth(true)
            .clientProtocol("https")
            .connectionType("cloud")
            .createdBy("My service")
            .displayName("My endpoint")
            .location("location_id")
            .rejectUnauth(true)
            .serverHost("example.com")
            .serverMutualAuth(true)
            .serverPort(443)
            .serverProtocol("tls")
            .sni("example.com")
            .timeout(60)
            .build());

    }
}
Copy
resources:
  satelliteEndpoint:
    type: ibm:SatelliteEndpoint
    properties:
      clientMutualAuth: true
      clientProtocol: https
      connectionType: cloud
      createdBy: My service
      displayName: My endpoint
      location: location_id
      rejectUnauth: true
      serverHost: example.com
      serverMutualAuth: true
      serverPort: 443
      serverProtocol: tls
      sni: example.com
      timeout: 60
Copy

Create SatelliteEndpoint Resource

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

Constructor syntax

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

@overload
def SatelliteEndpoint(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      server_host: Optional[str] = None,
                      client_protocol: Optional[str] = None,
                      connection_type: Optional[str] = None,
                      server_port: Optional[float] = None,
                      display_name: Optional[str] = None,
                      server_mutual_auth: Optional[bool] = None,
                      satellite_endpoint_id: Optional[str] = None,
                      certs: Optional[SatelliteEndpointCertsArgs] = None,
                      client_mutual_auth: Optional[bool] = None,
                      reject_unauth: Optional[bool] = None,
                      created_by: Optional[str] = None,
                      server_protocol: Optional[str] = None,
                      sni: Optional[str] = None,
                      timeout: Optional[float] = None)
func NewSatelliteEndpoint(ctx *Context, name string, args SatelliteEndpointArgs, opts ...ResourceOption) (*SatelliteEndpoint, error)
public SatelliteEndpoint(string name, SatelliteEndpointArgs args, CustomResourceOptions? opts = null)
public SatelliteEndpoint(String name, SatelliteEndpointArgs args)
public SatelliteEndpoint(String name, SatelliteEndpointArgs args, CustomResourceOptions options)

type: ibm:SatelliteEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SatelliteEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SatelliteEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SatelliteEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SatelliteEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SatelliteEndpointArgs
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 satelliteEndpointResource = new Ibm.SatelliteEndpoint("satelliteEndpointResource", new()
{
    Location = "string",
    ServerHost = "string",
    ClientProtocol = "string",
    ConnectionType = "string",
    ServerPort = 0,
    DisplayName = "string",
    ServerMutualAuth = false,
    SatelliteEndpointId = "string",
    Certs = new Ibm.Inputs.SatelliteEndpointCertsArgs
    {
        Client = new Ibm.Inputs.SatelliteEndpointCertsClientArgs
        {
            Cert = new Ibm.Inputs.SatelliteEndpointCertsClientCertArgs
            {
                FileContents = "string",
                Filename = "string",
            },
        },
        Connector = new Ibm.Inputs.SatelliteEndpointCertsConnectorArgs
        {
            Cert = new Ibm.Inputs.SatelliteEndpointCertsConnectorCertArgs
            {
                FileContents = "string",
                Filename = "string",
            },
            Key = new Ibm.Inputs.SatelliteEndpointCertsConnectorKeyArgs
            {
                FileContents = "string",
                Filename = "string",
            },
        },
        Server = new Ibm.Inputs.SatelliteEndpointCertsServerArgs
        {
            Cert = new Ibm.Inputs.SatelliteEndpointCertsServerCertArgs
            {
                FileContents = "string",
                Filename = "string",
            },
        },
    },
    ClientMutualAuth = false,
    RejectUnauth = false,
    CreatedBy = "string",
    ServerProtocol = "string",
    Sni = "string",
    Timeout = 0,
});
Copy
example, err := ibm.NewSatelliteEndpoint(ctx, "satelliteEndpointResource", &ibm.SatelliteEndpointArgs{
Location: pulumi.String("string"),
ServerHost: pulumi.String("string"),
ClientProtocol: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
ServerPort: pulumi.Float64(0),
DisplayName: pulumi.String("string"),
ServerMutualAuth: pulumi.Bool(false),
SatelliteEndpointId: pulumi.String("string"),
Certs: &.SatelliteEndpointCertsArgs{
Client: &.SatelliteEndpointCertsClientArgs{
Cert: &.SatelliteEndpointCertsClientCertArgs{
FileContents: pulumi.String("string"),
Filename: pulumi.String("string"),
},
},
Connector: &.SatelliteEndpointCertsConnectorArgs{
Cert: &.SatelliteEndpointCertsConnectorCertArgs{
FileContents: pulumi.String("string"),
Filename: pulumi.String("string"),
},
Key: &.SatelliteEndpointCertsConnectorKeyArgs{
FileContents: pulumi.String("string"),
Filename: pulumi.String("string"),
},
},
Server: &.SatelliteEndpointCertsServerArgs{
Cert: &.SatelliteEndpointCertsServerCertArgs{
FileContents: pulumi.String("string"),
Filename: pulumi.String("string"),
},
},
},
ClientMutualAuth: pulumi.Bool(false),
RejectUnauth: pulumi.Bool(false),
CreatedBy: pulumi.String("string"),
ServerProtocol: pulumi.String("string"),
Sni: pulumi.String("string"),
Timeout: pulumi.Float64(0),
})
Copy
var satelliteEndpointResource = new SatelliteEndpoint("satelliteEndpointResource", SatelliteEndpointArgs.builder()
    .location("string")
    .serverHost("string")
    .clientProtocol("string")
    .connectionType("string")
    .serverPort(0)
    .displayName("string")
    .serverMutualAuth(false)
    .satelliteEndpointId("string")
    .certs(SatelliteEndpointCertsArgs.builder()
        .client(SatelliteEndpointCertsClientArgs.builder()
            .cert(SatelliteEndpointCertsClientCertArgs.builder()
                .fileContents("string")
                .filename("string")
                .build())
            .build())
        .connector(SatelliteEndpointCertsConnectorArgs.builder()
            .cert(SatelliteEndpointCertsConnectorCertArgs.builder()
                .fileContents("string")
                .filename("string")
                .build())
            .key(SatelliteEndpointCertsConnectorKeyArgs.builder()
                .fileContents("string")
                .filename("string")
                .build())
            .build())
        .server(SatelliteEndpointCertsServerArgs.builder()
            .cert(SatelliteEndpointCertsServerCertArgs.builder()
                .fileContents("string")
                .filename("string")
                .build())
            .build())
        .build())
    .clientMutualAuth(false)
    .rejectUnauth(false)
    .createdBy("string")
    .serverProtocol("string")
    .sni("string")
    .timeout(0)
    .build());
Copy
satellite_endpoint_resource = ibm.SatelliteEndpoint("satelliteEndpointResource",
    location="string",
    server_host="string",
    client_protocol="string",
    connection_type="string",
    server_port=0,
    display_name="string",
    server_mutual_auth=False,
    satellite_endpoint_id="string",
    certs={
        "client": {
            "cert": {
                "file_contents": "string",
                "filename": "string",
            },
        },
        "connector": {
            "cert": {
                "file_contents": "string",
                "filename": "string",
            },
            "key": {
                "file_contents": "string",
                "filename": "string",
            },
        },
        "server": {
            "cert": {
                "file_contents": "string",
                "filename": "string",
            },
        },
    },
    client_mutual_auth=False,
    reject_unauth=False,
    created_by="string",
    server_protocol="string",
    sni="string",
    timeout=0)
Copy
const satelliteEndpointResource = new ibm.SatelliteEndpoint("satelliteEndpointResource", {
    location: "string",
    serverHost: "string",
    clientProtocol: "string",
    connectionType: "string",
    serverPort: 0,
    displayName: "string",
    serverMutualAuth: false,
    satelliteEndpointId: "string",
    certs: {
        client: {
            cert: {
                fileContents: "string",
                filename: "string",
            },
        },
        connector: {
            cert: {
                fileContents: "string",
                filename: "string",
            },
            key: {
                fileContents: "string",
                filename: "string",
            },
        },
        server: {
            cert: {
                fileContents: "string",
                filename: "string",
            },
        },
    },
    clientMutualAuth: false,
    rejectUnauth: false,
    createdBy: "string",
    serverProtocol: "string",
    sni: "string",
    timeout: 0,
});
Copy
type: ibm:SatelliteEndpoint
properties:
    certs:
        client:
            cert:
                fileContents: string
                filename: string
        connector:
            cert:
                fileContents: string
                filename: string
            key:
                fileContents: string
                filename: string
        server:
            cert:
                fileContents: string
                filename: string
    clientMutualAuth: false
    clientProtocol: string
    connectionType: string
    createdBy: string
    displayName: string
    location: string
    rejectUnauth: false
    satelliteEndpointId: string
    serverHost: string
    serverMutualAuth: false
    serverPort: 0
    serverProtocol: string
    sni: string
    timeout: 0
Copy

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

ClientProtocol This property is required. string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
ConnectionType This property is required. string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
DisplayName This property is required. string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
Location This property is required. string
The Location ID.
ServerHost This property is required. string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
ServerPort This property is required. double
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
Certs SatelliteEndpointCerts
The certs.
ClientMutualAuth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
CreatedBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
RejectUnauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
SatelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
ServerMutualAuth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
ServerProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
Sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
Timeout double
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
ClientProtocol This property is required. string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
ConnectionType This property is required. string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
DisplayName This property is required. string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
Location This property is required. string
The Location ID.
ServerHost This property is required. string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
ServerPort This property is required. float64
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
Certs SatelliteEndpointCertsArgs
The certs.
ClientMutualAuth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
CreatedBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
RejectUnauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
SatelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
ServerMutualAuth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
ServerProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
Sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
Timeout float64
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
clientProtocol This property is required. String
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType This property is required. String
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
displayName This property is required. String
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
location This property is required. String
The Location ID.
serverHost This property is required. String
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverPort This property is required. Double
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
certs SatelliteEndpointCerts
The certs.
clientMutualAuth Boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
createdBy String
The service or person who created the endpoint. Must be 1000 characters or fewer.
rejectUnauth Boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId String
The unique identifier of the ibm_satellite_endpoint.
serverMutualAuth Boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverProtocol String
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
sni String
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
timeout Double
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
clientProtocol This property is required. string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType This property is required. string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
displayName This property is required. string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
location This property is required. string
The Location ID.
serverHost This property is required. string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverPort This property is required. number
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
certs SatelliteEndpointCerts
The certs.
clientMutualAuth boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
createdBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
rejectUnauth boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
serverMutualAuth boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
timeout number
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
client_protocol This property is required. str
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connection_type This property is required. str
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
display_name This property is required. str
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
location This property is required. str
The Location ID.
server_host This property is required. str
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
server_port This property is required. float
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
certs SatelliteEndpointCertsArgs
The certs.
client_mutual_auth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
created_by str
The service or person who created the endpoint. Must be 1000 characters or fewer.
reject_unauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satellite_endpoint_id str
The unique identifier of the ibm_satellite_endpoint.
server_mutual_auth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
server_protocol str
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
sni str
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
timeout float
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
clientProtocol This property is required. String
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType This property is required. String
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
displayName This property is required. String
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
location This property is required. String
The Location ID.
serverHost This property is required. String
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverPort This property is required. Number
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
certs Property Map
The certs.
clientMutualAuth Boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
createdBy String
The service or person who created the endpoint. Must be 1000 characters or fewer.
rejectUnauth Boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId String
The unique identifier of the ibm_satellite_endpoint.
serverMutualAuth Boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverProtocol String
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
sni String
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
timeout Number
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.

Outputs

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

ClientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
ClientPort double
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
ConnectorPort double
The connector port.
CreatedAt string
The time when the Endpoint is created.
Crn string
Service instance associated with this location.
EndpointId string
The Endpoint ID.
Id string
The provider-assigned unique ID for this managed resource.
LastChange string
The last time modify the Endpoint configurations.
Performances List<SatelliteEndpointPerformance>
The last performance data of the endpoint.
ServiceName string
The service name of the endpoint.
Sources List<SatelliteEndpointSource>
sources
Status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
ClientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
ClientPort float64
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
ConnectorPort float64
The connector port.
CreatedAt string
The time when the Endpoint is created.
Crn string
Service instance associated with this location.
EndpointId string
The Endpoint ID.
Id string
The provider-assigned unique ID for this managed resource.
LastChange string
The last time modify the Endpoint configurations.
Performances []SatelliteEndpointPerformance
The last performance data of the endpoint.
ServiceName string
The service name of the endpoint.
Sources []SatelliteEndpointSource
sources
Status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
clientHost String
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientPort Double
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
connectorPort Double
The connector port.
createdAt String
The time when the Endpoint is created.
crn String
Service instance associated with this location.
endpointId String
The Endpoint ID.
id String
The provider-assigned unique ID for this managed resource.
lastChange String
The last time modify the Endpoint configurations.
performances List<SatelliteEndpointPerformance>
The last performance data of the endpoint.
serviceName String
The service name of the endpoint.
sources List<SatelliteEndpointSource>
sources
status String
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
clientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientPort number
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
connectorPort number
The connector port.
createdAt string
The time when the Endpoint is created.
crn string
Service instance associated with this location.
endpointId string
The Endpoint ID.
id string
The provider-assigned unique ID for this managed resource.
lastChange string
The last time modify the Endpoint configurations.
performances SatelliteEndpointPerformance[]
The last performance data of the endpoint.
serviceName string
The service name of the endpoint.
sources SatelliteEndpointSource[]
sources
status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
client_host str
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
client_port float
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
connector_port float
The connector port.
created_at str
The time when the Endpoint is created.
crn str
Service instance associated with this location.
endpoint_id str
The Endpoint ID.
id str
The provider-assigned unique ID for this managed resource.
last_change str
The last time modify the Endpoint configurations.
performances Sequence[SatelliteEndpointPerformance]
The last performance data of the endpoint.
service_name str
The service name of the endpoint.
sources Sequence[SatelliteEndpointSource]
sources
status str
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
clientHost String
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientPort Number
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
connectorPort Number
The connector port.
createdAt String
The time when the Endpoint is created.
crn String
Service instance associated with this location.
endpointId String
The Endpoint ID.
id String
The provider-assigned unique ID for this managed resource.
lastChange String
The last time modify the Endpoint configurations.
performances List<Property Map>
The last performance data of the endpoint.
serviceName String
The service name of the endpoint.
sources List<Property Map>
sources
status String
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled

Look up Existing SatelliteEndpoint Resource

Get an existing SatelliteEndpoint 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?: SatelliteEndpointState, opts?: CustomResourceOptions): SatelliteEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certs: Optional[SatelliteEndpointCertsArgs] = None,
        client_host: Optional[str] = None,
        client_mutual_auth: Optional[bool] = None,
        client_port: Optional[float] = None,
        client_protocol: Optional[str] = None,
        connection_type: Optional[str] = None,
        connector_port: Optional[float] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        display_name: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        last_change: Optional[str] = None,
        location: Optional[str] = None,
        performances: Optional[Sequence[SatelliteEndpointPerformanceArgs]] = None,
        reject_unauth: Optional[bool] = None,
        satellite_endpoint_id: Optional[str] = None,
        server_host: Optional[str] = None,
        server_mutual_auth: Optional[bool] = None,
        server_port: Optional[float] = None,
        server_protocol: Optional[str] = None,
        service_name: Optional[str] = None,
        sni: Optional[str] = None,
        sources: Optional[Sequence[SatelliteEndpointSourceArgs]] = None,
        status: Optional[str] = None,
        timeout: Optional[float] = None) -> SatelliteEndpoint
func GetSatelliteEndpoint(ctx *Context, name string, id IDInput, state *SatelliteEndpointState, opts ...ResourceOption) (*SatelliteEndpoint, error)
public static SatelliteEndpoint Get(string name, Input<string> id, SatelliteEndpointState? state, CustomResourceOptions? opts = null)
public static SatelliteEndpoint get(String name, Output<String> id, SatelliteEndpointState state, CustomResourceOptions options)
resources:  _:    type: ibm:SatelliteEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Certs SatelliteEndpointCerts
The certs.
ClientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
ClientMutualAuth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
ClientPort double
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
ClientProtocol string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
ConnectionType string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
ConnectorPort double
The connector port.
CreatedAt string
The time when the Endpoint is created.
CreatedBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
Crn string
Service instance associated with this location.
DisplayName string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
EndpointId string
The Endpoint ID.
LastChange string
The last time modify the Endpoint configurations.
Location string
The Location ID.
Performances List<SatelliteEndpointPerformance>
The last performance data of the endpoint.
RejectUnauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
SatelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
ServerHost string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
ServerMutualAuth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
ServerPort double
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
ServerProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
ServiceName string
The service name of the endpoint.
Sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
Sources List<SatelliteEndpointSource>
sources
Status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
Timeout double
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
Certs SatelliteEndpointCertsArgs
The certs.
ClientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
ClientMutualAuth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
ClientPort float64
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
ClientProtocol string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
ConnectionType string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
ConnectorPort float64
The connector port.
CreatedAt string
The time when the Endpoint is created.
CreatedBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
Crn string
Service instance associated with this location.
DisplayName string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
EndpointId string
The Endpoint ID.
LastChange string
The last time modify the Endpoint configurations.
Location string
The Location ID.
Performances []SatelliteEndpointPerformanceArgs
The last performance data of the endpoint.
RejectUnauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
SatelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
ServerHost string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
ServerMutualAuth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
ServerPort float64
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
ServerProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
ServiceName string
The service name of the endpoint.
Sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
Sources []SatelliteEndpointSourceArgs
sources
Status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
Timeout float64
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
certs SatelliteEndpointCerts
The certs.
clientHost String
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientMutualAuth Boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
clientPort Double
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
clientProtocol String
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType String
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
connectorPort Double
The connector port.
createdAt String
The time when the Endpoint is created.
createdBy String
The service or person who created the endpoint. Must be 1000 characters or fewer.
crn String
Service instance associated with this location.
displayName String
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
endpointId String
The Endpoint ID.
lastChange String
The last time modify the Endpoint configurations.
location String
The Location ID.
performances List<SatelliteEndpointPerformance>
The last performance data of the endpoint.
rejectUnauth Boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId String
The unique identifier of the ibm_satellite_endpoint.
serverHost String
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverMutualAuth Boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverPort Double
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
serverProtocol String
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
serviceName String
The service name of the endpoint.
sni String
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
sources List<SatelliteEndpointSource>
sources
status String
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
timeout Double
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
certs SatelliteEndpointCerts
The certs.
clientHost string
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientMutualAuth boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
clientPort number
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
clientProtocol string
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType string
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
connectorPort number
The connector port.
createdAt string
The time when the Endpoint is created.
createdBy string
The service or person who created the endpoint. Must be 1000 characters or fewer.
crn string
Service instance associated with this location.
displayName string
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
endpointId string
The Endpoint ID.
lastChange string
The last time modify the Endpoint configurations.
location string
The Location ID.
performances SatelliteEndpointPerformance[]
The last performance data of the endpoint.
rejectUnauth boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId string
The unique identifier of the ibm_satellite_endpoint.
serverHost string
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverMutualAuth boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverPort number
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
serverProtocol string
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
serviceName string
The service name of the endpoint.
sni string
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
sources SatelliteEndpointSource[]
sources
status string
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
timeout number
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
certs SatelliteEndpointCertsArgs
The certs.
client_host str
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
client_mutual_auth bool
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
client_port float
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
client_protocol str
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connection_type str
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
connector_port float
The connector port.
created_at str
The time when the Endpoint is created.
created_by str
The service or person who created the endpoint. Must be 1000 characters or fewer.
crn str
Service instance associated with this location.
display_name str
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
endpoint_id str
The Endpoint ID.
last_change str
The last time modify the Endpoint configurations.
location str
The Location ID.
performances Sequence[SatelliteEndpointPerformanceArgs]
The last performance data of the endpoint.
reject_unauth bool
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satellite_endpoint_id str
The unique identifier of the ibm_satellite_endpoint.
server_host str
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
server_mutual_auth bool
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
server_port float
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
server_protocol str
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
service_name str
The service name of the endpoint.
sni str
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
sources Sequence[SatelliteEndpointSourceArgs]
sources
status str
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
timeout float
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.
certs Property Map
The certs.
clientHost String
The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.
clientMutualAuth Boolean
Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.

  • Constraints: The default value is false.
clientPort Number
The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.
clientProtocol String
The protocol in the client application side.

  • Constraints: Allowable values are: udp, tcp, tls, http, https, http-tunnel
connectionType String
The type of the endpoint.

  • Constraints: Allowable values are: cloud, location
connectorPort Number
The connector port.
createdAt String
The time when the Endpoint is created.
createdBy String
The service or person who created the endpoint. Must be 1000 characters or fewer.
crn String
Service instance associated with this location.
displayName String
The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.
endpointId String
The Endpoint ID.
lastChange String
The last time modify the Endpoint configurations.
location String
The Location ID.
performances List<Property Map>
The last performance data of the endpoint.
rejectUnauth Boolean
Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.

  • Constraints: The default value is false.
satelliteEndpointId String
The unique identifier of the ibm_satellite_endpoint.
serverHost String
The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '.' , which means a wildcard to it's sub domains. Such as '.example.com' can accept request to 'api.example.com' and 'www.example.com'.
serverMutualAuth Boolean
Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.

  • Constraints: The default value is false.
serverPort Number
The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).
serverProtocol String
The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.

  • Constraints: Allowable values are: udp, tcp, tls
serviceName String
The service name of the endpoint.
sni String
The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.
sources List<Property Map>
sources
status String
Whether the Endpoint is active or not.

  • Constraints: Allowable values are: enabled, disabled
timeout Number
The inactivity timeout in the Endpoint side.

  • Constraints: The maximum value is 180. The minimum value is 1.

Supporting Types

SatelliteEndpointCerts
, SatelliteEndpointCertsArgs

Client SatelliteEndpointCertsClient
The CA which Satellite Link trust when receiving the connection from the client application.
Connector SatelliteEndpointCertsConnector
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
Server SatelliteEndpointCertsServer
The CA which Satellite Link trust when sending the connection to server application.
Client SatelliteEndpointCertsClient
The CA which Satellite Link trust when receiving the connection from the client application.
Connector SatelliteEndpointCertsConnector
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
Server SatelliteEndpointCertsServer
The CA which Satellite Link trust when sending the connection to server application.
client SatelliteEndpointCertsClient
The CA which Satellite Link trust when receiving the connection from the client application.
connector SatelliteEndpointCertsConnector
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
server SatelliteEndpointCertsServer
The CA which Satellite Link trust when sending the connection to server application.
client SatelliteEndpointCertsClient
The CA which Satellite Link trust when receiving the connection from the client application.
connector SatelliteEndpointCertsConnector
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
server SatelliteEndpointCertsServer
The CA which Satellite Link trust when sending the connection to server application.
client SatelliteEndpointCertsClient
The CA which Satellite Link trust when receiving the connection from the client application.
connector SatelliteEndpointCertsConnector
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
server SatelliteEndpointCertsServer
The CA which Satellite Link trust when sending the connection to server application.
client Property Map
The CA which Satellite Link trust when receiving the connection from the client application.
connector Property Map
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
server Property Map
The CA which Satellite Link trust when sending the connection to server application.

SatelliteEndpointCertsClient
, SatelliteEndpointCertsClientArgs

Cert SatelliteEndpointCertsClientCert
The root cert or the self-signed cert of the client application.
Cert SatelliteEndpointCertsClientCert
The root cert or the self-signed cert of the client application.
cert SatelliteEndpointCertsClientCert
The root cert or the self-signed cert of the client application.
cert SatelliteEndpointCertsClientCert
The root cert or the self-signed cert of the client application.
cert SatelliteEndpointCertsClientCert
The root cert or the self-signed cert of the client application.
cert Property Map
The root cert or the self-signed cert of the client application.

SatelliteEndpointCertsClientCert
, SatelliteEndpointCertsClientCertArgs

FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.
fileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename string
The filename of the cert.
file_contents str
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename str
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.

SatelliteEndpointCertsConnector
, SatelliteEndpointCertsConnectorArgs

Cert SatelliteEndpointCertsConnectorCert
The end-entity cert. This is required when the key is defined.
Key SatelliteEndpointCertsConnectorKey
The private key of the end-entity certificate. This is required when the cert is defined.
Cert SatelliteEndpointCertsConnectorCert
The end-entity cert. This is required when the key is defined.
Key SatelliteEndpointCertsConnectorKey
The private key of the end-entity certificate. This is required when the cert is defined.
cert SatelliteEndpointCertsConnectorCert
The end-entity cert. This is required when the key is defined.
key SatelliteEndpointCertsConnectorKey
The private key of the end-entity certificate. This is required when the cert is defined.
cert SatelliteEndpointCertsConnectorCert
The end-entity cert. This is required when the key is defined.
key SatelliteEndpointCertsConnectorKey
The private key of the end-entity certificate. This is required when the cert is defined.
cert SatelliteEndpointCertsConnectorCert
The end-entity cert. This is required when the key is defined.
key SatelliteEndpointCertsConnectorKey
The private key of the end-entity certificate. This is required when the cert is defined.
cert Property Map
The end-entity cert. This is required when the key is defined.
key Property Map
The private key of the end-entity certificate. This is required when the cert is defined.

SatelliteEndpointCertsConnectorCert
, SatelliteEndpointCertsConnectorCertArgs

FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.
fileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename string
The filename of the cert.
file_contents str
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename str
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.

SatelliteEndpointCertsConnectorKey
, SatelliteEndpointCertsConnectorKeyArgs

FileContents string
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The name of the key.
FileContents string
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The name of the key.
fileContents String
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The name of the key.
fileContents string
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename string
The name of the key.
file_contents str
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename str
The name of the key.
fileContents String
The content of the key. The private key file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The name of the key.

SatelliteEndpointCertsServer
, SatelliteEndpointCertsServerArgs

Cert SatelliteEndpointCertsServerCert
The root cert or the self-signed cert of the server application.
Cert SatelliteEndpointCertsServerCert
The root cert or the self-signed cert of the server application.
cert SatelliteEndpointCertsServerCert
The root cert or the self-signed cert of the server application.
cert SatelliteEndpointCertsServerCert
The root cert or the self-signed cert of the server application.
cert SatelliteEndpointCertsServerCert
The root cert or the self-signed cert of the server application.
cert Property Map
The root cert or the self-signed cert of the server application.

SatelliteEndpointCertsServerCert
, SatelliteEndpointCertsServerCertArgs

FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
FileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
Filename string
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.
fileContents string
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename string
The filename of the cert.
file_contents str
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename str
The filename of the cert.
fileContents String
The content of the cert. The certificate file must be in Privacy-enhanced Electronic Mail (PEM) format.
filename String
The filename of the cert.

SatelliteEndpointPerformance
, SatelliteEndpointPerformanceArgs

Bandwidth This property is required. double
Connection This property is required. double
Connectors This property is required. List<SatelliteEndpointPerformanceConnector>
RxBandwidth This property is required. double
TxBandwidth This property is required. double
Bandwidth This property is required. float64
Connection This property is required. float64
Connectors This property is required. []SatelliteEndpointPerformanceConnector
RxBandwidth This property is required. float64
TxBandwidth This property is required. float64
bandwidth This property is required. Double
connection This property is required. Double
connectors This property is required. List<SatelliteEndpointPerformanceConnector>
rxBandwidth This property is required. Double
txBandwidth This property is required. Double
bandwidth This property is required. number
connection This property is required. number
connectors This property is required. SatelliteEndpointPerformanceConnector[]
rxBandwidth This property is required. number
txBandwidth This property is required. number
bandwidth This property is required. float
connection This property is required. float
connectors This property is required. Sequence[SatelliteEndpointPerformanceConnector]
rx_bandwidth This property is required. float
tx_bandwidth This property is required. float
bandwidth This property is required. Number
connection This property is required. Number
connectors This property is required. List<Property Map>
rxBandwidth This property is required. Number
txBandwidth This property is required. Number

SatelliteEndpointPerformanceConnector
, SatelliteEndpointPerformanceConnectorArgs

Connections This property is required. double
Connector This property is required. string
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
RxBw This property is required. double
TxBw This property is required. double
Connections This property is required. float64
Connector This property is required. string
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
RxBw This property is required. float64
TxBw This property is required. float64
connections This property is required. Double
connector This property is required. String
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
rxBw This property is required. Double
txBw This property is required. Double
connections This property is required. number
connector This property is required. string
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
rxBw This property is required. number
txBw This property is required. number
connections This property is required. float
connector This property is required. str
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
rx_bw This property is required. float
tx_bw This property is required. float
connections This property is required. Number
connector This property is required. String
The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.
rxBw This property is required. Number
txBw This property is required. Number

SatelliteEndpointSource
, SatelliteEndpointSourceArgs

Enabled This property is required. bool
LastChange This property is required. string
The last time modify the Endpoint configurations.
Pending This property is required. bool
SourceId This property is required. string
Enabled This property is required. bool
LastChange This property is required. string
The last time modify the Endpoint configurations.
Pending This property is required. bool
SourceId This property is required. string
enabled This property is required. Boolean
lastChange This property is required. String
The last time modify the Endpoint configurations.
pending This property is required. Boolean
sourceId This property is required. String
enabled This property is required. boolean
lastChange This property is required. string
The last time modify the Endpoint configurations.
pending This property is required. boolean
sourceId This property is required. string
enabled This property is required. bool
last_change This property is required. str
The last time modify the Endpoint configurations.
pending This property is required. bool
source_id This property is required. str
enabled This property is required. Boolean
lastChange This property is required. String
The last time modify the Endpoint configurations.
pending This property is required. Boolean
sourceId This property is required. String

Import

You can import the ibm_satellite_endpoint resource by using endpoint_id.

The endpoint_id property can be formed from location, and endpoint_id in the following format:

/<endpoint_id>

  • location: A string. The Location ID.

  • endpoint_id: A string. The Endpoint ID.

$ pulumi import ibm:index/satelliteEndpoint:SatelliteEndpoint satellite_endpoint <location>/<endpoint_id>
Copy

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

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm