elasticstack.getElasticsearchIngestProcessorCommunityId
Explore with Pulumi AI
Helper data source to which can be used to create a processor to compute the Community ID for network flow data as defined in the Community ID Specification. You can use a community ID to correlate network events related to a single flow.
The community ID processor reads network flow data from related Elastic Common Schema (ECS) fields by default. If you use the ECS, no configuration is required.
See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const community = elasticstack.getElasticsearchIngestProcessorCommunityId({});
const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [community.then(community => community.json)]});
import pulumi
import pulumi_elasticstack as elasticstack
community = elasticstack.get_elasticsearch_ingest_processor_community_id()
my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[community.json])
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 {
community, err := elasticstack.GetElasticsearchIngestProcessorCommunityId(ctx, &elasticstack.GetElasticsearchIngestProcessorCommunityIdArgs{}, nil)
if err != nil {
return err
}
_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
Processors: pulumi.StringArray{
pulumi.String(community.Json),
},
})
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 community = Elasticstack.GetElasticsearchIngestProcessorCommunityId.Invoke();
var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
{
Processors = new[]
{
community.Apply(getElasticsearchIngestProcessorCommunityIdResult => getElasticsearchIngestProcessorCommunityIdResult.Json),
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetElasticsearchIngestProcessorCommunityIdArgs;
import com.pulumi.elasticstack.ElasticsearchIngestPipeline;
import com.pulumi.elasticstack.ElasticsearchIngestPipelineArgs;
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 community = ElasticstackFunctions.getElasticsearchIngestProcessorCommunityId();
var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
.processors(community.applyValue(getElasticsearchIngestProcessorCommunityIdResult -> getElasticsearchIngestProcessorCommunityIdResult.json()))
.build());
}
}
resources:
myIngestPipeline:
type: elasticstack:ElasticsearchIngestPipeline
properties:
processors:
- ${community.json}
variables:
community:
fn::invoke:
function: elasticstack:getElasticsearchIngestProcessorCommunityId
arguments: {}
Using getElasticsearchIngestProcessorCommunityId
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 getElasticsearchIngestProcessorCommunityId(args: GetElasticsearchIngestProcessorCommunityIdArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorCommunityIdResult>
function getElasticsearchIngestProcessorCommunityIdOutput(args: GetElasticsearchIngestProcessorCommunityIdOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorCommunityIdResult>
def get_elasticsearch_ingest_processor_community_id(description: Optional[str] = None,
destination_ip: Optional[str] = None,
destination_port: Optional[float] = None,
iana_number: Optional[float] = None,
icmp_code: Optional[float] = None,
icmp_type: Optional[float] = None,
if_: Optional[str] = None,
ignore_failure: Optional[bool] = None,
ignore_missing: Optional[bool] = None,
on_failures: Optional[Sequence[str]] = None,
seed: Optional[float] = None,
source_ip: Optional[str] = None,
source_port: Optional[float] = None,
tag: Optional[str] = None,
target_field: Optional[str] = None,
transport: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorCommunityIdResult
def get_elasticsearch_ingest_processor_community_id_output(description: Optional[pulumi.Input[str]] = None,
destination_ip: Optional[pulumi.Input[str]] = None,
destination_port: Optional[pulumi.Input[float]] = None,
iana_number: Optional[pulumi.Input[float]] = None,
icmp_code: Optional[pulumi.Input[float]] = None,
icmp_type: Optional[pulumi.Input[float]] = None,
if_: Optional[pulumi.Input[str]] = None,
ignore_failure: Optional[pulumi.Input[bool]] = None,
ignore_missing: Optional[pulumi.Input[bool]] = None,
on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
seed: Optional[pulumi.Input[float]] = None,
source_ip: Optional[pulumi.Input[str]] = None,
source_port: Optional[pulumi.Input[float]] = None,
tag: Optional[pulumi.Input[str]] = None,
target_field: Optional[pulumi.Input[str]] = None,
transport: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorCommunityIdResult]
func GetElasticsearchIngestProcessorCommunityId(ctx *Context, args *GetElasticsearchIngestProcessorCommunityIdArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorCommunityIdResult, error)
func GetElasticsearchIngestProcessorCommunityIdOutput(ctx *Context, args *GetElasticsearchIngestProcessorCommunityIdOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorCommunityIdResultOutput
> Note: This function is named GetElasticsearchIngestProcessorCommunityId
in the Go SDK.
public static class GetElasticsearchIngestProcessorCommunityId
{
public static Task<GetElasticsearchIngestProcessorCommunityIdResult> InvokeAsync(GetElasticsearchIngestProcessorCommunityIdArgs args, InvokeOptions? opts = null)
public static Output<GetElasticsearchIngestProcessorCommunityIdResult> Invoke(GetElasticsearchIngestProcessorCommunityIdInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetElasticsearchIngestProcessorCommunityIdResult> getElasticsearchIngestProcessorCommunityId(GetElasticsearchIngestProcessorCommunityIdArgs args, InvokeOptions options)
public static Output<GetElasticsearchIngestProcessorCommunityIdResult> getElasticsearchIngestProcessorCommunityId(GetElasticsearchIngestProcessorCommunityIdArgs args, InvokeOptions options)
fn::invoke:
function: elasticstack:index/getElasticsearchIngestProcessorCommunityId:getElasticsearchIngestProcessorCommunityId
arguments:
# arguments dictionary
The following arguments are supported:
- Description string
- Description of the processor.
- Destination
Ip string - Field containing the destination IP address.
- Destination
Port double - Field containing the destination port.
- Iana
Number double - Field containing the IANA number.
- Icmp
Code double - Field containing the ICMP code.
- Icmp
Type double - Field containing the ICMP type.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- Ignore
Missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - On
Failures List<string> - Handle failures for the processor.
- Seed double
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- Source
Ip string - Field containing the source IP address.
- Source
Port double - Field containing the source port.
- Tag string
- Identifier for the processor.
- Target
Field string - Output field for the community ID.
- Transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- Description string
- Description of the processor.
- Destination
Ip string - Field containing the destination IP address.
- Destination
Port float64 - Field containing the destination port.
- Iana
Number float64 - Field containing the IANA number.
- Icmp
Code float64 - Field containing the ICMP code.
- Icmp
Type float64 - Field containing the ICMP type.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- Ignore
Missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - On
Failures []string - Handle failures for the processor.
- Seed float64
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- Source
Ip string - Field containing the source IP address.
- Source
Port float64 - Field containing the source port.
- Tag string
- Identifier for the processor.
- Target
Field string - Output field for the community ID.
- Transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- description String
- Description of the processor.
- destination
Ip String - Field containing the destination IP address.
- destination
Port Double - Field containing the destination port.
- iana
Number Double - Field containing the IANA number.
- icmp
Code Double - Field containing the ICMP code.
- icmp
Type Double - Field containing the ICMP type.
- if_ String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- ignore
Missing Boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures List<String> - Handle failures for the processor.
- seed Double
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip String - Field containing the source IP address.
- source
Port Double - Field containing the source port.
- tag String
- Identifier for the processor.
- target
Field String - Output field for the community ID.
- transport String
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- description string
- Description of the processor.
- destination
Ip string - Field containing the destination IP address.
- destination
Port number - Field containing the destination port.
- iana
Number number - Field containing the IANA number.
- icmp
Code number - Field containing the ICMP code.
- icmp
Type number - Field containing the ICMP type.
- if string
- Conditionally execute the processor
- ignore
Failure boolean - Ignore failures for the processor.
- ignore
Missing boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures string[] - Handle failures for the processor.
- seed number
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip string - Field containing the source IP address.
- source
Port number - Field containing the source port.
- tag string
- Identifier for the processor.
- target
Field string - Output field for the community ID.
- transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- description str
- Description of the processor.
- destination_
ip str - Field containing the destination IP address.
- destination_
port float - Field containing the destination port.
- iana_
number float - Field containing the IANA number.
- icmp_
code float - Field containing the ICMP code.
- icmp_
type float - Field containing the ICMP type.
- if_ str
- Conditionally execute the processor
- ignore_
failure bool - Ignore failures for the processor.
- ignore_
missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on_
failures Sequence[str] - Handle failures for the processor.
- seed float
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source_
ip str - Field containing the source IP address.
- source_
port float - Field containing the source port.
- tag str
- Identifier for the processor.
- target_
field str - Output field for the community ID.
- transport str
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- description String
- Description of the processor.
- destination
Ip String - Field containing the destination IP address.
- destination
Port Number - Field containing the destination port.
- iana
Number Number - Field containing the IANA number.
- icmp
Code Number - Field containing the ICMP code.
- icmp
Type Number - Field containing the ICMP type.
- if String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- ignore
Missing Boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures List<String> - Handle failures for the processor.
- seed Number
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip String - Field containing the source IP address.
- source
Port Number - Field containing the source port.
- tag String
- Identifier for the processor.
- target
Field String - Output field for the community ID.
- transport String
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
getElasticsearchIngestProcessorCommunityId Result
The following output properties are available:
- Id string
- Internal identifier of the resource
- Json string
- JSON representation of this data source.
- Description string
- Description of the processor.
- Destination
Ip string - Field containing the destination IP address.
- Destination
Port double - Field containing the destination port.
- Iana
Number double - Field containing the IANA number.
- Icmp
Code double - Field containing the ICMP code.
- Icmp
Type double - Field containing the ICMP type.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- Ignore
Missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - On
Failures List<string> - Handle failures for the processor.
- Seed double
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- Source
Ip string - Field containing the source IP address.
- Source
Port double - Field containing the source port.
- Tag string
- Identifier for the processor.
- Target
Field string - Output field for the community ID.
- Transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- Id string
- Internal identifier of the resource
- Json string
- JSON representation of this data source.
- Description string
- Description of the processor.
- Destination
Ip string - Field containing the destination IP address.
- Destination
Port float64 - Field containing the destination port.
- Iana
Number float64 - Field containing the IANA number.
- Icmp
Code float64 - Field containing the ICMP code.
- Icmp
Type float64 - Field containing the ICMP type.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- Ignore
Missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - On
Failures []string - Handle failures for the processor.
- Seed float64
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- Source
Ip string - Field containing the source IP address.
- Source
Port float64 - Field containing the source port.
- Tag string
- Identifier for the processor.
- Target
Field string - Output field for the community ID.
- Transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- id String
- Internal identifier of the resource
- json String
- JSON representation of this data source.
- description String
- Description of the processor.
- destination
Ip String - Field containing the destination IP address.
- destination
Port Double - Field containing the destination port.
- iana
Number Double - Field containing the IANA number.
- icmp
Code Double - Field containing the ICMP code.
- icmp
Type Double - Field containing the ICMP type.
- if_ String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- ignore
Missing Boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures List<String> - Handle failures for the processor.
- seed Double
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip String - Field containing the source IP address.
- source
Port Double - Field containing the source port.
- tag String
- Identifier for the processor.
- target
Field String - Output field for the community ID.
- transport String
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- id string
- Internal identifier of the resource
- json string
- JSON representation of this data source.
- description string
- Description of the processor.
- destination
Ip string - Field containing the destination IP address.
- destination
Port number - Field containing the destination port.
- iana
Number number - Field containing the IANA number.
- icmp
Code number - Field containing the ICMP code.
- icmp
Type number - Field containing the ICMP type.
- if string
- Conditionally execute the processor
- ignore
Failure boolean - Ignore failures for the processor.
- ignore
Missing boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures string[] - Handle failures for the processor.
- seed number
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip string - Field containing the source IP address.
- source
Port number - Field containing the source port.
- tag string
- Identifier for the processor.
- target
Field string - Output field for the community ID.
- transport string
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- id str
- Internal identifier of the resource
- json str
- JSON representation of this data source.
- description str
- Description of the processor.
- destination_
ip str - Field containing the destination IP address.
- destination_
port float - Field containing the destination port.
- iana_
number float - Field containing the IANA number.
- icmp_
code float - Field containing the ICMP code.
- icmp_
type float - Field containing the ICMP type.
- if_ str
- Conditionally execute the processor
- ignore_
failure bool - Ignore failures for the processor.
- ignore_
missing bool - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on_
failures Sequence[str] - Handle failures for the processor.
- seed float
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source_
ip str - Field containing the source IP address.
- source_
port float - Field containing the source port.
- tag str
- Identifier for the processor.
- target_
field str - Output field for the community ID.
- transport str
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
- id String
- Internal identifier of the resource
- json String
- JSON representation of this data source.
- description String
- Description of the processor.
- destination
Ip String - Field containing the destination IP address.
- destination
Port Number - Field containing the destination port.
- iana
Number Number - Field containing the IANA number.
- icmp
Code Number - Field containing the ICMP code.
- icmp
Type Number - Field containing the ICMP type.
- if String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- ignore
Missing Boolean - If
true
andfield
does not exist or isnull
, the processor quietly exits without modifying the document. - on
Failures List<String> - Handle failures for the processor.
- seed Number
- Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
- source
Ip String - Field containing the source IP address.
- source
Port Number - Field containing the source port.
- tag String
- Identifier for the processor.
- target
Field String - Output field for the community ID.
- transport String
- Field containing the transport protocol. Used only when the
iana_number
field is not present.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstack
Terraform Provider.