Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sysdig Provider
  3. API Docs
  4. getFargateWorkloadAgent
sysdig 1.53.0 published on Thursday, Apr 17, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

sysdig.getFargateWorkloadAgent

Explore with Pulumi AI

sysdig 1.53.0 published on Thursday, Apr 17, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

Example Usage

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

const instrumentedContainers = sysdig.getFargateWorkloadAgent({
    containerDefinitions: "[]",
    workloadAgentImage: "quay.io/sysdig/workload-agent:latest",
    collectorHost: _var.collector_host,
    collectorPort: _var.collector_port,
    sysdigAccessKey: _var.sysdig_access_key,
});
Copy
import pulumi
import pulumi_sysdig as sysdig

instrumented_containers = sysdig.get_fargate_workload_agent(container_definitions="[]",
    workload_agent_image="quay.io/sysdig/workload-agent:latest",
    collector_host=var["collector_host"],
    collector_port=var["collector_port"],
    sysdig_access_key=var["sysdig_access_key"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sysdig.GetFargateWorkloadAgent(ctx, &sysdig.GetFargateWorkloadAgentArgs{
			ContainerDefinitions: "[]",
			WorkloadAgentImage:   "quay.io/sysdig/workload-agent:latest",
			CollectorHost:        pulumi.StringRef(_var.Collector_host),
			CollectorPort:        pulumi.StringRef(_var.Collector_port),
			SysdigAccessKey:      pulumi.StringRef(_var.Sysdig_access_key),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sysdig = Pulumi.Sysdig;

return await Deployment.RunAsync(() => 
{
    var instrumentedContainers = Sysdig.GetFargateWorkloadAgent.Invoke(new()
    {
        ContainerDefinitions = "[]",
        WorkloadAgentImage = "quay.io/sysdig/workload-agent:latest",
        CollectorHost = @var.Collector_host,
        CollectorPort = @var.Collector_port,
        SysdigAccessKey = @var.Sysdig_access_key,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sysdig.SysdigFunctions;
import com.pulumi.sysdig.inputs.GetFargateWorkloadAgentArgs;
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) {
        final var instrumentedContainers = SysdigFunctions.getFargateWorkloadAgent(GetFargateWorkloadAgentArgs.builder()
            .containerDefinitions("[]")
            .workloadAgentImage("quay.io/sysdig/workload-agent:latest")
            .collectorHost(var_.collector_host())
            .collectorPort(var_.collector_port())
            .sysdigAccessKey(var_.sysdig_access_key())
            .build());

    }
}
Copy
variables:
  instrumentedContainers:
    fn::invoke:
      function: sysdig:getFargateWorkloadAgent
      arguments:
        containerDefinitions: '[]'
        workloadAgentImage: quay.io/sysdig/workload-agent:latest
        collectorHost: ${var.collector_host}
        collectorPort: ${var.collector_port}
        sysdigAccessKey: ${var.sysdig_access_key}
Copy

Using getFargateWorkloadAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFargateWorkloadAgent(args: GetFargateWorkloadAgentArgs, opts?: InvokeOptions): Promise<GetFargateWorkloadAgentResult>
function getFargateWorkloadAgentOutput(args: GetFargateWorkloadAgentOutputArgs, opts?: InvokeOptions): Output<GetFargateWorkloadAgentResult>
Copy
def get_fargate_workload_agent(bare_pdig_on_containers: Optional[Sequence[str]] = None,
                               collector_host: Optional[str] = None,
                               collector_port: Optional[str] = None,
                               container_definitions: Optional[str] = None,
                               id: Optional[str] = None,
                               ignore_containers: Optional[Sequence[str]] = None,
                               image_auth_secret: Optional[str] = None,
                               instrumentation_cpu: Optional[float] = None,
                               instrumentation_essential: Optional[bool] = None,
                               instrumentation_memory_limit: Optional[float] = None,
                               instrumentation_memory_reservation: Optional[float] = None,
                               log_configuration: Optional[GetFargateWorkloadAgentLogConfiguration] = None,
                               orchestrator_host: Optional[str] = None,
                               orchestrator_port: Optional[str] = None,
                               priority: Optional[str] = None,
                               sidecar: Optional[str] = None,
                               sysdig_access_key: Optional[str] = None,
                               sysdig_logging: Optional[str] = None,
                               workload_agent_image: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetFargateWorkloadAgentResult
def get_fargate_workload_agent_output(bare_pdig_on_containers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               collector_host: Optional[pulumi.Input[str]] = None,
                               collector_port: Optional[pulumi.Input[str]] = None,
                               container_definitions: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               ignore_containers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               image_auth_secret: Optional[pulumi.Input[str]] = None,
                               instrumentation_cpu: Optional[pulumi.Input[float]] = None,
                               instrumentation_essential: Optional[pulumi.Input[bool]] = None,
                               instrumentation_memory_limit: Optional[pulumi.Input[float]] = None,
                               instrumentation_memory_reservation: Optional[pulumi.Input[float]] = None,
                               log_configuration: Optional[pulumi.Input[GetFargateWorkloadAgentLogConfigurationArgs]] = None,
                               orchestrator_host: Optional[pulumi.Input[str]] = None,
                               orchestrator_port: Optional[pulumi.Input[str]] = None,
                               priority: Optional[pulumi.Input[str]] = None,
                               sidecar: Optional[pulumi.Input[str]] = None,
                               sysdig_access_key: Optional[pulumi.Input[str]] = None,
                               sysdig_logging: Optional[pulumi.Input[str]] = None,
                               workload_agent_image: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetFargateWorkloadAgentResult]
Copy
func GetFargateWorkloadAgent(ctx *Context, args *GetFargateWorkloadAgentArgs, opts ...InvokeOption) (*GetFargateWorkloadAgentResult, error)
func GetFargateWorkloadAgentOutput(ctx *Context, args *GetFargateWorkloadAgentOutputArgs, opts ...InvokeOption) GetFargateWorkloadAgentResultOutput
Copy

> Note: This function is named GetFargateWorkloadAgent in the Go SDK.

public static class GetFargateWorkloadAgent 
{
    public static Task<GetFargateWorkloadAgentResult> InvokeAsync(GetFargateWorkloadAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetFargateWorkloadAgentResult> Invoke(GetFargateWorkloadAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFargateWorkloadAgentResult> getFargateWorkloadAgent(GetFargateWorkloadAgentArgs args, InvokeOptions options)
public static Output<GetFargateWorkloadAgentResult> getFargateWorkloadAgent(GetFargateWorkloadAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: sysdig:index/getFargateWorkloadAgent:getFargateWorkloadAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ContainerDefinitions This property is required. string
The input Fargate container definitions to instrument with the Sysdig workload agent.
WorkloadAgentImage This property is required. string
The Sysdig workload agent image.
BarePdigOnContainers List<string>
A list of containers in this data source to be instrumented with bare pdig.
CollectorHost string
The Sysdig Collector host to connect to.
CollectorPort string
The Sysdig Collector port.
Id string
IgnoreContainers List<string>
A list of containers in this data source that should not be instrumented.
ImageAuthSecret string
The registry authentication secret.
InstrumentationCpu double
The number of CPU units for the instrumentation container.
InstrumentationEssential bool
false by default. If true the instrumentation container will be marked as essential.
InstrumentationMemoryLimit double
The maximum amount (in MiB) of memory for the instrumentation container.
InstrumentationMemoryReservation double
The minimum amount (in MiB) of memory reserved for the instrumentation container.
LogConfiguration GetFargateWorkloadAgentLogConfiguration
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
OrchestratorHost string
OrchestratorPort string
Priority string
The priority mode for the workload agent. Can be availability (by default) or security.
Sidecar string
SysdigAccessKey string
The Sysdig Agent access key, available in the Sysdig Secure UI.
SysdigLogging string
The instrumentation logging level: trace, debug, info, warning, error, silent.
ContainerDefinitions This property is required. string
The input Fargate container definitions to instrument with the Sysdig workload agent.
WorkloadAgentImage This property is required. string
The Sysdig workload agent image.
BarePdigOnContainers []string
A list of containers in this data source to be instrumented with bare pdig.
CollectorHost string
The Sysdig Collector host to connect to.
CollectorPort string
The Sysdig Collector port.
Id string
IgnoreContainers []string
A list of containers in this data source that should not be instrumented.
ImageAuthSecret string
The registry authentication secret.
InstrumentationCpu float64
The number of CPU units for the instrumentation container.
InstrumentationEssential bool
false by default. If true the instrumentation container will be marked as essential.
InstrumentationMemoryLimit float64
The maximum amount (in MiB) of memory for the instrumentation container.
InstrumentationMemoryReservation float64
The minimum amount (in MiB) of memory reserved for the instrumentation container.
LogConfiguration GetFargateWorkloadAgentLogConfiguration
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
OrchestratorHost string
OrchestratorPort string
Priority string
The priority mode for the workload agent. Can be availability (by default) or security.
Sidecar string
SysdigAccessKey string
The Sysdig Agent access key, available in the Sysdig Secure UI.
SysdigLogging string
The instrumentation logging level: trace, debug, info, warning, error, silent.
containerDefinitions This property is required. String
The input Fargate container definitions to instrument with the Sysdig workload agent.
workloadAgentImage This property is required. String
The Sysdig workload agent image.
barePdigOnContainers List<String>
A list of containers in this data source to be instrumented with bare pdig.
collectorHost String
The Sysdig Collector host to connect to.
collectorPort String
The Sysdig Collector port.
id String
ignoreContainers List<String>
A list of containers in this data source that should not be instrumented.
imageAuthSecret String
The registry authentication secret.
instrumentationCpu Double
The number of CPU units for the instrumentation container.
instrumentationEssential Boolean
false by default. If true the instrumentation container will be marked as essential.
instrumentationMemoryLimit Double
The maximum amount (in MiB) of memory for the instrumentation container.
instrumentationMemoryReservation Double
The minimum amount (in MiB) of memory reserved for the instrumentation container.
logConfiguration GetFargateWorkloadAgentLogConfiguration
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
orchestratorHost String
orchestratorPort String
priority String
The priority mode for the workload agent. Can be availability (by default) or security.
sidecar String
sysdigAccessKey String
The Sysdig Agent access key, available in the Sysdig Secure UI.
sysdigLogging String
The instrumentation logging level: trace, debug, info, warning, error, silent.
containerDefinitions This property is required. string
The input Fargate container definitions to instrument with the Sysdig workload agent.
workloadAgentImage This property is required. string
The Sysdig workload agent image.
barePdigOnContainers string[]
A list of containers in this data source to be instrumented with bare pdig.
collectorHost string
The Sysdig Collector host to connect to.
collectorPort string
The Sysdig Collector port.
id string
ignoreContainers string[]
A list of containers in this data source that should not be instrumented.
imageAuthSecret string
The registry authentication secret.
instrumentationCpu number
The number of CPU units for the instrumentation container.
instrumentationEssential boolean
false by default. If true the instrumentation container will be marked as essential.
instrumentationMemoryLimit number
The maximum amount (in MiB) of memory for the instrumentation container.
instrumentationMemoryReservation number
The minimum amount (in MiB) of memory reserved for the instrumentation container.
logConfiguration GetFargateWorkloadAgentLogConfiguration
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
orchestratorHost string
orchestratorPort string
priority string
The priority mode for the workload agent. Can be availability (by default) or security.
sidecar string
sysdigAccessKey string
The Sysdig Agent access key, available in the Sysdig Secure UI.
sysdigLogging string
The instrumentation logging level: trace, debug, info, warning, error, silent.
container_definitions This property is required. str
The input Fargate container definitions to instrument with the Sysdig workload agent.
workload_agent_image This property is required. str
The Sysdig workload agent image.
bare_pdig_on_containers Sequence[str]
A list of containers in this data source to be instrumented with bare pdig.
collector_host str
The Sysdig Collector host to connect to.
collector_port str
The Sysdig Collector port.
id str
ignore_containers Sequence[str]
A list of containers in this data source that should not be instrumented.
image_auth_secret str
The registry authentication secret.
instrumentation_cpu float
The number of CPU units for the instrumentation container.
instrumentation_essential bool
false by default. If true the instrumentation container will be marked as essential.
instrumentation_memory_limit float
The maximum amount (in MiB) of memory for the instrumentation container.
instrumentation_memory_reservation float
The minimum amount (in MiB) of memory reserved for the instrumentation container.
log_configuration GetFargateWorkloadAgentLogConfiguration
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
orchestrator_host str
orchestrator_port str
priority str
The priority mode for the workload agent. Can be availability (by default) or security.
sidecar str
sysdig_access_key str
The Sysdig Agent access key, available in the Sysdig Secure UI.
sysdig_logging str
The instrumentation logging level: trace, debug, info, warning, error, silent.
containerDefinitions This property is required. String
The input Fargate container definitions to instrument with the Sysdig workload agent.
workloadAgentImage This property is required. String
The Sysdig workload agent image.
barePdigOnContainers List<String>
A list of containers in this data source to be instrumented with bare pdig.
collectorHost String
The Sysdig Collector host to connect to.
collectorPort String
The Sysdig Collector port.
id String
ignoreContainers List<String>
A list of containers in this data source that should not be instrumented.
imageAuthSecret String
The registry authentication secret.
instrumentationCpu Number
The number of CPU units for the instrumentation container.
instrumentationEssential Boolean
false by default. If true the instrumentation container will be marked as essential.
instrumentationMemoryLimit Number
The maximum amount (in MiB) of memory for the instrumentation container.
instrumentationMemoryReservation Number
The minimum amount (in MiB) of memory reserved for the instrumentation container.
logConfiguration Property Map
Configuration for the awslogs driver on the instrumentation container. All three values must be specified if instrumentation logging is desired:
orchestratorHost String
orchestratorPort String
priority String
The priority mode for the workload agent. Can be availability (by default) or security.
sidecar String
sysdigAccessKey String
The Sysdig Agent access key, available in the Sysdig Secure UI.
sysdigLogging String
The instrumentation logging level: trace, debug, info, warning, error, silent.

getFargateWorkloadAgent Result

The following output properties are available:

Supporting Types

GetFargateWorkloadAgentLogConfiguration

Group This property is required. string
The name of the existing log group for instrumentation logs
Region This property is required. string
The AWS region where the target log group resides
StreamPrefix This property is required. string
Prefix for the instrumentation log stream
Group This property is required. string
The name of the existing log group for instrumentation logs
Region This property is required. string
The AWS region where the target log group resides
StreamPrefix This property is required. string
Prefix for the instrumentation log stream
group This property is required. String
The name of the existing log group for instrumentation logs
region This property is required. String
The AWS region where the target log group resides
streamPrefix This property is required. String
Prefix for the instrumentation log stream
group This property is required. string
The name of the existing log group for instrumentation logs
region This property is required. string
The AWS region where the target log group resides
streamPrefix This property is required. string
Prefix for the instrumentation log stream
group This property is required. str
The name of the existing log group for instrumentation logs
region This property is required. str
The AWS region where the target log group resides
stream_prefix This property is required. str
Prefix for the instrumentation log stream
group This property is required. String
The name of the existing log group for instrumentation logs
region This property is required. String
The AWS region where the target log group resides
streamPrefix This property is required. String
Prefix for the instrumentation log stream

Package Details

Repository
sysdig sysdiglabs/terraform-provider-sysdig
License
Notes
This Pulumi package is based on the sysdig Terraform Provider.
sysdig 1.53.0 published on Thursday, Apr 17, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig