1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayLogForwardingLogstash
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    Log Forwarding config for logstash

    Create GatewayLogForwardingLogstash Resource

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

    Constructor syntax

    new GatewayLogForwardingLogstash(name: string, args?: GatewayLogForwardingLogstashArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayLogForwardingLogstash(resource_name: str,
                                     args: Optional[GatewayLogForwardingLogstashArgs] = None,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayLogForwardingLogstash(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     dns: Optional[str] = None,
                                     enable: Optional[str] = None,
                                     enable_tls: Optional[bool] = None,
                                     gateway_log_forwarding_logstash_id: Optional[str] = None,
                                     output_format: Optional[str] = None,
                                     protocol: Optional[str] = None,
                                     pull_interval: Optional[str] = None,
                                     retry: Optional[GatewayLogForwardingLogstashRetryArgs] = None,
                                     tls_certificate: Optional[str] = None)
    func NewGatewayLogForwardingLogstash(ctx *Context, name string, args *GatewayLogForwardingLogstashArgs, opts ...ResourceOption) (*GatewayLogForwardingLogstash, error)
    public GatewayLogForwardingLogstash(string name, GatewayLogForwardingLogstashArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayLogForwardingLogstash(String name, GatewayLogForwardingLogstashArgs args)
    public GatewayLogForwardingLogstash(String name, GatewayLogForwardingLogstashArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayLogForwardingLogstash
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_gateway_log_forwarding_logstash" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayLogForwardingLogstashArgs
    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 GatewayLogForwardingLogstashArgs
    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 GatewayLogForwardingLogstashArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayLogForwardingLogstashArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayLogForwardingLogstashArgs
    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 gatewayLogForwardingLogstashResource = new Akeyless.GatewayLogForwardingLogstash("gatewayLogForwardingLogstashResource", new()
    {
        Dns = "string",
        Enable = "string",
        EnableTls = false,
        GatewayLogForwardingLogstashId = "string",
        OutputFormat = "string",
        Protocol = "string",
        PullInterval = "string",
        Retry = new Akeyless.Inputs.GatewayLogForwardingLogstashRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        TlsCertificate = "string",
    });
    
    example, err := akeyless.NewGatewayLogForwardingLogstash(ctx, "gatewayLogForwardingLogstashResource", &akeyless.GatewayLogForwardingLogstashArgs{
    	Dns:                            pulumi.String("string"),
    	Enable:                         pulumi.String("string"),
    	EnableTls:                      pulumi.Bool(false),
    	GatewayLogForwardingLogstashId: pulumi.String("string"),
    	OutputFormat:                   pulumi.String("string"),
    	Protocol:                       pulumi.String("string"),
    	PullInterval:                   pulumi.String("string"),
    	Retry: &akeyless.GatewayLogForwardingLogstashRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	TlsCertificate: pulumi.String("string"),
    })
    
    resource "akeyless_gateway_log_forwarding_logstash" "gatewayLogForwardingLogstashResource" {
      lifecycle {
        create_before_destroy = true
      }
      dns                                = "string"
      enable                             = "string"
      enable_tls                         = false
      gateway_log_forwarding_logstash_id = "string"
      output_format                      = "string"
      protocol                           = "string"
      pull_interval                      = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      tls_certificate = "string"
    }
    
    var gatewayLogForwardingLogstashResource = new GatewayLogForwardingLogstash("gatewayLogForwardingLogstashResource", GatewayLogForwardingLogstashArgs.builder()
        .dns("string")
        .enable("string")
        .enableTls(false)
        .gatewayLogForwardingLogstashId("string")
        .outputFormat("string")
        .protocol("string")
        .pullInterval("string")
        .retry(GatewayLogForwardingLogstashRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .tlsCertificate("string")
        .build());
    
    gateway_log_forwarding_logstash_resource = akeyless.GatewayLogForwardingLogstash("gatewayLogForwardingLogstashResource",
        dns="string",
        enable="string",
        enable_tls=False,
        gateway_log_forwarding_logstash_id="string",
        output_format="string",
        protocol="string",
        pull_interval="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        },
        tls_certificate="string")
    
    const gatewayLogForwardingLogstashResource = new akeyless.GatewayLogForwardingLogstash("gatewayLogForwardingLogstashResource", {
        dns: "string",
        enable: "string",
        enableTls: false,
        gatewayLogForwardingLogstashId: "string",
        outputFormat: "string",
        protocol: "string",
        pullInterval: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        tlsCertificate: "string",
    });
    
    type: akeyless:GatewayLogForwardingLogstash
    properties:
        dns: string
        enable: string
        enableTls: false
        gatewayLogForwardingLogstashId: string
        outputFormat: string
        protocol: string
        pullInterval: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        tlsCertificate: string
    

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

    Dns string
    Logstash dns
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingLogstashId string
    The ID of this resource.
    OutputFormat string
    Logs format [text/json]
    Protocol string
    Logstash protocol [tcp/udp]
    PullInterval string
    Pull interval in seconds
    Retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    Dns string
    Logstash dns
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingLogstashId string
    The ID of this resource.
    OutputFormat string
    Logs format [text/json]
    Protocol string
    Logstash protocol [tcp/udp]
    PullInterval string
    Pull interval in seconds
    Retry GatewayLogForwardingLogstashRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns string
    Logstash dns
    enable string
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_logstash_id string
    The ID of this resource.
    output_format string
    Logs format [text/json]
    protocol string
    Logstash protocol [tcp/udp]
    pull_interval string
    Pull interval in seconds
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tls_certificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns String
    Logstash dns
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingLogstashId String
    The ID of this resource.
    outputFormat String
    Logs format [text/json]
    protocol String
    Logstash protocol [tcp/udp]
    pullInterval String
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate String
    Logstash tls certificate (PEM format) in a Base64 format
    dns string
    Logstash dns
    enable string
    Enable Log Forwarding [true/false]
    enableTls boolean
    Enable tls
    gatewayLogForwardingLogstashId string
    The ID of this resource.
    outputFormat string
    Logs format [text/json]
    protocol string
    Logstash protocol [tcp/udp]
    pullInterval string
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns str
    Logstash dns
    enable str
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_logstash_id str
    The ID of this resource.
    output_format str
    Logs format [text/json]
    protocol str
    Logstash protocol [tcp/udp]
    pull_interval str
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tls_certificate str
    Logstash tls certificate (PEM format) in a Base64 format
    dns String
    Logstash dns
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingLogstashId String
    The ID of this resource.
    outputFormat String
    Logs format [text/json]
    protocol String
    Logstash protocol [tcp/udp]
    pullInterval String
    Pull interval in seconds
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate String
    Logstash tls certificate (PEM format) in a Base64 format

    Outputs

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

    Get an existing GatewayLogForwardingLogstash 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?: GatewayLogForwardingLogstashState, opts?: CustomResourceOptions): GatewayLogForwardingLogstash
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dns: Optional[str] = None,
            enable: Optional[str] = None,
            enable_tls: Optional[bool] = None,
            gateway_log_forwarding_logstash_id: Optional[str] = None,
            output_format: Optional[str] = None,
            protocol: Optional[str] = None,
            pull_interval: Optional[str] = None,
            retry: Optional[GatewayLogForwardingLogstashRetryArgs] = None,
            tls_certificate: Optional[str] = None) -> GatewayLogForwardingLogstash
    func GetGatewayLogForwardingLogstash(ctx *Context, name string, id IDInput, state *GatewayLogForwardingLogstashState, opts ...ResourceOption) (*GatewayLogForwardingLogstash, error)
    public static GatewayLogForwardingLogstash Get(string name, Input<string> id, GatewayLogForwardingLogstashState? state, CustomResourceOptions? opts = null)
    public static GatewayLogForwardingLogstash get(String name, Output<String> id, GatewayLogForwardingLogstashState state, CustomResourceOptions options)
    resources:  existingGatewayLogForwardingLogstash:    type: akeyless:GatewayLogForwardingLogstash    get:      id: ${id}
    import {
      to = akeyless_gateway_log_forwarding_logstash.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state GatewayLogForwardingLogstashState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GatewayLogForwardingLogstashState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state GatewayLogForwardingLogstashState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state GatewayLogForwardingLogstashState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Dns string
    Logstash dns
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingLogstashId string
    The ID of this resource.
    OutputFormat string
    Logs format [text/json]
    Protocol string
    Logstash protocol [tcp/udp]
    PullInterval string
    Pull interval in seconds
    Retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    Dns string
    Logstash dns
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingLogstashId string
    The ID of this resource.
    OutputFormat string
    Logs format [text/json]
    Protocol string
    Logstash protocol [tcp/udp]
    PullInterval string
    Pull interval in seconds
    Retry GatewayLogForwardingLogstashRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns string
    Logstash dns
    enable string
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_logstash_id string
    The ID of this resource.
    output_format string
    Logs format [text/json]
    protocol string
    Logstash protocol [tcp/udp]
    pull_interval string
    Pull interval in seconds
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tls_certificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns String
    Logstash dns
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingLogstashId String
    The ID of this resource.
    outputFormat String
    Logs format [text/json]
    protocol String
    Logstash protocol [tcp/udp]
    pullInterval String
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate String
    Logstash tls certificate (PEM format) in a Base64 format
    dns string
    Logstash dns
    enable string
    Enable Log Forwarding [true/false]
    enableTls boolean
    Enable tls
    gatewayLogForwardingLogstashId string
    The ID of this resource.
    outputFormat string
    Logs format [text/json]
    protocol string
    Logstash protocol [tcp/udp]
    pullInterval string
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate string
    Logstash tls certificate (PEM format) in a Base64 format
    dns str
    Logstash dns
    enable str
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_logstash_id str
    The ID of this resource.
    output_format str
    Logs format [text/json]
    protocol str
    Logstash protocol [tcp/udp]
    pull_interval str
    Pull interval in seconds
    retry GatewayLogForwardingLogstashRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tls_certificate str
    Logstash tls certificate (PEM format) in a Base64 format
    dns String
    Logstash dns
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingLogstashId String
    The ID of this resource.
    outputFormat String
    Logs format [text/json]
    protocol String
    Logstash protocol [tcp/udp]
    pullInterval String
    Pull interval in seconds
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tlsCertificate String
    Logstash tls certificate (PEM format) in a Base64 format

    Supporting Types

    GatewayLogForwardingLogstashRetry, GatewayLogForwardingLogstashRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial