1. Packages
  2. Akeyless Provider
  3. API Docs
  4. GatewayLogForwardingElasticsearch
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.GatewayLogForwardingElasticsearch

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Log Forwarding config for elasticsearch

    Create GatewayLogForwardingElasticsearch Resource

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

    Constructor syntax

    new GatewayLogForwardingElasticsearch(name: string, args?: GatewayLogForwardingElasticsearchArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayLogForwardingElasticsearch(resource_name: str,
                                          args: Optional[GatewayLogForwardingElasticsearchArgs] = None,
                                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayLogForwardingElasticsearch(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          api_key: Optional[str] = None,
                                          auth_type: Optional[str] = None,
                                          cloud_id: Optional[str] = None,
                                          enable: Optional[str] = None,
                                          enable_tls: Optional[bool] = None,
                                          gateway_log_forwarding_elasticsearch_id: Optional[str] = None,
                                          index: Optional[str] = None,
                                          nodes: Optional[str] = None,
                                          output_format: Optional[str] = None,
                                          password: Optional[str] = None,
                                          pull_interval: Optional[str] = None,
                                          server_type: Optional[str] = None,
                                          tls_certificate: Optional[str] = None,
                                          user_name: Optional[str] = None)
    func NewGatewayLogForwardingElasticsearch(ctx *Context, name string, args *GatewayLogForwardingElasticsearchArgs, opts ...ResourceOption) (*GatewayLogForwardingElasticsearch, error)
    public GatewayLogForwardingElasticsearch(string name, GatewayLogForwardingElasticsearchArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayLogForwardingElasticsearch(String name, GatewayLogForwardingElasticsearchArgs args)
    public GatewayLogForwardingElasticsearch(String name, GatewayLogForwardingElasticsearchArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayLogForwardingElasticsearch
    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 GatewayLogForwardingElasticsearchArgs
    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 GatewayLogForwardingElasticsearchArgs
    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 GatewayLogForwardingElasticsearchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayLogForwardingElasticsearchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayLogForwardingElasticsearchArgs
    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 gatewayLogForwardingElasticsearchResource = new Akeyless.GatewayLogForwardingElasticsearch("gatewayLogForwardingElasticsearchResource", new()
    {
        ApiKey = "string",
        AuthType = "string",
        CloudId = "string",
        Enable = "string",
        EnableTls = false,
        GatewayLogForwardingElasticsearchId = "string",
        Index = "string",
        Nodes = "string",
        OutputFormat = "string",
        Password = "string",
        PullInterval = "string",
        ServerType = "string",
        TlsCertificate = "string",
        UserName = "string",
    });
    
    example, err := akeyless.NewGatewayLogForwardingElasticsearch(ctx, "gatewayLogForwardingElasticsearchResource", &akeyless.GatewayLogForwardingElasticsearchArgs{
    	ApiKey:                              pulumi.String("string"),
    	AuthType:                            pulumi.String("string"),
    	CloudId:                             pulumi.String("string"),
    	Enable:                              pulumi.String("string"),
    	EnableTls:                           pulumi.Bool(false),
    	GatewayLogForwardingElasticsearchId: pulumi.String("string"),
    	Index:                               pulumi.String("string"),
    	Nodes:                               pulumi.String("string"),
    	OutputFormat:                        pulumi.String("string"),
    	Password:                            pulumi.String("string"),
    	PullInterval:                        pulumi.String("string"),
    	ServerType:                          pulumi.String("string"),
    	TlsCertificate:                      pulumi.String("string"),
    	UserName:                            pulumi.String("string"),
    })
    
    var gatewayLogForwardingElasticsearchResource = new GatewayLogForwardingElasticsearch("gatewayLogForwardingElasticsearchResource", GatewayLogForwardingElasticsearchArgs.builder()
        .apiKey("string")
        .authType("string")
        .cloudId("string")
        .enable("string")
        .enableTls(false)
        .gatewayLogForwardingElasticsearchId("string")
        .index("string")
        .nodes("string")
        .outputFormat("string")
        .password("string")
        .pullInterval("string")
        .serverType("string")
        .tlsCertificate("string")
        .userName("string")
        .build());
    
    gateway_log_forwarding_elasticsearch_resource = akeyless.GatewayLogForwardingElasticsearch("gatewayLogForwardingElasticsearchResource",
        api_key="string",
        auth_type="string",
        cloud_id="string",
        enable="string",
        enable_tls=False,
        gateway_log_forwarding_elasticsearch_id="string",
        index="string",
        nodes="string",
        output_format="string",
        password="string",
        pull_interval="string",
        server_type="string",
        tls_certificate="string",
        user_name="string")
    
    const gatewayLogForwardingElasticsearchResource = new akeyless.GatewayLogForwardingElasticsearch("gatewayLogForwardingElasticsearchResource", {
        apiKey: "string",
        authType: "string",
        cloudId: "string",
        enable: "string",
        enableTls: false,
        gatewayLogForwardingElasticsearchId: "string",
        index: "string",
        nodes: "string",
        outputFormat: "string",
        password: "string",
        pullInterval: "string",
        serverType: "string",
        tlsCertificate: "string",
        userName: "string",
    });
    
    type: akeyless:GatewayLogForwardingElasticsearch
    properties:
        apiKey: string
        authType: string
        cloudId: string
        enable: string
        enableTls: false
        gatewayLogForwardingElasticsearchId: string
        index: string
        nodes: string
        outputFormat: string
        password: string
        pullInterval: string
        serverType: string
        tlsCertificate: string
        userName: string
    

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

    ApiKey string
    Elasticsearch api key relevant only for api_key auth-type
    AuthType string
    Elasticsearch auth type [api_key/password]
    CloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingElasticsearchId string
    The ID of this resource.
    Index string
    Elasticsearch index
    Nodes string
    Elasticsearch nodes relevant only for nodes server-type
    OutputFormat string
    Logs format [text/json]
    Password string
    Elasticsearch password relevant only for password auth-type
    PullInterval string
    Pull interval in seconds
    ServerType string
    Elasticsearch server type [nodes/cloud]
    TlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    UserName string
    Elasticsearch user name relevant only for password auth-type
    ApiKey string
    Elasticsearch api key relevant only for api_key auth-type
    AuthType string
    Elasticsearch auth type [api_key/password]
    CloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingElasticsearchId string
    The ID of this resource.
    Index string
    Elasticsearch index
    Nodes string
    Elasticsearch nodes relevant only for nodes server-type
    OutputFormat string
    Logs format [text/json]
    Password string
    Elasticsearch password relevant only for password auth-type
    PullInterval string
    Pull interval in seconds
    ServerType string
    Elasticsearch server type [nodes/cloud]
    TlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    UserName string
    Elasticsearch user name relevant only for password auth-type
    apiKey String
    Elasticsearch api key relevant only for api_key auth-type
    authType String
    Elasticsearch auth type [api_key/password]
    cloudId String
    Elasticsearch cloud id relevant only for cloud server-type
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingElasticsearchId String
    The ID of this resource.
    index String
    Elasticsearch index
    nodes String
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat String
    Logs format [text/json]
    password String
    Elasticsearch password relevant only for password auth-type
    pullInterval String
    Pull interval in seconds
    serverType String
    Elasticsearch server type [nodes/cloud]
    tlsCertificate String
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName String
    Elasticsearch user name relevant only for password auth-type
    apiKey string
    Elasticsearch api key relevant only for api_key auth-type
    authType string
    Elasticsearch auth type [api_key/password]
    cloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    enable string
    Enable Log Forwarding [true/false]
    enableTls boolean
    Enable tls
    gatewayLogForwardingElasticsearchId string
    The ID of this resource.
    index string
    Elasticsearch index
    nodes string
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat string
    Logs format [text/json]
    password string
    Elasticsearch password relevant only for password auth-type
    pullInterval string
    Pull interval in seconds
    serverType string
    Elasticsearch server type [nodes/cloud]
    tlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName string
    Elasticsearch user name relevant only for password auth-type
    api_key str
    Elasticsearch api key relevant only for api_key auth-type
    auth_type str
    Elasticsearch auth type [api_key/password]
    cloud_id str
    Elasticsearch cloud id relevant only for cloud server-type
    enable str
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_elasticsearch_id str
    The ID of this resource.
    index str
    Elasticsearch index
    nodes str
    Elasticsearch nodes relevant only for nodes server-type
    output_format str
    Logs format [text/json]
    password str
    Elasticsearch password relevant only for password auth-type
    pull_interval str
    Pull interval in seconds
    server_type str
    Elasticsearch server type [nodes/cloud]
    tls_certificate str
    Elasticsearch tls certificate (PEM format) in a Base64 format
    user_name str
    Elasticsearch user name relevant only for password auth-type
    apiKey String
    Elasticsearch api key relevant only for api_key auth-type
    authType String
    Elasticsearch auth type [api_key/password]
    cloudId String
    Elasticsearch cloud id relevant only for cloud server-type
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingElasticsearchId String
    The ID of this resource.
    index String
    Elasticsearch index
    nodes String
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat String
    Logs format [text/json]
    password String
    Elasticsearch password relevant only for password auth-type
    pullInterval String
    Pull interval in seconds
    serverType String
    Elasticsearch server type [nodes/cloud]
    tlsCertificate String
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName String
    Elasticsearch user name relevant only for password auth-type

    Outputs

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

    Get an existing GatewayLogForwardingElasticsearch 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?: GatewayLogForwardingElasticsearchState, opts?: CustomResourceOptions): GatewayLogForwardingElasticsearch
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            auth_type: Optional[str] = None,
            cloud_id: Optional[str] = None,
            enable: Optional[str] = None,
            enable_tls: Optional[bool] = None,
            gateway_log_forwarding_elasticsearch_id: Optional[str] = None,
            index: Optional[str] = None,
            nodes: Optional[str] = None,
            output_format: Optional[str] = None,
            password: Optional[str] = None,
            pull_interval: Optional[str] = None,
            server_type: Optional[str] = None,
            tls_certificate: Optional[str] = None,
            user_name: Optional[str] = None) -> GatewayLogForwardingElasticsearch
    func GetGatewayLogForwardingElasticsearch(ctx *Context, name string, id IDInput, state *GatewayLogForwardingElasticsearchState, opts ...ResourceOption) (*GatewayLogForwardingElasticsearch, error)
    public static GatewayLogForwardingElasticsearch Get(string name, Input<string> id, GatewayLogForwardingElasticsearchState? state, CustomResourceOptions? opts = null)
    public static GatewayLogForwardingElasticsearch get(String name, Output<String> id, GatewayLogForwardingElasticsearchState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayLogForwardingElasticsearch    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.
    The following state arguments are supported:
    ApiKey string
    Elasticsearch api key relevant only for api_key auth-type
    AuthType string
    Elasticsearch auth type [api_key/password]
    CloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingElasticsearchId string
    The ID of this resource.
    Index string
    Elasticsearch index
    Nodes string
    Elasticsearch nodes relevant only for nodes server-type
    OutputFormat string
    Logs format [text/json]
    Password string
    Elasticsearch password relevant only for password auth-type
    PullInterval string
    Pull interval in seconds
    ServerType string
    Elasticsearch server type [nodes/cloud]
    TlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    UserName string
    Elasticsearch user name relevant only for password auth-type
    ApiKey string
    Elasticsearch api key relevant only for api_key auth-type
    AuthType string
    Elasticsearch auth type [api_key/password]
    CloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    Enable string
    Enable Log Forwarding [true/false]
    EnableTls bool
    Enable tls
    GatewayLogForwardingElasticsearchId string
    The ID of this resource.
    Index string
    Elasticsearch index
    Nodes string
    Elasticsearch nodes relevant only for nodes server-type
    OutputFormat string
    Logs format [text/json]
    Password string
    Elasticsearch password relevant only for password auth-type
    PullInterval string
    Pull interval in seconds
    ServerType string
    Elasticsearch server type [nodes/cloud]
    TlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    UserName string
    Elasticsearch user name relevant only for password auth-type
    apiKey String
    Elasticsearch api key relevant only for api_key auth-type
    authType String
    Elasticsearch auth type [api_key/password]
    cloudId String
    Elasticsearch cloud id relevant only for cloud server-type
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingElasticsearchId String
    The ID of this resource.
    index String
    Elasticsearch index
    nodes String
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat String
    Logs format [text/json]
    password String
    Elasticsearch password relevant only for password auth-type
    pullInterval String
    Pull interval in seconds
    serverType String
    Elasticsearch server type [nodes/cloud]
    tlsCertificate String
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName String
    Elasticsearch user name relevant only for password auth-type
    apiKey string
    Elasticsearch api key relevant only for api_key auth-type
    authType string
    Elasticsearch auth type [api_key/password]
    cloudId string
    Elasticsearch cloud id relevant only for cloud server-type
    enable string
    Enable Log Forwarding [true/false]
    enableTls boolean
    Enable tls
    gatewayLogForwardingElasticsearchId string
    The ID of this resource.
    index string
    Elasticsearch index
    nodes string
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat string
    Logs format [text/json]
    password string
    Elasticsearch password relevant only for password auth-type
    pullInterval string
    Pull interval in seconds
    serverType string
    Elasticsearch server type [nodes/cloud]
    tlsCertificate string
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName string
    Elasticsearch user name relevant only for password auth-type
    api_key str
    Elasticsearch api key relevant only for api_key auth-type
    auth_type str
    Elasticsearch auth type [api_key/password]
    cloud_id str
    Elasticsearch cloud id relevant only for cloud server-type
    enable str
    Enable Log Forwarding [true/false]
    enable_tls bool
    Enable tls
    gateway_log_forwarding_elasticsearch_id str
    The ID of this resource.
    index str
    Elasticsearch index
    nodes str
    Elasticsearch nodes relevant only for nodes server-type
    output_format str
    Logs format [text/json]
    password str
    Elasticsearch password relevant only for password auth-type
    pull_interval str
    Pull interval in seconds
    server_type str
    Elasticsearch server type [nodes/cloud]
    tls_certificate str
    Elasticsearch tls certificate (PEM format) in a Base64 format
    user_name str
    Elasticsearch user name relevant only for password auth-type
    apiKey String
    Elasticsearch api key relevant only for api_key auth-type
    authType String
    Elasticsearch auth type [api_key/password]
    cloudId String
    Elasticsearch cloud id relevant only for cloud server-type
    enable String
    Enable Log Forwarding [true/false]
    enableTls Boolean
    Enable tls
    gatewayLogForwardingElasticsearchId String
    The ID of this resource.
    index String
    Elasticsearch index
    nodes String
    Elasticsearch nodes relevant only for nodes server-type
    outputFormat String
    Logs format [text/json]
    password String
    Elasticsearch password relevant only for password auth-type
    pullInterval String
    Pull interval in seconds
    serverType String
    Elasticsearch server type [nodes/cloud]
    tlsCertificate String
    Elasticsearch tls certificate (PEM format) in a Base64 format
    userName String
    Elasticsearch user name relevant only for password auth-type

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community