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

ibm.SatelliteLink

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_link. This allows ibm.SatelliteLink to be created, updated and deleted.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  satelliteLink:
    type: ibm:SatelliteLink
    properties:
      crn: crn:v1:staging:public:satellite:us-south:a/1ae4eb57181a46ceade4846519678888::location:brbats7009sqna3dtest
      locationId: brbats7009sqna3dtest
Copy

Create SatelliteLink Resource

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

Constructor syntax

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

@overload
def SatelliteLink(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  crn: Optional[str] = None,
                  location: Optional[str] = None,
                  satellite_link_id: Optional[str] = None,
                  ws_endpoint: Optional[str] = None)
func NewSatelliteLink(ctx *Context, name string, args SatelliteLinkArgs, opts ...ResourceOption) (*SatelliteLink, error)
public SatelliteLink(string name, SatelliteLinkArgs args, CustomResourceOptions? opts = null)
public SatelliteLink(String name, SatelliteLinkArgs args)
public SatelliteLink(String name, SatelliteLinkArgs args, CustomResourceOptions options)

type: ibm:SatelliteLink
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. SatelliteLinkArgs
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. SatelliteLinkArgs
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. SatelliteLinkArgs
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. SatelliteLinkArgs
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. SatelliteLinkArgs
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 satelliteLinkResource = new Ibm.SatelliteLink("satelliteLinkResource", new()
{
    Crn = "string",
    Location = "string",
    SatelliteLinkId = "string",
    WsEndpoint = "string",
});
Copy
example, err := ibm.NewSatelliteLink(ctx, "satelliteLinkResource", &ibm.SatelliteLinkArgs{
Crn: pulumi.String("string"),
Location: pulumi.String("string"),
SatelliteLinkId: pulumi.String("string"),
WsEndpoint: pulumi.String("string"),
})
Copy
var satelliteLinkResource = new SatelliteLink("satelliteLinkResource", SatelliteLinkArgs.builder()
    .crn("string")
    .location("string")
    .satelliteLinkId("string")
    .wsEndpoint("string")
    .build());
Copy
satellite_link_resource = ibm.SatelliteLink("satelliteLinkResource",
    crn="string",
    location="string",
    satellite_link_id="string",
    ws_endpoint="string")
Copy
const satelliteLinkResource = new ibm.SatelliteLink("satelliteLinkResource", {
    crn: "string",
    location: "string",
    satelliteLinkId: "string",
    wsEndpoint: "string",
});
Copy
type: ibm:SatelliteLink
properties:
    crn: string
    location: string
    satelliteLinkId: string
    wsEndpoint: string
Copy

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

Crn This property is required. string
CRN of the Location.
Location This property is required. string
Location ID.
SatelliteLinkId string
The unique identifier of the ibm_satellite_link.
WsEndpoint string
The ws endpoint of the location.
Crn This property is required. string
CRN of the Location.
Location This property is required. string
Location ID.
SatelliteLinkId string
The unique identifier of the ibm_satellite_link.
WsEndpoint string
The ws endpoint of the location.
crn This property is required. String
CRN of the Location.
location This property is required. String
Location ID.
satelliteLinkId String
The unique identifier of the ibm_satellite_link.
wsEndpoint String
The ws endpoint of the location.
crn This property is required. string
CRN of the Location.
location This property is required. string
Location ID.
satelliteLinkId string
The unique identifier of the ibm_satellite_link.
wsEndpoint string
The ws endpoint of the location.
crn This property is required. str
CRN of the Location.
location This property is required. str
Location ID.
satellite_link_id str
The unique identifier of the ibm_satellite_link.
ws_endpoint str
The ws endpoint of the location.
crn This property is required. String
CRN of the Location.
location This property is required. String
Location ID.
satelliteLinkId String
The unique identifier of the ibm_satellite_link.
wsEndpoint String
The ws endpoint of the location.

Outputs

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

CreatedAt string
Timestamp of creation of location.
Description string
Description of the location.
Id string
The provider-assigned unique ID for this managed resource.
LastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
Performances List<SatelliteLinkPerformance>
The last performance data of the Location.
SatelliteLinkHost string
Satellite Link hostname of the location.
Status string
Enabled/Disabled.
CreatedAt string
Timestamp of creation of location.
Description string
Description of the location.
Id string
The provider-assigned unique ID for this managed resource.
LastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
Performances []SatelliteLinkPerformance
The last performance data of the Location.
SatelliteLinkHost string
Satellite Link hostname of the location.
Status string
Enabled/Disabled.
createdAt String
Timestamp of creation of location.
description String
Description of the location.
id String
The provider-assigned unique ID for this managed resource.
lastChange String
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
performances List<SatelliteLinkPerformance>
The last performance data of the Location.
satelliteLinkHost String
Satellite Link hostname of the location.
status String
Enabled/Disabled.
createdAt string
Timestamp of creation of location.
description string
Description of the location.
id string
The provider-assigned unique ID for this managed resource.
lastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
performances SatelliteLinkPerformance[]
The last performance data of the Location.
satelliteLinkHost string
Satellite Link hostname of the location.
status string
Enabled/Disabled.
created_at str
Timestamp of creation of location.
description str
Description of the location.
id str
The provider-assigned unique ID for this managed resource.
last_change str
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
performances Sequence[SatelliteLinkPerformance]
The last performance data of the Location.
satellite_link_host str
Satellite Link hostname of the location.
status str
Enabled/Disabled.
createdAt String
Timestamp of creation of location.
description String
Description of the location.
id String
The provider-assigned unique ID for this managed resource.
lastChange String
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
performances List<Property Map>
The last performance data of the Location.
satelliteLinkHost String
Satellite Link hostname of the location.
status String
Enabled/Disabled.

Look up Existing SatelliteLink Resource

Get an existing SatelliteLink 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?: SatelliteLinkState, opts?: CustomResourceOptions): SatelliteLink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        last_change: Optional[str] = None,
        location: Optional[str] = None,
        performances: Optional[Sequence[SatelliteLinkPerformanceArgs]] = None,
        satellite_link_host: Optional[str] = None,
        satellite_link_id: Optional[str] = None,
        status: Optional[str] = None,
        ws_endpoint: Optional[str] = None) -> SatelliteLink
func GetSatelliteLink(ctx *Context, name string, id IDInput, state *SatelliteLinkState, opts ...ResourceOption) (*SatelliteLink, error)
public static SatelliteLink Get(string name, Input<string> id, SatelliteLinkState? state, CustomResourceOptions? opts = null)
public static SatelliteLink get(String name, Output<String> id, SatelliteLinkState state, CustomResourceOptions options)
resources:  _:    type: ibm:SatelliteLink    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:
CreatedAt string
Timestamp of creation of location.
Crn string
CRN of the Location.
Description string
Description of the location.
LastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
Location string
Location ID.
Performances List<SatelliteLinkPerformance>
The last performance data of the Location.
SatelliteLinkHost string
Satellite Link hostname of the location.
SatelliteLinkId string
The unique identifier of the ibm_satellite_link.
Status string
Enabled/Disabled.
WsEndpoint string
The ws endpoint of the location.
CreatedAt string
Timestamp of creation of location.
Crn string
CRN of the Location.
Description string
Description of the location.
LastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
Location string
Location ID.
Performances []SatelliteLinkPerformanceArgs
The last performance data of the Location.
SatelliteLinkHost string
Satellite Link hostname of the location.
SatelliteLinkId string
The unique identifier of the ibm_satellite_link.
Status string
Enabled/Disabled.
WsEndpoint string
The ws endpoint of the location.
createdAt String
Timestamp of creation of location.
crn String
CRN of the Location.
description String
Description of the location.
lastChange String
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
location String
Location ID.
performances List<SatelliteLinkPerformance>
The last performance data of the Location.
satelliteLinkHost String
Satellite Link hostname of the location.
satelliteLinkId String
The unique identifier of the ibm_satellite_link.
status String
Enabled/Disabled.
wsEndpoint String
The ws endpoint of the location.
createdAt string
Timestamp of creation of location.
crn string
CRN of the Location.
description string
Description of the location.
lastChange string
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
location string
Location ID.
performances SatelliteLinkPerformance[]
The last performance data of the Location.
satelliteLinkHost string
Satellite Link hostname of the location.
satelliteLinkId string
The unique identifier of the ibm_satellite_link.
status string
Enabled/Disabled.
wsEndpoint string
The ws endpoint of the location.
created_at str
Timestamp of creation of location.
crn str
CRN of the Location.
description str
Description of the location.
last_change str
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
location str
Location ID.
performances Sequence[SatelliteLinkPerformanceArgs]
The last performance data of the Location.
satellite_link_host str
Satellite Link hostname of the location.
satellite_link_id str
The unique identifier of the ibm_satellite_link.
status str
Enabled/Disabled.
ws_endpoint str
The ws endpoint of the location.
createdAt String
Timestamp of creation of location.
crn String
CRN of the Location.
description String
Description of the location.
lastChange String
Timestamp of latest modification of location.

  • Constraints: Allowable values are: enabled, disabled
location String
Location ID.
performances List<Property Map>
The last performance data of the Location.
satelliteLinkHost String
Satellite Link hostname of the location.
satelliteLinkId String
The unique identifier of the ibm_satellite_link.
status String
Enabled/Disabled.
wsEndpoint String
The ws endpoint of the location.

Supporting Types

SatelliteLinkPerformance
, SatelliteLinkPerformanceArgs

AvgLatency This property is required. double
Bandwidth This property is required. double
Connectors This property is required. List<SatelliteLinkPerformanceConnector>
HealthStatus This property is required. string
RxBandwidth This property is required. double
Tunnels This property is required. double
TxBandwidth This property is required. double
AvgLatency This property is required. float64
Bandwidth This property is required. float64
Connectors This property is required. []SatelliteLinkPerformanceConnector
HealthStatus This property is required. string
RxBandwidth This property is required. float64
Tunnels This property is required. float64
TxBandwidth This property is required. float64
avgLatency This property is required. Double
bandwidth This property is required. Double
connectors This property is required. List<SatelliteLinkPerformanceConnector>
healthStatus This property is required. String
rxBandwidth This property is required. Double
tunnels This property is required. Double
txBandwidth This property is required. Double
avgLatency This property is required. number
bandwidth This property is required. number
connectors This property is required. SatelliteLinkPerformanceConnector[]
healthStatus This property is required. string
rxBandwidth This property is required. number
tunnels This property is required. number
txBandwidth This property is required. number
avg_latency This property is required. float
bandwidth This property is required. float
connectors This property is required. Sequence[SatelliteLinkPerformanceConnector]
health_status This property is required. str
rx_bandwidth This property is required. float
tunnels This property is required. float
tx_bandwidth This property is required. float
avgLatency This property is required. Number
bandwidth This property is required. Number
connectors This property is required. List<Property Map>
healthStatus This property is required. String
rxBandwidth This property is required. Number
tunnels This property is required. Number
txBandwidth This property is required. Number

SatelliteLinkPerformanceConnector
, SatelliteLinkPerformanceConnectorArgs

Connector This property is required. string
Latency This property is required. double
RxBw This property is required. double
TxBw This property is required. double
Connector This property is required. string
Latency This property is required. float64
RxBw This property is required. float64
TxBw This property is required. float64
connector This property is required. String
latency This property is required. Double
rxBw This property is required. Double
txBw This property is required. Double
connector This property is required. string
latency This property is required. number
rxBw This property is required. number
txBw This property is required. number
connector This property is required. str
latency This property is required. float
rx_bw This property is required. float
tx_bw This property is required. float
connector This property is required. String
latency This property is required. Number
rxBw This property is required. Number
txBw This property is required. Number

Import

You can import the ibm_satellite_link resource by using location. Unique identifier for this location.

$ pulumi import ibm:index/satelliteLink:SatelliteLink satellite_link brbats7009sqna3dtest
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