splight.Segment
Explore with Pulumi AI
Example Usage
Create Segment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Segment(name: string, args: SegmentArgs, opts?: CustomResourceOptions);
@overload
def Segment(resource_name: str,
args: SegmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Segment(resource_name: str,
opts: Optional[ResourceOptions] = None,
altitude: Optional[SegmentAltitudeArgs] = None,
azimuth: Optional[SegmentAzimuthArgs] = None,
cumulative_distance: Optional[SegmentCumulativeDistanceArgs] = None,
description: Optional[str] = None,
geometry: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[SegmentTagArgs]] = None,
timezone: Optional[str] = None)
func NewSegment(ctx *Context, name string, args SegmentArgs, opts ...ResourceOption) (*Segment, error)
public Segment(string name, SegmentArgs args, CustomResourceOptions? opts = null)
public Segment(String name, SegmentArgs args)
public Segment(String name, SegmentArgs args, CustomResourceOptions options)
type: splight:Segment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SegmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SegmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SegmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SegmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SegmentArgs
- 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 segmentResource = new Splight.Segment("segmentResource", new()
{
Altitude = new Splight.Inputs.SegmentAltitudeArgs
{
Value = "string",
Asset = "string",
Id = "string",
Name = "string",
Type = "string",
Unit = "string",
},
Azimuth = new Splight.Inputs.SegmentAzimuthArgs
{
Value = "string",
Asset = "string",
Id = "string",
Name = "string",
Type = "string",
Unit = "string",
},
CumulativeDistance = new Splight.Inputs.SegmentCumulativeDistanceArgs
{
Value = "string",
Asset = "string",
Id = "string",
Name = "string",
Type = "string",
Unit = "string",
},
Description = "string",
Geometry = "string",
Name = "string",
Tags = new[]
{
new Splight.Inputs.SegmentTagArgs
{
Id = "string",
Name = "string",
},
},
Timezone = "string",
});
example, err := splight.NewSegment(ctx, "segmentResource", &splight.SegmentArgs{
Altitude: &splight.SegmentAltitudeArgs{
Value: pulumi.String("string"),
Asset: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Unit: pulumi.String("string"),
},
Azimuth: &splight.SegmentAzimuthArgs{
Value: pulumi.String("string"),
Asset: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Unit: pulumi.String("string"),
},
CumulativeDistance: &splight.SegmentCumulativeDistanceArgs{
Value: pulumi.String("string"),
Asset: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Unit: pulumi.String("string"),
},
Description: pulumi.String("string"),
Geometry: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: splight.SegmentTagArray{
&splight.SegmentTagArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
Timezone: pulumi.String("string"),
})
var segmentResource = new Segment("segmentResource", SegmentArgs.builder()
.altitude(SegmentAltitudeArgs.builder()
.value("string")
.asset("string")
.id("string")
.name("string")
.type("string")
.unit("string")
.build())
.azimuth(SegmentAzimuthArgs.builder()
.value("string")
.asset("string")
.id("string")
.name("string")
.type("string")
.unit("string")
.build())
.cumulativeDistance(SegmentCumulativeDistanceArgs.builder()
.value("string")
.asset("string")
.id("string")
.name("string")
.type("string")
.unit("string")
.build())
.description("string")
.geometry("string")
.name("string")
.tags(SegmentTagArgs.builder()
.id("string")
.name("string")
.build())
.timezone("string")
.build());
segment_resource = splight.Segment("segmentResource",
altitude={
"value": "string",
"asset": "string",
"id": "string",
"name": "string",
"type": "string",
"unit": "string",
},
azimuth={
"value": "string",
"asset": "string",
"id": "string",
"name": "string",
"type": "string",
"unit": "string",
},
cumulative_distance={
"value": "string",
"asset": "string",
"id": "string",
"name": "string",
"type": "string",
"unit": "string",
},
description="string",
geometry="string",
name="string",
tags=[{
"id": "string",
"name": "string",
}],
timezone="string")
const segmentResource = new splight.Segment("segmentResource", {
altitude: {
value: "string",
asset: "string",
id: "string",
name: "string",
type: "string",
unit: "string",
},
azimuth: {
value: "string",
asset: "string",
id: "string",
name: "string",
type: "string",
unit: "string",
},
cumulativeDistance: {
value: "string",
asset: "string",
id: "string",
name: "string",
type: "string",
unit: "string",
},
description: "string",
geometry: "string",
name: "string",
tags: [{
id: "string",
name: "string",
}],
timezone: "string",
});
type: splight:Segment
properties:
altitude:
asset: string
id: string
name: string
type: string
unit: string
value: string
azimuth:
asset: string
id: string
name: string
type: string
unit: string
value: string
cumulativeDistance:
asset: string
id: string
name: string
type: string
unit: string
value: string
description: string
geometry: string
name: string
tags:
- id: string
name: string
timezone: string
Segment 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 Segment resource accepts the following input properties:
- Altitude
Splight.
Splight. Inputs. Segment Altitude - attribute of the resource
- Azimuth
Splight.
Splight. Inputs. Segment Azimuth - attribute of the resource
- Cumulative
Distance Splight.Splight. Inputs. Segment Cumulative Distance - attribute of the resource
- Description string
- description of the resource
- Geometry string
- geo position and shape of the resource
- Name string
- name of the resource
- List<Splight.
Splight. Inputs. Segment Tag> - tags of the resource
- Timezone string
- timezone that overrides location-based timezone of the resource
- Altitude
Segment
Altitude Args - attribute of the resource
- Azimuth
Segment
Azimuth Args - attribute of the resource
- Cumulative
Distance SegmentCumulative Distance Args - attribute of the resource
- Description string
- description of the resource
- Geometry string
- geo position and shape of the resource
- Name string
- name of the resource
- []Segment
Tag Args - tags of the resource
- Timezone string
- timezone that overrides location-based timezone of the resource
- altitude
Segment
Altitude - attribute of the resource
- azimuth
Segment
Azimuth - attribute of the resource
- cumulative
Distance SegmentCumulative Distance - attribute of the resource
- description String
- description of the resource
- geometry String
- geo position and shape of the resource
- name String
- name of the resource
- List<Segment
Tag> - tags of the resource
- timezone String
- timezone that overrides location-based timezone of the resource
- altitude
Segment
Altitude - attribute of the resource
- azimuth
Segment
Azimuth - attribute of the resource
- cumulative
Distance SegmentCumulative Distance - attribute of the resource
- description string
- description of the resource
- geometry string
- geo position and shape of the resource
- name string
- name of the resource
- Segment
Tag[] - tags of the resource
- timezone string
- timezone that overrides location-based timezone of the resource
- altitude
Segment
Altitude Args - attribute of the resource
- azimuth
Segment
Azimuth Args - attribute of the resource
- cumulative_
distance SegmentCumulative Distance Args - attribute of the resource
- description str
- description of the resource
- geometry str
- geo position and shape of the resource
- name str
- name of the resource
- Sequence[Segment
Tag Args] - tags of the resource
- timezone str
- timezone that overrides location-based timezone of the resource
- altitude Property Map
- attribute of the resource
- azimuth Property Map
- attribute of the resource
- cumulative
Distance Property Map - attribute of the resource
- description String
- description of the resource
- geometry String
- geo position and shape of the resource
- name String
- name of the resource
- List<Property Map>
- tags of the resource
- timezone String
- timezone that overrides location-based timezone of the resource
Outputs
All input properties are implicitly available as output properties. Additionally, the Segment resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Kinds
List<Splight.
Splight. Outputs. Segment Kind> - kind of the resource
- Temperatures
List<Splight.
Splight. Outputs. Segment Temperature> - attribute of the resource
- Wind
Directions List<Splight.Splight. Outputs. Segment Wind Direction> - attribute of the resource
- Wind
Speeds List<Splight.Splight. Outputs. Segment Wind Speed> - attribute of the resource
- Id string
- The provider-assigned unique ID for this managed resource.
- Kinds
[]Segment
Kind - kind of the resource
- Temperatures
[]Segment
Temperature - attribute of the resource
- Wind
Directions []SegmentWind Direction - attribute of the resource
- Wind
Speeds []SegmentWind Speed - attribute of the resource
- id String
- The provider-assigned unique ID for this managed resource.
- kinds
List<Segment
Kind> - kind of the resource
- temperatures
List<Segment
Temperature> - attribute of the resource
- wind
Directions List<SegmentWind Direction> - attribute of the resource
- wind
Speeds List<SegmentWind Speed> - attribute of the resource
- id string
- The provider-assigned unique ID for this managed resource.
- kinds
Segment
Kind[] - kind of the resource
- temperatures
Segment
Temperature[] - attribute of the resource
- wind
Directions SegmentWind Direction[] - attribute of the resource
- wind
Speeds SegmentWind Speed[] - attribute of the resource
- id str
- The provider-assigned unique ID for this managed resource.
- kinds
Sequence[Segment
Kind] - kind of the resource
- temperatures
Sequence[Segment
Temperature] - attribute of the resource
- wind_
directions Sequence[SegmentWind Direction] - attribute of the resource
- wind_
speeds Sequence[SegmentWind Speed] - attribute of the resource
- id String
- The provider-assigned unique ID for this managed resource.
- kinds List<Property Map>
- kind of the resource
- temperatures List<Property Map>
- attribute of the resource
- wind
Directions List<Property Map> - attribute of the resource
- wind
Speeds List<Property Map> - attribute of the resource
Look up Existing Segment Resource
Get an existing Segment 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?: SegmentState, opts?: CustomResourceOptions): Segment
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
altitude: Optional[SegmentAltitudeArgs] = None,
azimuth: Optional[SegmentAzimuthArgs] = None,
cumulative_distance: Optional[SegmentCumulativeDistanceArgs] = None,
description: Optional[str] = None,
geometry: Optional[str] = None,
kinds: Optional[Sequence[SegmentKindArgs]] = None,
name: Optional[str] = None,
tags: Optional[Sequence[SegmentTagArgs]] = None,
temperatures: Optional[Sequence[SegmentTemperatureArgs]] = None,
timezone: Optional[str] = None,
wind_directions: Optional[Sequence[SegmentWindDirectionArgs]] = None,
wind_speeds: Optional[Sequence[SegmentWindSpeedArgs]] = None) -> Segment
func GetSegment(ctx *Context, name string, id IDInput, state *SegmentState, opts ...ResourceOption) (*Segment, error)
public static Segment Get(string name, Input<string> id, SegmentState? state, CustomResourceOptions? opts = null)
public static Segment get(String name, Output<String> id, SegmentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Altitude
Splight.
Splight. Inputs. Segment Altitude - attribute of the resource
- Azimuth
Splight.
Splight. Inputs. Segment Azimuth - attribute of the resource
- Cumulative
Distance Splight.Splight. Inputs. Segment Cumulative Distance - attribute of the resource
- Description string
- description of the resource
- Geometry string
- geo position and shape of the resource
- Kinds
List<Splight.
Splight. Inputs. Segment Kind> - kind of the resource
- Name string
- name of the resource
- List<Splight.
Splight. Inputs. Segment Tag> - tags of the resource
- Temperatures
List<Splight.
Splight. Inputs. Segment Temperature> - attribute of the resource
- Timezone string
- timezone that overrides location-based timezone of the resource
- Wind
Directions List<Splight.Splight. Inputs. Segment Wind Direction> - attribute of the resource
- Wind
Speeds List<Splight.Splight. Inputs. Segment Wind Speed> - attribute of the resource
- Altitude
Segment
Altitude Args - attribute of the resource
- Azimuth
Segment
Azimuth Args - attribute of the resource
- Cumulative
Distance SegmentCumulative Distance Args - attribute of the resource
- Description string
- description of the resource
- Geometry string
- geo position and shape of the resource
- Kinds
[]Segment
Kind Args - kind of the resource
- Name string
- name of the resource
- []Segment
Tag Args - tags of the resource
- Temperatures
[]Segment
Temperature Args - attribute of the resource
- Timezone string
- timezone that overrides location-based timezone of the resource
- Wind
Directions []SegmentWind Direction Args - attribute of the resource
- Wind
Speeds []SegmentWind Speed Args - attribute of the resource
- altitude
Segment
Altitude - attribute of the resource
- azimuth
Segment
Azimuth - attribute of the resource
- cumulative
Distance SegmentCumulative Distance - attribute of the resource
- description String
- description of the resource
- geometry String
- geo position and shape of the resource
- kinds
List<Segment
Kind> - kind of the resource
- name String
- name of the resource
- List<Segment
Tag> - tags of the resource
- temperatures
List<Segment
Temperature> - attribute of the resource
- timezone String
- timezone that overrides location-based timezone of the resource
- wind
Directions List<SegmentWind Direction> - attribute of the resource
- wind
Speeds List<SegmentWind Speed> - attribute of the resource
- altitude
Segment
Altitude - attribute of the resource
- azimuth
Segment
Azimuth - attribute of the resource
- cumulative
Distance SegmentCumulative Distance - attribute of the resource
- description string
- description of the resource
- geometry string
- geo position and shape of the resource
- kinds
Segment
Kind[] - kind of the resource
- name string
- name of the resource
- Segment
Tag[] - tags of the resource
- temperatures
Segment
Temperature[] - attribute of the resource
- timezone string
- timezone that overrides location-based timezone of the resource
- wind
Directions SegmentWind Direction[] - attribute of the resource
- wind
Speeds SegmentWind Speed[] - attribute of the resource
- altitude
Segment
Altitude Args - attribute of the resource
- azimuth
Segment
Azimuth Args - attribute of the resource
- cumulative_
distance SegmentCumulative Distance Args - attribute of the resource
- description str
- description of the resource
- geometry str
- geo position and shape of the resource
- kinds
Sequence[Segment
Kind Args] - kind of the resource
- name str
- name of the resource
- Sequence[Segment
Tag Args] - tags of the resource
- temperatures
Sequence[Segment
Temperature Args] - attribute of the resource
- timezone str
- timezone that overrides location-based timezone of the resource
- wind_
directions Sequence[SegmentWind Direction Args] - attribute of the resource
- wind_
speeds Sequence[SegmentWind Speed Args] - attribute of the resource
- altitude Property Map
- attribute of the resource
- azimuth Property Map
- attribute of the resource
- cumulative
Distance Property Map - attribute of the resource
- description String
- description of the resource
- geometry String
- geo position and shape of the resource
- kinds List<Property Map>
- kind of the resource
- name String
- name of the resource
- List<Property Map>
- tags of the resource
- temperatures List<Property Map>
- attribute of the resource
- timezone String
- timezone that overrides location-based timezone of the resource
- wind
Directions List<Property Map> - attribute of the resource
- wind
Speeds List<Property Map> - attribute of the resource
Supporting Types
SegmentAltitude, SegmentAltitudeArgs
SegmentAzimuth, SegmentAzimuthArgs
SegmentCumulativeDistance, SegmentCumulativeDistanceArgs
SegmentKind, SegmentKindArgs
SegmentTag, SegmentTagArgs
SegmentTemperature, SegmentTemperatureArgs
SegmentWindDirection, SegmentWindDirectionArgs
SegmentWindSpeed, SegmentWindSpeedArgs
Import
$ pulumi import splight:index/segment:Segment [options] splight_segment.<name> <segment_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- splight splightplatform/pulumi-splight
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
splight
Terraform Provider.