Docs Home
InfluxDB v1.5.0 published on Wednesday, Jul 2, 2025 by komminarlabs
influxdb.Label
Explore with Pulumi AI
Creates and manages a label.
Create Label Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Label(name: string, args: LabelArgs, opts?: CustomResourceOptions);@overload
def Label(resource_name: str,
args: LabelArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Label(resource_name: str,
opts: Optional[ResourceOptions] = None,
org_id: Optional[str] = None,
name: Optional[str] = None,
properties: Optional[Mapping[str, str]] = None)func NewLabel(ctx *Context, name string, args LabelArgs, opts ...ResourceOption) (*Label, error)public Label(string name, LabelArgs args, CustomResourceOptions? opts = null)type: influxdb:Label
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 LabelArgs
- 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 LabelArgs
- 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 LabelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LabelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LabelArgs
- 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 labelResource = new InfluxDB.Label("labelResource", new()
{
OrgId = "string",
Name = "string",
Properties =
{
{ "string", "string" },
},
});
example, err := influxdb.NewLabel(ctx, "labelResource", &influxdb.LabelArgs{
OrgId: pulumi.String("string"),
Name: pulumi.String("string"),
Properties: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var labelResource = new Label("labelResource", LabelArgs.builder()
.orgId("string")
.name("string")
.properties(Map.of("string", "string"))
.build());
label_resource = influxdb.Label("labelResource",
org_id="string",
name="string",
properties={
"string": "string",
})
const labelResource = new influxdb.Label("labelResource", {
orgId: "string",
name: "string",
properties: {
string: "string",
},
});
type: influxdb:Label
properties:
name: string
orgId: string
properties:
string: string
Label 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 Label resource accepts the following input properties:
- Org
Id string - The organization ID.
- Name string
- A label name.
- Properties Dictionary<string, string>
- The key-value pairs to associate with this label.
- Org
Id string - The organization ID.
- Name string
- A label name.
- Properties map[string]string
- The key-value pairs to associate with this label.
- org
Id String - The organization ID.
- name String
- A label name.
- properties Map<String,String>
- The key-value pairs to associate with this label.
- org
Id string - The organization ID.
- name string
- A label name.
- properties {[key: string]: string}
- The key-value pairs to associate with this label.
- org_
id str - The organization ID.
- name str
- A label name.
- properties Mapping[str, str]
- The key-value pairs to associate with this label.
- org
Id String - The organization ID.
- name String
- A label name.
- properties Map<String>
- The key-value pairs to associate with this label.
Outputs
All input properties are implicitly available as output properties. Additionally, the Label resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Label Resource
Get an existing Label 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?: LabelState, opts?: CustomResourceOptions): Label@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
properties: Optional[Mapping[str, str]] = None) -> Labelfunc GetLabel(ctx *Context, name string, id IDInput, state *LabelState, opts ...ResourceOption) (*Label, error)public static Label Get(string name, Input<string> id, LabelState? state, CustomResourceOptions? opts = null)public static Label get(String name, Output<String> id, LabelState state, CustomResourceOptions options)resources: _: type: influxdb:Label get: id: ${id}- 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.
- Name string
- A label name.
- Org
Id string - The organization ID.
- Properties Dictionary<string, string>
- The key-value pairs to associate with this label.
- Name string
- A label name.
- Org
Id string - The organization ID.
- Properties map[string]string
- The key-value pairs to associate with this label.
- name String
- A label name.
- org
Id String - The organization ID.
- properties Map<String,String>
- The key-value pairs to associate with this label.
- name string
- A label name.
- org
Id string - The organization ID.
- properties {[key: string]: string}
- The key-value pairs to associate with this label.
- name str
- A label name.
- org_
id str - The organization ID.
- properties Mapping[str, str]
- The key-value pairs to associate with this label.
- name String
- A label name.
- org
Id String - The organization ID.
- properties Map<String>
- The key-value pairs to associate with this label.
Package Details
- Repository
- influxdb komminarlabs/pulumi-influxdb
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
influxdbTerraform Provider.