published on Tuesday, Mar 3, 2026 by elastic
published on Tuesday, Mar 3, 2026 by elastic
Creates a new Fleet Agent Policy. See https://www.elastic.co/guide/en/fleet/current/agent-policy.html
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const testPolicy = new elasticstack.FleetAgentPolicy("test_policy", {
name: "Test Policy",
namespace: "default",
description: "Test Agent Policy",
sysMonitoring: true,
monitorLogs: true,
monitorMetrics: true,
spaceIds: ["default"],
hostNameFormat: "hostname",
globalDataTags: {
first_tag: {
stringValue: "tag_value",
},
second_tag: {
numberValue: 1.2,
},
},
advancedMonitoringOptions: {
httpMonitoringEndpoint: {
enabled: true,
host: "localhost",
port: 6791,
bufferEnabled: false,
pprofEnabled: false,
},
diagnostics: {
rateLimits: {
interval: "5m",
burst: 3,
},
fileUploader: {
initDuration: "2s",
backoffDuration: "2m",
maxRetries: 5,
},
},
},
});
import pulumi
import pulumi_elasticstack as elasticstack
test_policy = elasticstack.FleetAgentPolicy("test_policy",
name="Test Policy",
namespace="default",
description="Test Agent Policy",
sys_monitoring=True,
monitor_logs=True,
monitor_metrics=True,
space_ids=["default"],
host_name_format="hostname",
global_data_tags={
"first_tag": {
"string_value": "tag_value",
},
"second_tag": {
"number_value": 1.2,
},
},
advanced_monitoring_options={
"http_monitoring_endpoint": {
"enabled": True,
"host": "localhost",
"port": 6791,
"buffer_enabled": False,
"pprof_enabled": False,
},
"diagnostics": {
"rate_limits": {
"interval": "5m",
"burst": 3,
},
"file_uploader": {
"init_duration": "2s",
"backoff_duration": "2m",
"max_retries": 5,
},
},
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := elasticstack.NewFleetAgentPolicy(ctx, "test_policy", &elasticstack.FleetAgentPolicyArgs{
Name: pulumi.String("Test Policy"),
Namespace: pulumi.String("default"),
Description: pulumi.String("Test Agent Policy"),
SysMonitoring: pulumi.Bool(true),
MonitorLogs: pulumi.Bool(true),
MonitorMetrics: pulumi.Bool(true),
SpaceIds: pulumi.StringArray{
pulumi.String("default"),
},
HostNameFormat: pulumi.String("hostname"),
GlobalDataTags: elasticstack.FleetAgentPolicyGlobalDataTagsMap{
"first_tag": &elasticstack.FleetAgentPolicyGlobalDataTagsArgs{
StringValue: pulumi.String("tag_value"),
},
"second_tag": &elasticstack.FleetAgentPolicyGlobalDataTagsArgs{
NumberValue: pulumi.Float64(1.2),
},
},
AdvancedMonitoringOptions: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsArgs{
HttpMonitoringEndpoint: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs{
Enabled: pulumi.Bool(true),
Host: pulumi.String("localhost"),
Port: pulumi.Float64(6791),
BufferEnabled: pulumi.Bool(false),
PprofEnabled: pulumi.Bool(false),
},
Diagnostics: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs{
RateLimits: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs{
Interval: pulumi.String("5m"),
Burst: pulumi.Float64(3),
},
FileUploader: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs{
InitDuration: pulumi.String("2s"),
BackoffDuration: pulumi.String("2m"),
MaxRetries: pulumi.Float64(5),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var testPolicy = new Elasticstack.FleetAgentPolicy("test_policy", new()
{
Name = "Test Policy",
Namespace = "default",
Description = "Test Agent Policy",
SysMonitoring = true,
MonitorLogs = true,
MonitorMetrics = true,
SpaceIds = new[]
{
"default",
},
HostNameFormat = "hostname",
GlobalDataTags =
{
{ "first_tag", new Elasticstack.Inputs.FleetAgentPolicyGlobalDataTagsArgs
{
StringValue = "tag_value",
} },
{ "second_tag", new Elasticstack.Inputs.FleetAgentPolicyGlobalDataTagsArgs
{
NumberValue = 1.2,
} },
},
AdvancedMonitoringOptions = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsArgs
{
HttpMonitoringEndpoint = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs
{
Enabled = true,
Host = "localhost",
Port = 6791,
BufferEnabled = false,
PprofEnabled = false,
},
Diagnostics = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs
{
RateLimits = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs
{
Interval = "5m",
Burst = 3,
},
FileUploader = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs
{
InitDuration = "2s",
BackoffDuration = "2m",
MaxRetries = 5,
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.FleetAgentPolicy;
import com.pulumi.elasticstack.FleetAgentPolicyArgs;
import com.pulumi.elasticstack.inputs.FleetAgentPolicyAdvancedMonitoringOptionsArgs;
import com.pulumi.elasticstack.inputs.FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs;
import com.pulumi.elasticstack.inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs;
import com.pulumi.elasticstack.inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs;
import com.pulumi.elasticstack.inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs;
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) {
var testPolicy = new FleetAgentPolicy("testPolicy", FleetAgentPolicyArgs.builder()
.name("Test Policy")
.namespace("default")
.description("Test Agent Policy")
.sysMonitoring(true)
.monitorLogs(true)
.monitorMetrics(true)
.spaceIds("default")
.hostNameFormat("hostname")
.globalDataTags(Map.ofEntries(
Map.entry("first_tag", FleetAgentPolicyGlobalDataTagsArgs.builder()
.stringValue("tag_value")
.build()),
Map.entry("second_tag", FleetAgentPolicyGlobalDataTagsArgs.builder()
.numberValue(1.2)
.build())
))
.advancedMonitoringOptions(FleetAgentPolicyAdvancedMonitoringOptionsArgs.builder()
.httpMonitoringEndpoint(FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs.builder()
.enabled(true)
.host("localhost")
.port(6791.0)
.bufferEnabled(false)
.pprofEnabled(false)
.build())
.diagnostics(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs.builder()
.rateLimits(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs.builder()
.interval("5m")
.burst(3.0)
.build())
.fileUploader(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs.builder()
.initDuration("2s")
.backoffDuration("2m")
.maxRetries(5.0)
.build())
.build())
.build())
.build());
}
}
resources:
testPolicy:
type: elasticstack:FleetAgentPolicy
name: test_policy
properties:
name: Test Policy
namespace: default
description: Test Agent Policy
sysMonitoring: true
monitorLogs: true
monitorMetrics: true
spaceIds:
- default
hostNameFormat: hostname
globalDataTags:
first_tag:
stringValue: tag_value
second_tag:
numberValue: 1.2
advancedMonitoringOptions:
httpMonitoringEndpoint:
enabled: true
host: localhost
port: 6791
bufferEnabled: false
pprofEnabled: false
diagnostics:
rateLimits:
interval: 5m
burst: 3
fileUploader:
initDuration: 2s
backoffDuration: 2m
maxRetries: 5
Create FleetAgentPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FleetAgentPolicy(name: string, args: FleetAgentPolicyArgs, opts?: CustomResourceOptions);@overload
def FleetAgentPolicy(resource_name: str,
args: FleetAgentPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FleetAgentPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
namespace: Optional[str] = None,
monitor_metrics: Optional[bool] = None,
data_output_id: Optional[str] = None,
description: Optional[str] = None,
download_source_id: Optional[str] = None,
fleet_server_host_id: Optional[str] = None,
global_data_tags: Optional[Mapping[str, FleetAgentPolicyGlobalDataTagsArgs]] = None,
host_name_format: Optional[str] = None,
inactivity_timeout: Optional[str] = None,
advanced_monitoring_options: Optional[FleetAgentPolicyAdvancedMonitoringOptionsArgs] = None,
monitor_logs: Optional[bool] = None,
advanced_settings: Optional[FleetAgentPolicyAdvancedSettingsArgs] = None,
name: Optional[str] = None,
monitoring_output_id: Optional[str] = None,
policy_id: Optional[str] = None,
required_versions: Optional[Mapping[str, float]] = None,
skip_destroy: Optional[bool] = None,
space_ids: Optional[Sequence[str]] = None,
supports_agentless: Optional[bool] = None,
sys_monitoring: Optional[bool] = None,
unenrollment_timeout: Optional[str] = None)func NewFleetAgentPolicy(ctx *Context, name string, args FleetAgentPolicyArgs, opts ...ResourceOption) (*FleetAgentPolicy, error)public FleetAgentPolicy(string name, FleetAgentPolicyArgs args, CustomResourceOptions? opts = null)
public FleetAgentPolicy(String name, FleetAgentPolicyArgs args)
public FleetAgentPolicy(String name, FleetAgentPolicyArgs args, CustomResourceOptions options)
type: elasticstack:FleetAgentPolicy
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 FleetAgentPolicyArgs
- 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 FleetAgentPolicyArgs
- 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 FleetAgentPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetAgentPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetAgentPolicyArgs
- 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 fleetAgentPolicyResource = new Elasticstack.FleetAgentPolicy("fleetAgentPolicyResource", new()
{
Namespace = "string",
MonitorMetrics = false,
DataOutputId = "string",
Description = "string",
DownloadSourceId = "string",
FleetServerHostId = "string",
GlobalDataTags =
{
{ "string", new Elasticstack.Inputs.FleetAgentPolicyGlobalDataTagsArgs
{
NumberValue = 0,
StringValue = "string",
} },
},
HostNameFormat = "string",
InactivityTimeout = "string",
AdvancedMonitoringOptions = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsArgs
{
Diagnostics = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs
{
FileUploader = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs
{
BackoffDuration = "string",
InitDuration = "string",
MaxRetries = 0,
},
RateLimits = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs
{
Burst = 0,
Interval = "string",
},
},
HttpMonitoringEndpoint = new Elasticstack.Inputs.FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs
{
BufferEnabled = false,
Enabled = false,
Host = "string",
Port = 0,
PprofEnabled = false,
},
},
MonitorLogs = false,
AdvancedSettings = new Elasticstack.Inputs.FleetAgentPolicyAdvancedSettingsArgs
{
DownloadTargetDirectory = "string",
DownloadTimeout = "string",
GoMaxProcs = 0,
LoggingFilesInterval = "string",
LoggingFilesKeepfiles = 0,
LoggingFilesRotateeverybytes = 0,
LoggingLevel = "string",
LoggingMetricsPeriod = "string",
LoggingToFiles = false,
MonitoringRuntimeExperimental = "string",
},
Name = "string",
MonitoringOutputId = "string",
PolicyId = "string",
RequiredVersions =
{
{ "string", 0 },
},
SkipDestroy = false,
SpaceIds = new[]
{
"string",
},
SupportsAgentless = false,
SysMonitoring = false,
UnenrollmentTimeout = "string",
});
example, err := elasticstack.NewFleetAgentPolicy(ctx, "fleetAgentPolicyResource", &elasticstack.FleetAgentPolicyArgs{
Namespace: pulumi.String("string"),
MonitorMetrics: pulumi.Bool(false),
DataOutputId: pulumi.String("string"),
Description: pulumi.String("string"),
DownloadSourceId: pulumi.String("string"),
FleetServerHostId: pulumi.String("string"),
GlobalDataTags: elasticstack.FleetAgentPolicyGlobalDataTagsMap{
"string": &elasticstack.FleetAgentPolicyGlobalDataTagsArgs{
NumberValue: pulumi.Float64(0),
StringValue: pulumi.String("string"),
},
},
HostNameFormat: pulumi.String("string"),
InactivityTimeout: pulumi.String("string"),
AdvancedMonitoringOptions: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsArgs{
Diagnostics: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs{
FileUploader: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs{
BackoffDuration: pulumi.String("string"),
InitDuration: pulumi.String("string"),
MaxRetries: pulumi.Float64(0),
},
RateLimits: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs{
Burst: pulumi.Float64(0),
Interval: pulumi.String("string"),
},
},
HttpMonitoringEndpoint: &elasticstack.FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs{
BufferEnabled: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
PprofEnabled: pulumi.Bool(false),
},
},
MonitorLogs: pulumi.Bool(false),
AdvancedSettings: &elasticstack.FleetAgentPolicyAdvancedSettingsArgs{
DownloadTargetDirectory: pulumi.String("string"),
DownloadTimeout: pulumi.String("string"),
GoMaxProcs: pulumi.Float64(0),
LoggingFilesInterval: pulumi.String("string"),
LoggingFilesKeepfiles: pulumi.Float64(0),
LoggingFilesRotateeverybytes: pulumi.Float64(0),
LoggingLevel: pulumi.String("string"),
LoggingMetricsPeriod: pulumi.String("string"),
LoggingToFiles: pulumi.Bool(false),
MonitoringRuntimeExperimental: pulumi.String("string"),
},
Name: pulumi.String("string"),
MonitoringOutputId: pulumi.String("string"),
PolicyId: pulumi.String("string"),
RequiredVersions: pulumi.Float64Map{
"string": pulumi.Float64(0),
},
SkipDestroy: pulumi.Bool(false),
SpaceIds: pulumi.StringArray{
pulumi.String("string"),
},
SupportsAgentless: pulumi.Bool(false),
SysMonitoring: pulumi.Bool(false),
UnenrollmentTimeout: pulumi.String("string"),
})
var fleetAgentPolicyResource = new FleetAgentPolicy("fleetAgentPolicyResource", FleetAgentPolicyArgs.builder()
.namespace("string")
.monitorMetrics(false)
.dataOutputId("string")
.description("string")
.downloadSourceId("string")
.fleetServerHostId("string")
.globalDataTags(Map.of("string", FleetAgentPolicyGlobalDataTagsArgs.builder()
.numberValue(0.0)
.stringValue("string")
.build()))
.hostNameFormat("string")
.inactivityTimeout("string")
.advancedMonitoringOptions(FleetAgentPolicyAdvancedMonitoringOptionsArgs.builder()
.diagnostics(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs.builder()
.fileUploader(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs.builder()
.backoffDuration("string")
.initDuration("string")
.maxRetries(0.0)
.build())
.rateLimits(FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs.builder()
.burst(0.0)
.interval("string")
.build())
.build())
.httpMonitoringEndpoint(FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs.builder()
.bufferEnabled(false)
.enabled(false)
.host("string")
.port(0.0)
.pprofEnabled(false)
.build())
.build())
.monitorLogs(false)
.advancedSettings(FleetAgentPolicyAdvancedSettingsArgs.builder()
.downloadTargetDirectory("string")
.downloadTimeout("string")
.goMaxProcs(0.0)
.loggingFilesInterval("string")
.loggingFilesKeepfiles(0.0)
.loggingFilesRotateeverybytes(0.0)
.loggingLevel("string")
.loggingMetricsPeriod("string")
.loggingToFiles(false)
.monitoringRuntimeExperimental("string")
.build())
.name("string")
.monitoringOutputId("string")
.policyId("string")
.requiredVersions(Map.of("string", 0.0))
.skipDestroy(false)
.spaceIds("string")
.supportsAgentless(false)
.sysMonitoring(false)
.unenrollmentTimeout("string")
.build());
fleet_agent_policy_resource = elasticstack.FleetAgentPolicy("fleetAgentPolicyResource",
namespace="string",
monitor_metrics=False,
data_output_id="string",
description="string",
download_source_id="string",
fleet_server_host_id="string",
global_data_tags={
"string": {
"number_value": 0,
"string_value": "string",
},
},
host_name_format="string",
inactivity_timeout="string",
advanced_monitoring_options={
"diagnostics": {
"file_uploader": {
"backoff_duration": "string",
"init_duration": "string",
"max_retries": 0,
},
"rate_limits": {
"burst": 0,
"interval": "string",
},
},
"http_monitoring_endpoint": {
"buffer_enabled": False,
"enabled": False,
"host": "string",
"port": 0,
"pprof_enabled": False,
},
},
monitor_logs=False,
advanced_settings={
"download_target_directory": "string",
"download_timeout": "string",
"go_max_procs": 0,
"logging_files_interval": "string",
"logging_files_keepfiles": 0,
"logging_files_rotateeverybytes": 0,
"logging_level": "string",
"logging_metrics_period": "string",
"logging_to_files": False,
"monitoring_runtime_experimental": "string",
},
name="string",
monitoring_output_id="string",
policy_id="string",
required_versions={
"string": 0,
},
skip_destroy=False,
space_ids=["string"],
supports_agentless=False,
sys_monitoring=False,
unenrollment_timeout="string")
const fleetAgentPolicyResource = new elasticstack.FleetAgentPolicy("fleetAgentPolicyResource", {
namespace: "string",
monitorMetrics: false,
dataOutputId: "string",
description: "string",
downloadSourceId: "string",
fleetServerHostId: "string",
globalDataTags: {
string: {
numberValue: 0,
stringValue: "string",
},
},
hostNameFormat: "string",
inactivityTimeout: "string",
advancedMonitoringOptions: {
diagnostics: {
fileUploader: {
backoffDuration: "string",
initDuration: "string",
maxRetries: 0,
},
rateLimits: {
burst: 0,
interval: "string",
},
},
httpMonitoringEndpoint: {
bufferEnabled: false,
enabled: false,
host: "string",
port: 0,
pprofEnabled: false,
},
},
monitorLogs: false,
advancedSettings: {
downloadTargetDirectory: "string",
downloadTimeout: "string",
goMaxProcs: 0,
loggingFilesInterval: "string",
loggingFilesKeepfiles: 0,
loggingFilesRotateeverybytes: 0,
loggingLevel: "string",
loggingMetricsPeriod: "string",
loggingToFiles: false,
monitoringRuntimeExperimental: "string",
},
name: "string",
monitoringOutputId: "string",
policyId: "string",
requiredVersions: {
string: 0,
},
skipDestroy: false,
spaceIds: ["string"],
supportsAgentless: false,
sysMonitoring: false,
unenrollmentTimeout: "string",
});
type: elasticstack:FleetAgentPolicy
properties:
advancedMonitoringOptions:
diagnostics:
fileUploader:
backoffDuration: string
initDuration: string
maxRetries: 0
rateLimits:
burst: 0
interval: string
httpMonitoringEndpoint:
bufferEnabled: false
enabled: false
host: string
port: 0
pprofEnabled: false
advancedSettings:
downloadTargetDirectory: string
downloadTimeout: string
goMaxProcs: 0
loggingFilesInterval: string
loggingFilesKeepfiles: 0
loggingFilesRotateeverybytes: 0
loggingLevel: string
loggingMetricsPeriod: string
loggingToFiles: false
monitoringRuntimeExperimental: string
dataOutputId: string
description: string
downloadSourceId: string
fleetServerHostId: string
globalDataTags:
string:
numberValue: 0
stringValue: string
hostNameFormat: string
inactivityTimeout: string
monitorLogs: false
monitorMetrics: false
monitoringOutputId: string
name: string
namespace: string
policyId: string
requiredVersions:
string: 0
skipDestroy: false
spaceIds:
- string
supportsAgentless: false
sysMonitoring: false
unenrollmentTimeout: string
FleetAgentPolicy 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 FleetAgentPolicy resource accepts the following input properties:
- Namespace string
- The namespace of the agent policy.
- Advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- Advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- Data
Output stringId - The identifier for the data output.
- Description string
- The description of the agent policy.
- Download
Source stringId - The identifier for the Elastic Agent binary download server.
- Fleet
Server stringHost Id - The identifier for the Fleet server host.
-
Dictionary<string, Fleet
Agent Policy Global Data Tags Args> - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- Host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- Inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- Monitor
Logs bool - Enable collection of agent logs.
- Monitor
Metrics bool - Enable collection of agent metrics.
- Monitoring
Output stringId - The identifier for monitoring output.
- Name string
- The name of the agent policy.
- Policy
Id string - Unique identifier of the agent policy.
- Required
Versions Dictionary<string, double> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- Skip
Destroy bool - Space
Ids List<string> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- Supports
Agentless bool - Set to true to enable agentless data collection.
- Sys
Monitoring bool - Enable collection of system logs and metrics.
- Unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- Namespace string
- The namespace of the agent policy.
- Advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options Args - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- Advanced
Settings FleetAgent Policy Advanced Settings Args - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- Data
Output stringId - The identifier for the data output.
- Description string
- The description of the agent policy.
- Download
Source stringId - The identifier for the Elastic Agent binary download server.
- Fleet
Server stringHost Id - The identifier for the Fleet server host.
-
map[string]Fleet
Agent Policy Global Data Tags Args - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- Host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- Inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- Monitor
Logs bool - Enable collection of agent logs.
- Monitor
Metrics bool - Enable collection of agent metrics.
- Monitoring
Output stringId - The identifier for monitoring output.
- Name string
- The name of the agent policy.
- Policy
Id string - Unique identifier of the agent policy.
- Required
Versions map[string]float64 - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- Skip
Destroy bool - Space
Ids []string - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- Supports
Agentless bool - Set to true to enable agentless data collection.
- Sys
Monitoring bool - Enable collection of system logs and metrics.
- Unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- namespace String
- The namespace of the agent policy.
- advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output StringId - The identifier for the data output.
- description String
- The description of the agent policy.
- download
Source StringId - The identifier for the Elastic Agent binary download server.
- fleet
Server StringHost Id - The identifier for the Fleet server host.
-
Map<String,Fleet
Agent Policy Global Data Tags Args> - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name StringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout String - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs Boolean - Enable collection of agent logs.
- monitor
Metrics Boolean - Enable collection of agent metrics.
- monitoring
Output StringId - The identifier for monitoring output.
- name String
- The name of the agent policy.
- policy
Id String - Unique identifier of the agent policy.
- required
Versions Map<String,Double> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy Boolean - space
Ids List<String> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless Boolean - Set to true to enable agentless data collection.
- sys
Monitoring Boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout String - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- namespace string
- The namespace of the agent policy.
- advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output stringId - The identifier for the data output.
- description string
- The description of the agent policy.
- download
Source stringId - The identifier for the Elastic Agent binary download server.
- fleet
Server stringHost Id - The identifier for the Fleet server host.
-
{[key: string]: Fleet
Agent Policy Global Data Tags Args} - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs boolean - Enable collection of agent logs.
- monitor
Metrics boolean - Enable collection of agent metrics.
- monitoring
Output stringId - The identifier for monitoring output.
- name string
- The name of the agent policy.
- policy
Id string - Unique identifier of the agent policy.
- required
Versions {[key: string]: number} - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy boolean - space
Ids string[] - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless boolean - Set to true to enable agentless data collection.
- sys
Monitoring boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- namespace str
- The namespace of the agent policy.
- advanced_
monitoring_ Fleetoptions Agent Policy Advanced Monitoring Options Args - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced_
settings FleetAgent Policy Advanced Settings Args - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data_
output_ strid - The identifier for the data output.
- description str
- The description of the agent policy.
- download_
source_ strid - The identifier for the Elastic Agent binary download server.
- fleet_
server_ strhost_ id - The identifier for the Fleet server host.
-
Mapping[str, Fleet
Agent Policy Global Data Tags Args] - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host_
name_ strformat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity_
timeout str - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor_
logs bool - Enable collection of agent logs.
- monitor_
metrics bool - Enable collection of agent metrics.
- monitoring_
output_ strid - The identifier for monitoring output.
- name str
- The name of the agent policy.
- policy_
id str - Unique identifier of the agent policy.
- required_
versions Mapping[str, float] - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip_
destroy bool - space_
ids Sequence[str] - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports_
agentless bool - Set to true to enable agentless data collection.
- sys_
monitoring bool - Enable collection of system logs and metrics.
- unenrollment_
timeout str - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- namespace String
- The namespace of the agent policy.
- advanced
Monitoring Property MapOptions - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings Property Map - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output StringId - The identifier for the data output.
- description String
- The description of the agent policy.
- download
Source StringId - The identifier for the Elastic Agent binary download server.
- fleet
Server StringHost Id - The identifier for the Fleet server host.
- Map<Property Map>
- User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name StringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout String - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs Boolean - Enable collection of agent logs.
- monitor
Metrics Boolean - Enable collection of agent metrics.
- monitoring
Output StringId - The identifier for monitoring output.
- name String
- The name of the agent policy.
- policy
Id String - Unique identifier of the agent policy.
- required
Versions Map<Number> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy Boolean - space
Ids List<String> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless Boolean - Set to true to enable agentless data collection.
- sys
Monitoring Boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout String - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
Outputs
All input properties are implicitly available as output properties. Additionally, the FleetAgentPolicy 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 FleetAgentPolicy Resource
Get an existing FleetAgentPolicy 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?: FleetAgentPolicyState, opts?: CustomResourceOptions): FleetAgentPolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_monitoring_options: Optional[FleetAgentPolicyAdvancedMonitoringOptionsArgs] = None,
advanced_settings: Optional[FleetAgentPolicyAdvancedSettingsArgs] = None,
data_output_id: Optional[str] = None,
description: Optional[str] = None,
download_source_id: Optional[str] = None,
fleet_server_host_id: Optional[str] = None,
global_data_tags: Optional[Mapping[str, FleetAgentPolicyGlobalDataTagsArgs]] = None,
host_name_format: Optional[str] = None,
inactivity_timeout: Optional[str] = None,
monitor_logs: Optional[bool] = None,
monitor_metrics: Optional[bool] = None,
monitoring_output_id: Optional[str] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
policy_id: Optional[str] = None,
required_versions: Optional[Mapping[str, float]] = None,
skip_destroy: Optional[bool] = None,
space_ids: Optional[Sequence[str]] = None,
supports_agentless: Optional[bool] = None,
sys_monitoring: Optional[bool] = None,
unenrollment_timeout: Optional[str] = None) -> FleetAgentPolicyfunc GetFleetAgentPolicy(ctx *Context, name string, id IDInput, state *FleetAgentPolicyState, opts ...ResourceOption) (*FleetAgentPolicy, error)public static FleetAgentPolicy Get(string name, Input<string> id, FleetAgentPolicyState? state, CustomResourceOptions? opts = null)public static FleetAgentPolicy get(String name, Output<String> id, FleetAgentPolicyState state, CustomResourceOptions options)resources: _: type: elasticstack:FleetAgentPolicy 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.
- Advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- Advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- Data
Output stringId - The identifier for the data output.
- Description string
- The description of the agent policy.
- Download
Source stringId - The identifier for the Elastic Agent binary download server.
- Fleet
Server stringHost Id - The identifier for the Fleet server host.
-
Dictionary<string, Fleet
Agent Policy Global Data Tags Args> - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- Host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- Inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- Monitor
Logs bool - Enable collection of agent logs.
- Monitor
Metrics bool - Enable collection of agent metrics.
- Monitoring
Output stringId - The identifier for monitoring output.
- Name string
- The name of the agent policy.
- Namespace string
- The namespace of the agent policy.
- Policy
Id string - Unique identifier of the agent policy.
- Required
Versions Dictionary<string, double> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- Skip
Destroy bool - Space
Ids List<string> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- Supports
Agentless bool - Set to true to enable agentless data collection.
- Sys
Monitoring bool - Enable collection of system logs and metrics.
- Unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- Advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options Args - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- Advanced
Settings FleetAgent Policy Advanced Settings Args - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- Data
Output stringId - The identifier for the data output.
- Description string
- The description of the agent policy.
- Download
Source stringId - The identifier for the Elastic Agent binary download server.
- Fleet
Server stringHost Id - The identifier for the Fleet server host.
-
map[string]Fleet
Agent Policy Global Data Tags Args - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- Host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- Inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- Monitor
Logs bool - Enable collection of agent logs.
- Monitor
Metrics bool - Enable collection of agent metrics.
- Monitoring
Output stringId - The identifier for monitoring output.
- Name string
- The name of the agent policy.
- Namespace string
- The namespace of the agent policy.
- Policy
Id string - Unique identifier of the agent policy.
- Required
Versions map[string]float64 - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- Skip
Destroy bool - Space
Ids []string - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- Supports
Agentless bool - Set to true to enable agentless data collection.
- Sys
Monitoring bool - Enable collection of system logs and metrics.
- Unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output StringId - The identifier for the data output.
- description String
- The description of the agent policy.
- download
Source StringId - The identifier for the Elastic Agent binary download server.
- fleet
Server StringHost Id - The identifier for the Fleet server host.
-
Map<String,Fleet
Agent Policy Global Data Tags Args> - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name StringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout String - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs Boolean - Enable collection of agent logs.
- monitor
Metrics Boolean - Enable collection of agent metrics.
- monitoring
Output StringId - The identifier for monitoring output.
- name String
- The name of the agent policy.
- namespace String
- The namespace of the agent policy.
- policy
Id String - Unique identifier of the agent policy.
- required
Versions Map<String,Double> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy Boolean - space
Ids List<String> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless Boolean - Set to true to enable agentless data collection.
- sys
Monitoring Boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout String - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- advanced
Monitoring FleetOptions Agent Policy Advanced Monitoring Options - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings FleetAgent Policy Advanced Settings - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output stringId - The identifier for the data output.
- description string
- The description of the agent policy.
- download
Source stringId - The identifier for the Elastic Agent binary download server.
- fleet
Server stringHost Id - The identifier for the Fleet server host.
-
{[key: string]: Fleet
Agent Policy Global Data Tags Args} - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name stringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout string - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs boolean - Enable collection of agent logs.
- monitor
Metrics boolean - Enable collection of agent metrics.
- monitoring
Output stringId - The identifier for monitoring output.
- name string
- The name of the agent policy.
- namespace string
- The namespace of the agent policy.
- policy
Id string - Unique identifier of the agent policy.
- required
Versions {[key: string]: number} - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy boolean - space
Ids string[] - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless boolean - Set to true to enable agentless data collection.
- sys
Monitoring boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout string - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- advanced_
monitoring_ Fleetoptions Agent Policy Advanced Monitoring Options Args - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced_
settings FleetAgent Policy Advanced Settings Args - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data_
output_ strid - The identifier for the data output.
- description str
- The description of the agent policy.
- download_
source_ strid - The identifier for the Elastic Agent binary download server.
- fleet_
server_ strhost_ id - The identifier for the Fleet server host.
-
Mapping[str, Fleet
Agent Policy Global Data Tags Args] - User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host_
name_ strformat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity_
timeout str - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor_
logs bool - Enable collection of agent logs.
- monitor_
metrics bool - Enable collection of agent metrics.
- monitoring_
output_ strid - The identifier for monitoring output.
- name str
- The name of the agent policy.
- namespace str
- The namespace of the agent policy.
- policy_
id str - Unique identifier of the agent policy.
- required_
versions Mapping[str, float] - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip_
destroy bool - space_
ids Sequence[str] - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports_
agentless bool - Set to true to enable agentless data collection.
- sys_
monitoring bool - Enable collection of system logs and metrics.
- unenrollment_
timeout str - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
- advanced
Monitoring Property MapOptions - Advanced monitoring options for the agent policy. Includes HTTP monitoring endpoint configuration and diagnostic settings.
- advanced
Settings Property Map - Advanced agent settings for logging, resource limits, and downloads. These settings configure the behavior of Elastic Agents enrolled in this policy.
- data
Output StringId - The identifier for the data output.
- description String
- The description of the agent policy.
- download
Source StringId - The identifier for the Elastic Agent binary download server.
- fleet
Server StringHost Id - The identifier for the Fleet server host.
- Map<Property Map>
- User-defined data tags to apply to all inputs. Values can be strings (stringvalue) or numbers (numbervalue) but not both. Example -- key1 = {stringvalue = value1}, key2 = {numbervalue = 42}
- host
Name StringFormat - Determines the format of the host.name field in events. Can be 'hostname' (short hostname, e.g., 'myhost') or 'fqdn' (fully qualified domain name, e.g., 'myhost.example.com'). Defaults to 'hostname'.
- inactivity
Timeout String - The inactivity timeout for the agent policy. If an agent does not report within this time period, it will be considered inactive. Supports duration strings (e.g., '30s', '2m', '1h').
- monitor
Logs Boolean - Enable collection of agent logs.
- monitor
Metrics Boolean - Enable collection of agent metrics.
- monitoring
Output StringId - The identifier for monitoring output.
- name String
- The name of the agent policy.
- namespace String
- The namespace of the agent policy.
- policy
Id String - Unique identifier of the agent policy.
- required
Versions Map<Number> - Map of agent versions to target percentages for automatic upgrade. The key is the target version and the value is the percentage of agents to upgrade to that version.
- skip
Destroy Boolean - space
Ids List<String> - The Kibana space IDs that this agent policy should be available in. When not specified, defaults to ["default"]. Note: The order of space IDs does not matter as this is a set.
- supports
Agentless Boolean - Set to true to enable agentless data collection.
- sys
Monitoring Boolean - Enable collection of system logs and metrics.
- unenrollment
Timeout String - The unenrollment timeout for the agent policy. If an agent is inactive for this period, it will be automatically unenrolled. Supports duration strings (e.g., '30s', '2m', '1h').
Supporting Types
FleetAgentPolicyAdvancedMonitoringOptions, FleetAgentPolicyAdvancedMonitoringOptionsArgs
- Diagnostics
Fleet
Agent Policy Advanced Monitoring Options Diagnostics - Diagnostic settings for rate limiting and file upload behavior.
- Http
Monitoring FleetEndpoint Agent Policy Advanced Monitoring Options Http Monitoring Endpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
- Diagnostics
Fleet
Agent Policy Advanced Monitoring Options Diagnostics - Diagnostic settings for rate limiting and file upload behavior.
- Http
Monitoring FleetEndpoint Agent Policy Advanced Monitoring Options Http Monitoring Endpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
- diagnostics
Fleet
Agent Policy Advanced Monitoring Options Diagnostics - Diagnostic settings for rate limiting and file upload behavior.
- http
Monitoring FleetEndpoint Agent Policy Advanced Monitoring Options Http Monitoring Endpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
- diagnostics
Fleet
Agent Policy Advanced Monitoring Options Diagnostics - Diagnostic settings for rate limiting and file upload behavior.
- http
Monitoring FleetEndpoint Agent Policy Advanced Monitoring Options Http Monitoring Endpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
- diagnostics
Fleet
Agent Policy Advanced Monitoring Options Diagnostics - Diagnostic settings for rate limiting and file upload behavior.
- http_
monitoring_ Fleetendpoint Agent Policy Advanced Monitoring Options Http Monitoring Endpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
- diagnostics Property Map
- Diagnostic settings for rate limiting and file upload behavior.
- http
Monitoring Property MapEndpoint - HTTP monitoring endpoint configuration for agent health checks and liveness probes.
FleetAgentPolicyAdvancedMonitoringOptionsDiagnostics, FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsArgs
- File
Uploader FleetAgent Policy Advanced Monitoring Options Diagnostics File Uploader - Diagnostic file upload retry configuration.
- Rate
Limits FleetAgent Policy Advanced Monitoring Options Diagnostics Rate Limits - Rate limiting configuration for diagnostics requests from Fleet.
- File
Uploader FleetAgent Policy Advanced Monitoring Options Diagnostics File Uploader - Diagnostic file upload retry configuration.
- Rate
Limits FleetAgent Policy Advanced Monitoring Options Diagnostics Rate Limits - Rate limiting configuration for diagnostics requests from Fleet.
- file
Uploader FleetAgent Policy Advanced Monitoring Options Diagnostics File Uploader - Diagnostic file upload retry configuration.
- rate
Limits FleetAgent Policy Advanced Monitoring Options Diagnostics Rate Limits - Rate limiting configuration for diagnostics requests from Fleet.
- file
Uploader FleetAgent Policy Advanced Monitoring Options Diagnostics File Uploader - Diagnostic file upload retry configuration.
- rate
Limits FleetAgent Policy Advanced Monitoring Options Diagnostics Rate Limits - Rate limiting configuration for diagnostics requests from Fleet.
- file_
uploader FleetAgent Policy Advanced Monitoring Options Diagnostics File Uploader - Diagnostic file upload retry configuration.
- rate_
limits FleetAgent Policy Advanced Monitoring Options Diagnostics Rate Limits - Rate limiting configuration for diagnostics requests from Fleet.
- file
Uploader Property Map - Diagnostic file upload retry configuration.
- rate
Limits Property Map - Rate limiting configuration for diagnostics requests from Fleet.
FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploader, FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsFileUploaderArgs
- Backoff
Duration string - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- Init
Duration string - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- Max
Retries double - Maximum number of retry attempts for file uploads.
- Backoff
Duration string - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- Init
Duration string - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- Max
Retries float64 - Maximum number of retry attempts for file uploads.
- backoff
Duration String - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- init
Duration String - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- max
Retries Double - Maximum number of retry attempts for file uploads.
- backoff
Duration string - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- init
Duration string - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- max
Retries number - Maximum number of retry attempts for file uploads.
- backoff_
duration str - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- init_
duration str - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- max_
retries float - Maximum number of retry attempts for file uploads.
- backoff
Duration String - Maximum backoff duration between retry attempts (e.g., '1m', '30s').
- init
Duration String - Initial duration before the first retry attempt (e.g., '1s', '500ms').
- max
Retries Number - Maximum number of retry attempts for file uploads.
FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimits, FleetAgentPolicyAdvancedMonitoringOptionsDiagnosticsRateLimitsArgs
FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpoint, FleetAgentPolicyAdvancedMonitoringOptionsHttpMonitoringEndpointArgs
- Buffer
Enabled bool - Enable monitoring buffer for the HTTP endpoint.
- Enabled bool
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- Host string
- Host for the HTTP monitoring endpoint.
- Port double
- Port for the HTTP monitoring endpoint.
- Pprof
Enabled bool - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
- Buffer
Enabled bool - Enable monitoring buffer for the HTTP endpoint.
- Enabled bool
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- Host string
- Host for the HTTP monitoring endpoint.
- Port float64
- Port for the HTTP monitoring endpoint.
- Pprof
Enabled bool - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
- buffer
Enabled Boolean - Enable monitoring buffer for the HTTP endpoint.
- enabled Boolean
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- host String
- Host for the HTTP monitoring endpoint.
- port Double
- Port for the HTTP monitoring endpoint.
- pprof
Enabled Boolean - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
- buffer
Enabled boolean - Enable monitoring buffer for the HTTP endpoint.
- enabled boolean
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- host string
- Host for the HTTP monitoring endpoint.
- port number
- Port for the HTTP monitoring endpoint.
- pprof
Enabled boolean - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
- buffer_
enabled bool - Enable monitoring buffer for the HTTP endpoint.
- enabled bool
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- host str
- Host for the HTTP monitoring endpoint.
- port float
- Port for the HTTP monitoring endpoint.
- pprof_
enabled bool - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
- buffer
Enabled Boolean - Enable monitoring buffer for the HTTP endpoint.
- enabled Boolean
- Enable the HTTP monitoring endpoint. When enabled, exposes a /liveness endpoint for health checks.
- host String
- Host for the HTTP monitoring endpoint.
- port Number
- Port for the HTTP monitoring endpoint.
- pprof
Enabled Boolean - Enable /debug/pprof/* profiling endpoints. Warning: enabling this may pose a security risk if the monitoring endpoint is accessible over a network.
FleetAgentPolicyAdvancedSettings, FleetAgentPolicyAdvancedSettingsArgs
- Download
Target stringDirectory - Target directory for downloading agent updates.
- Download
Timeout string - Timeout for downloading agent updates (e.g., '2h', '30m').
- Go
Max doubleProcs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- Logging
Files stringInterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- Logging
Files doubleKeepfiles - Number of rotated log files to keep.
- Logging
Files doubleRotateeverybytes - Rotate log files when they reach this size in bytes.
- Logging
Level string - Logging level for the agent. Valid values: debug, info, warning, error.
- Logging
Metrics stringPeriod - Period for logging agent metrics (e.g., '30s', '1m').
- Logging
To boolFiles - Enable logging to files.
- Monitoring
Runtime stringExperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
- Download
Target stringDirectory - Target directory for downloading agent updates.
- Download
Timeout string - Timeout for downloading agent updates (e.g., '2h', '30m').
- Go
Max float64Procs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- Logging
Files stringInterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- Logging
Files float64Keepfiles - Number of rotated log files to keep.
- Logging
Files float64Rotateeverybytes - Rotate log files when they reach this size in bytes.
- Logging
Level string - Logging level for the agent. Valid values: debug, info, warning, error.
- Logging
Metrics stringPeriod - Period for logging agent metrics (e.g., '30s', '1m').
- Logging
To boolFiles - Enable logging to files.
- Monitoring
Runtime stringExperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
- download
Target StringDirectory - Target directory for downloading agent updates.
- download
Timeout String - Timeout for downloading agent updates (e.g., '2h', '30m').
- go
Max DoubleProcs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- logging
Files StringInterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- logging
Files DoubleKeepfiles - Number of rotated log files to keep.
- logging
Files DoubleRotateeverybytes - Rotate log files when they reach this size in bytes.
- logging
Level String - Logging level for the agent. Valid values: debug, info, warning, error.
- logging
Metrics StringPeriod - Period for logging agent metrics (e.g., '30s', '1m').
- logging
To BooleanFiles - Enable logging to files.
- monitoring
Runtime StringExperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
- download
Target stringDirectory - Target directory for downloading agent updates.
- download
Timeout string - Timeout for downloading agent updates (e.g., '2h', '30m').
- go
Max numberProcs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- logging
Files stringInterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- logging
Files numberKeepfiles - Number of rotated log files to keep.
- logging
Files numberRotateeverybytes - Rotate log files when they reach this size in bytes.
- logging
Level string - Logging level for the agent. Valid values: debug, info, warning, error.
- logging
Metrics stringPeriod - Period for logging agent metrics (e.g., '30s', '1m').
- logging
To booleanFiles - Enable logging to files.
- monitoring
Runtime stringExperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
- download_
target_ strdirectory - Target directory for downloading agent updates.
- download_
timeout str - Timeout for downloading agent updates (e.g., '2h', '30m').
- go_
max_ floatprocs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- logging_
files_ strinterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- logging_
files_ floatkeepfiles - Number of rotated log files to keep.
- logging_
files_ floatrotateeverybytes - Rotate log files when they reach this size in bytes.
- logging_
level str - Logging level for the agent. Valid values: debug, info, warning, error.
- logging_
metrics_ strperiod - Period for logging agent metrics (e.g., '30s', '1m').
- logging_
to_ boolfiles - Enable logging to files.
- monitoring_
runtime_ strexperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
- download
Target StringDirectory - Target directory for downloading agent updates.
- download
Timeout String - Timeout for downloading agent updates (e.g., '2h', '30m').
- go
Max NumberProcs - Maximum number of CPUs that the agent can use (GOMAXPROCS). Set to 0 to use all available CPUs.
- logging
Files StringInterval - Interval for log file rotation (e.g., '30s', '1m', '1h').
- logging
Files NumberKeepfiles - Number of rotated log files to keep.
- logging
Files NumberRotateeverybytes - Rotate log files when they reach this size in bytes.
- logging
Level String - Logging level for the agent. Valid values: debug, info, warning, error.
- logging
Metrics StringPeriod - Period for logging agent metrics (e.g., '30s', '1m').
- logging
To BooleanFiles - Enable logging to files.
- monitoring
Runtime StringExperimental - Experimental runtime monitoring mode. Valid values: '' (empty string to disable), 'process', 'otel'.
FleetAgentPolicyGlobalDataTags, FleetAgentPolicyGlobalDataTagsArgs
- Number
Value double - Number value for the field. If this is set, string_value must not be defined.
- String
Value string - String value for the field. If this is set, number_value must not be defined.
- Number
Value float64 - Number value for the field. If this is set, string_value must not be defined.
- String
Value string - String value for the field. If this is set, number_value must not be defined.
- number
Value Double - Number value for the field. If this is set, string_value must not be defined.
- string
Value String - String value for the field. If this is set, number_value must not be defined.
- number
Value number - Number value for the field. If this is set, string_value must not be defined.
- string
Value string - String value for the field. If this is set, number_value must not be defined.
- number_
value float - Number value for the field. If this is set, string_value must not be defined.
- string_
value str - String value for the field. If this is set, number_value must not be defined.
- number
Value Number - Number value for the field. If this is set, string_value must not be defined.
- string
Value String - String value for the field. If this is set, number_value must not be defined.
Import
The pulumi import command can be used, for example:
$ pulumi import elasticstack:index/fleetAgentPolicy:FleetAgentPolicy my_policy <space_id>/<fleet_agent_policy_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
published on Tuesday, Mar 3, 2026 by elastic
