Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. fleetManagement
  5. Collector
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
pulumiverse/pulumi-grafana

grafana.fleetManagement.Collector

Explore with Pulumi AI

grafana logo
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
pulumiverse/pulumi-grafana

    Manages Grafana Fleet Management collectors.

    Required access policy scopes:

    • fleet-management:read
    • fleet-management:write

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  test:
    type: grafana:fleetManagement:Collector
    properties:
      id: my_collector
      remoteAttributes:
        env: PROD
        owner: TEAM-A
      enabled: true

    Create Collector Resource

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

    Constructor syntax

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

@overload
def Collector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              enabled: Optional[bool] = None,
              remote_attributes: Optional[Mapping[str, str]] = None)
    func NewCollector(ctx *Context, name string, args *CollectorArgs, opts ...ResourceOption) (*Collector, error)
    public Collector(string name, CollectorArgs? args = null, CustomResourceOptions? opts = null)
    public Collector(String name, CollectorArgs args)
public Collector(String name, CollectorArgs args, CustomResourceOptions options)

    type: grafana:fleetManagement:Collector
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 CollectorArgs
    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 CollectorArgs
    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 CollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectorArgs
    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 collectorResource = new Grafana.FleetManagement.Collector("collectorResource", new()
{
    Enabled = false,
    RemoteAttributes = 
    {
        { "string", "string" },
    },
});

    example, err := fleetManagement.NewCollector(ctx, "collectorResource", &fleetManagement.CollectorArgs{
	Enabled: pulumi.Bool(false),
	RemoteAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var collectorResource = new Collector("collectorResource", CollectorArgs.builder()
    .enabled(false)
    .remoteAttributes(Map.of("string", "string"))
    .build());

    collector_resource = grafana.fleet_management.Collector("collectorResource",
    enabled=False,
    remote_attributes={
        "string": "string",
    })

    const collectorResource = new grafana.fleetmanagement.Collector("collectorResource", {
    enabled: false,
    remoteAttributes: {
        string: "string",
    },
});

    type: grafana:fleetManagement:Collector
properties:
    enabled: false
    remoteAttributes:
        string: string

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

    Enabled bool
    Whether the collector is enabled or not
    RemoteAttributes Dictionary<string, string>
    Remote attributes for the collector
    Enabled bool
    Whether the collector is enabled or not
    RemoteAttributes map[string]string
    Remote attributes for the collector
    enabled Boolean
    Whether the collector is enabled or not
    remoteAttributes Map<String,String>
    Remote attributes for the collector
    enabled boolean
    Whether the collector is enabled or not
    remoteAttributes {[key: string]: string}
    Remote attributes for the collector
    enabled bool
    Whether the collector is enabled or not
    remote_attributes Mapping[str, str]
    Remote attributes for the collector
    enabled Boolean
    Whether the collector is enabled or not
    remoteAttributes Map<String>
    Remote attributes for the collector

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Collector 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 Collector Resource

    Get an existing Collector 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?: CollectorState, opts?: CustomResourceOptions): Collector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        remote_attributes: Optional[Mapping[str, str]] = None) -> Collector
    func GetCollector(ctx *Context, name string, id IDInput, state *CollectorState, opts ...ResourceOption) (*Collector, error)
    public static Collector Get(string name, Input<string> id, CollectorState? state, CustomResourceOptions? opts = null)
    public static Collector get(String name, Output<String> id, CollectorState state, CustomResourceOptions options)
    resources:  _:    type: grafana:fleetManagement:Collector    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.
    The following state arguments are supported:
    Enabled bool
    Whether the collector is enabled or not
    RemoteAttributes Dictionary<string, string>
    Remote attributes for the collector
    Enabled bool
    Whether the collector is enabled or not
    RemoteAttributes map[string]string
    Remote attributes for the collector
    enabled Boolean
    Whether the collector is enabled or not
    remoteAttributes Map<String,String>
    Remote attributes for the collector
    enabled boolean
    Whether the collector is enabled or not
    remoteAttributes {[key: string]: string}
    Remote attributes for the collector
    enabled bool
    Whether the collector is enabled or not
    remote_attributes Mapping[str, str]
    Remote attributes for the collector
    enabled Boolean
    Whether the collector is enabled or not
    remoteAttributes Map<String>
    Remote attributes for the collector

    Import

    $ pulumi import grafana:fleetManagement/collector:Collector name "{{ id }}"

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

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
    pulumiverse/pulumi-grafana