com.pulumi.splunk.OutputsTcpGroup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of splunk Show documentation
Show all versions of splunk Show documentation
A Pulumi package for creating and managing splunk cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.splunk;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.splunk.OutputsTcpGroupArgs;
import com.pulumi.splunk.Utilities;
import com.pulumi.splunk.inputs.OutputsTcpGroupState;
import com.pulumi.splunk.outputs.OutputsTcpGroupAcl;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import javax.annotation.Nullable;
/**
* ## # Resource: splunk.OutputsTcpGroup
*
* Access to the configuration of a group of one or more data forwarding destinations.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.splunk.OutputsTcpGroup;
* import com.pulumi.splunk.OutputsTcpGroupArgs;
* 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 tcpGroup = new OutputsTcpGroup("tcpGroup", OutputsTcpGroupArgs.builder()
* .name("tcp-group")
* .disabled(false)
* .dropEventsOnQueueFull(60)
* .sendCookedData(true)
* .maxQueueSize("100KB")
* .servers(
* "1.1.1.1:1234",
* "2.2.2.2:1234")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
*/
@ResourceType(type="splunk:index/outputsTcpGroup:OutputsTcpGroup")
public class OutputsTcpGroup extends com.pulumi.resources.CustomResource {
/**
* The app/user context that is the namespace for the resource
*
*/
@Export(name="acl", refs={OutputsTcpGroupAcl.class}, tree="[0]")
private Output acl;
/**
* @return The app/user context that is the namespace for the resource
*
*/
public Output acl() {
return this.acl;
}
/**
* If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
*/
@Export(name="compressed", refs={Boolean.class}, tree="[0]")
private Output compressed;
/**
* @return If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
*/
public Output compressed() {
return this.compressed;
}
/**
* If true, disables the group.
*
*/
@Export(name="disabled", refs={Boolean.class}, tree="[0]")
private Output disabled;
/**
* @return If true, disables the group.
*
*/
public Output disabled() {
return this.disabled;
}
/**
* If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
*/
@Export(name="dropEventsOnQueueFull", refs={Integer.class}, tree="[0]")
private Output dropEventsOnQueueFull;
/**
* @return If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
*/
public Output dropEventsOnQueueFull() {
return this.dropEventsOnQueueFull;
}
/**
* How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
*/
@Export(name="heartbeatFrequency", refs={Integer.class}, tree="[0]")
private Output heartbeatFrequency;
/**
* @return How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
*/
public Output heartbeatFrequency() {
return this.heartbeatFrequency;
}
/**
* Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
*/
@Export(name="maxQueueSize", refs={String.class}, tree="[0]")
private Output maxQueueSize;
/**
* @return Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
*/
public Output maxQueueSize() {
return this.maxQueueSize;
}
/**
* Valid values: (tcpout | syslog). Specifies the type of output processor.
*
*/
@Export(name="method", refs={String.class}, tree="[0]")
private Output method;
/**
* @return Valid values: (tcpout | syslog). Specifies the type of output processor.
*
*/
public Output method() {
return this.method;
}
/**
* The name of the group of receivers.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the group of receivers.
*
*/
public Output name() {
return this.name;
}
/**
* If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
*/
@Export(name="sendCookedData", refs={Boolean.class}, tree="[0]")
private Output sendCookedData;
/**
* @return If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
*/
public Output sendCookedData() {
return this.sendCookedData;
}
/**
* Comma-separated list of servers to include in the group.
*
*/
@Export(name="servers", refs={List.class,String.class}, tree="[0,1]")
private Output> servers;
/**
* @return Comma-separated list of servers to include in the group.
*
*/
public Output> servers() {
return this.servers;
}
/**
* Token value generated by the indexer after configuration.
*
*/
@Export(name="token", refs={String.class}, tree="[0]")
private Output token;
/**
* @return Token value generated by the indexer after configuration.
*
*/
public Output token() {
return this.token;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public OutputsTcpGroup(java.lang.String name) {
this(name, OutputsTcpGroupArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public OutputsTcpGroup(java.lang.String name, OutputsTcpGroupArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public OutputsTcpGroup(java.lang.String name, OutputsTcpGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("splunk:index/outputsTcpGroup:OutputsTcpGroup", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private OutputsTcpGroup(java.lang.String name, Output id, @Nullable OutputsTcpGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("splunk:index/outputsTcpGroup:OutputsTcpGroup", name, state, makeResourceOptions(options, id), false);
}
private static OutputsTcpGroupArgs makeArgs(OutputsTcpGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? OutputsTcpGroupArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static OutputsTcpGroup get(java.lang.String name, Output id, @Nullable OutputsTcpGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new OutputsTcpGroup(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy