1. Packages
  2. Rancher2
  3. API Docs
  4. getClusterLogging
Rancher 2 v4.0.0 published on Thursday, Apr 20, 2023 by Pulumi

rancher2.getClusterLogging

Explore with Pulumi AI

rancher2 logo
Rancher 2 v4.0.0 published on Thursday, Apr 20, 2023 by Pulumi

    Use this data source to retrieve information about a Rancher v2 Cluster Logging.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Rancher2.GetClusterLogging.Invoke(new()
        {
            ClusterId = "<cluster_id>",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v4/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rancher2.LookupClusterLogging(ctx, &rancher2.LookupClusterLoggingArgs{
    			ClusterId: "<cluster_id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.Rancher2Functions;
    import com.pulumi.rancher2.inputs.GetClusterLoggingArgs;
    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 foo = Rancher2Functions.getClusterLogging(GetClusterLoggingArgs.builder()
                .clusterId("<cluster_id>")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_cluster_logging(cluster_id="<cluster_id>")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getClusterLogging({
        clusterId: "<cluster_id>",
    });
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getClusterLogging
          Arguments:
            clusterId: <cluster_id>
    

    Using getClusterLogging

    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 getClusterLogging(args: GetClusterLoggingArgs, opts?: InvokeOptions): Promise<GetClusterLoggingResult>
    function getClusterLoggingOutput(args: GetClusterLoggingOutputArgs, opts?: InvokeOptions): Output<GetClusterLoggingResult>
    def get_cluster_logging(cluster_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetClusterLoggingResult
    def get_cluster_logging_output(cluster_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetClusterLoggingResult]
    func LookupClusterLogging(ctx *Context, args *LookupClusterLoggingArgs, opts ...InvokeOption) (*LookupClusterLoggingResult, error)
    func LookupClusterLoggingOutput(ctx *Context, args *LookupClusterLoggingOutputArgs, opts ...InvokeOption) LookupClusterLoggingResultOutput

    > Note: This function is named LookupClusterLogging in the Go SDK.

    public static class GetClusterLogging 
    {
        public static Task<GetClusterLoggingResult> InvokeAsync(GetClusterLoggingArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterLoggingResult> Invoke(GetClusterLoggingInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterLoggingResult> getClusterLogging(GetClusterLoggingArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: rancher2:index/getClusterLogging:getClusterLogging
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string

    The cluster id to configure logging (string)

    ClusterId string

    The cluster id to configure logging (string)

    clusterId String

    The cluster id to configure logging (string)

    clusterId string

    The cluster id to configure logging (string)

    cluster_id str

    The cluster id to configure logging (string)

    clusterId String

    The cluster id to configure logging (string)

    getClusterLogging Result

    The following output properties are available:

    Annotations Dictionary<string, object>

    (Computed) Annotations for Cluster Logging object (map)

    ClusterId string
    CustomTargetConfig GetClusterLoggingCustomTargetConfig
    ElasticsearchConfig GetClusterLoggingElasticsearchConfig

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    EnableJsonParsing bool
    FluentdConfig GetClusterLoggingFluentdConfig

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    Id string

    The provider-assigned unique ID for this managed resource.

    KafkaConfig GetClusterLoggingKafkaConfig

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    Kind string

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    Labels Dictionary<string, object>

    (Computed) Labels for Cluster Logging object (map)

    Name string

    (Computed) The name of the cluster logging config (string)

    NamespaceId string

    (Computed) The namespace id from cluster logging (string)

    OutputFlushInterval int

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    OutputTags Dictionary<string, object>

    (computed) The output tags for Cluster Logging (map)

    SplunkConfig GetClusterLoggingSplunkConfig

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    SyslogConfig GetClusterLoggingSyslogConfig

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    Annotations map[string]interface{}

    (Computed) Annotations for Cluster Logging object (map)

    ClusterId string
    CustomTargetConfig GetClusterLoggingCustomTargetConfig
    ElasticsearchConfig GetClusterLoggingElasticsearchConfig

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    EnableJsonParsing bool
    FluentdConfig GetClusterLoggingFluentdConfig

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    Id string

    The provider-assigned unique ID for this managed resource.

    KafkaConfig GetClusterLoggingKafkaConfig

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    Kind string

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    Labels map[string]interface{}

    (Computed) Labels for Cluster Logging object (map)

    Name string

    (Computed) The name of the cluster logging config (string)

    NamespaceId string

    (Computed) The namespace id from cluster logging (string)

    OutputFlushInterval int

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    OutputTags map[string]interface{}

    (computed) The output tags for Cluster Logging (map)

    SplunkConfig GetClusterLoggingSplunkConfig

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    SyslogConfig GetClusterLoggingSyslogConfig

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    annotations Map<String,Object>

    (Computed) Annotations for Cluster Logging object (map)

    clusterId String
    customTargetConfig GetClusterLoggingCustomTargetConfig
    elasticsearchConfig GetClusterLoggingElasticsearchConfig

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    enableJsonParsing Boolean
    fluentdConfig GetClusterLoggingFluentdConfig

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    id String

    The provider-assigned unique ID for this managed resource.

    kafkaConfig GetClusterLoggingKafkaConfig

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    kind String

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    labels Map<String,Object>

    (Computed) Labels for Cluster Logging object (map)

    name String

    (Computed) The name of the cluster logging config (string)

    namespaceId String

    (Computed) The namespace id from cluster logging (string)

    outputFlushInterval Integer

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    outputTags Map<String,Object>

    (computed) The output tags for Cluster Logging (map)

    splunkConfig GetClusterLoggingSplunkConfig

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    syslogConfig GetClusterLoggingSyslogConfig

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    annotations {[key: string]: any}

    (Computed) Annotations for Cluster Logging object (map)

    clusterId string
    customTargetConfig GetClusterLoggingCustomTargetConfig
    elasticsearchConfig GetClusterLoggingElasticsearchConfig

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    enableJsonParsing boolean
    fluentdConfig GetClusterLoggingFluentdConfig

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    id string

    The provider-assigned unique ID for this managed resource.

    kafkaConfig GetClusterLoggingKafkaConfig

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    kind string

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    labels {[key: string]: any}

    (Computed) Labels for Cluster Logging object (map)

    name string

    (Computed) The name of the cluster logging config (string)

    namespaceId string

    (Computed) The namespace id from cluster logging (string)

    outputFlushInterval number

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    outputTags {[key: string]: any}

    (computed) The output tags for Cluster Logging (map)

    splunkConfig GetClusterLoggingSplunkConfig

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    syslogConfig GetClusterLoggingSyslogConfig

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    annotations Mapping[str, Any]

    (Computed) Annotations for Cluster Logging object (map)

    cluster_id str
    custom_target_config GetClusterLoggingCustomTargetConfig
    elasticsearch_config GetClusterLoggingElasticsearchConfig

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    enable_json_parsing bool
    fluentd_config GetClusterLoggingFluentdConfig

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    id str

    The provider-assigned unique ID for this managed resource.

    kafka_config GetClusterLoggingKafkaConfig

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    kind str

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    labels Mapping[str, Any]

    (Computed) Labels for Cluster Logging object (map)

    name str

    (Computed) The name of the cluster logging config (string)

    namespace_id str

    (Computed) The namespace id from cluster logging (string)

    output_flush_interval int

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    output_tags Mapping[str, Any]

    (computed) The output tags for Cluster Logging (map)

    splunk_config GetClusterLoggingSplunkConfig

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    syslog_config GetClusterLoggingSyslogConfig

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    annotations Map<Any>

    (Computed) Annotations for Cluster Logging object (map)

    clusterId String
    customTargetConfig Property Map
    elasticsearchConfig Property Map

    (Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

    enableJsonParsing Boolean
    fluentdConfig Property Map

    (Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

    id String

    The provider-assigned unique ID for this managed resource.

    kafkaConfig Property Map

    (Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

    kind String

    (Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

    labels Map<Any>

    (Computed) Labels for Cluster Logging object (map)

    name String

    (Computed) The name of the cluster logging config (string)

    namespaceId String

    (Computed) The namespace id from cluster logging (string)

    outputFlushInterval Number

    (Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

    outputTags Map<Any>

    (computed) The output tags for Cluster Logging (map)

    splunkConfig Property Map

    (Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

    syslogConfig Property Map

    (Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

    Supporting Types

    GetClusterLoggingCustomTargetConfig

    Content string
    Certificate string
    ClientCert string
    ClientKey string
    Content string
    Certificate string
    ClientCert string
    ClientKey string
    content String
    certificate String
    clientCert String
    clientKey String
    content string
    certificate string
    clientCert string
    clientKey string
    content String
    certificate String
    clientCert String
    clientKey String

    GetClusterLoggingElasticsearchConfig

    endpoint String
    sslVerify Boolean
    authPassword String
    authUsername String
    certificate String
    clientCert String
    clientKey String
    clientKeyPass String
    dateFormat String
    indexPrefix String
    sslVersion String
    endpoint string
    sslVerify boolean
    authPassword string
    authUsername string
    certificate string
    clientCert string
    clientKey string
    clientKeyPass string
    dateFormat string
    indexPrefix string
    sslVersion string
    endpoint String
    sslVerify Boolean
    authPassword String
    authUsername String
    certificate String
    clientCert String
    clientKey String
    clientKeyPass String
    dateFormat String
    indexPrefix String
    sslVersion String

    GetClusterLoggingFluentdConfig

    GetClusterLoggingFluentdConfigFluentServer

    Endpoint string
    Hostname string
    Password string
    SharedKey string
    Standby bool
    Username string
    Weight int
    Endpoint string
    Hostname string
    Password string
    SharedKey string
    Standby bool
    Username string
    Weight int
    endpoint String
    hostname String
    password String
    sharedKey String
    standby Boolean
    username String
    weight Integer
    endpoint string
    hostname string
    password string
    sharedKey string
    standby boolean
    username string
    weight number
    endpoint String
    hostname String
    password String
    sharedKey String
    standby Boolean
    username String
    weight Number

    GetClusterLoggingKafkaConfig

    Topic string
    BrokerEndpoints List<string>
    Certificate string
    ClientCert string
    ClientKey string
    ZookeeperEndpoint string
    topic String
    brokerEndpoints List<String>
    certificate String
    clientCert String
    clientKey String
    zookeeperEndpoint String
    topic String
    brokerEndpoints List<String>
    certificate String
    clientCert String
    clientKey String
    zookeeperEndpoint String

    GetClusterLoggingSplunkConfig

    Endpoint string
    SslVerify bool
    Token string
    Certificate string
    ClientCert string
    ClientKey string
    ClientKeyPass string
    Index string
    Source string
    Endpoint string
    SslVerify bool
    Token string
    Certificate string
    ClientCert string
    ClientKey string
    ClientKeyPass string
    Index string
    Source string
    endpoint String
    sslVerify Boolean
    token String
    certificate String
    clientCert String
    clientKey String
    clientKeyPass String
    index String
    source String
    endpoint string
    sslVerify boolean
    token string
    certificate string
    clientCert string
    clientKey string
    clientKeyPass string
    index string
    source string
    endpoint String
    sslVerify Boolean
    token String
    certificate String
    clientCert String
    clientKey String
    clientKeyPass String
    index String
    source String

    GetClusterLoggingSyslogConfig

    Endpoint string
    SslVerify bool
    Certificate string
    ClientCert string
    ClientKey string
    EnableTls bool
    Program string
    Protocol string
    Severity string
    Token string
    Endpoint string
    SslVerify bool
    Certificate string
    ClientCert string
    ClientKey string
    EnableTls bool
    Program string
    Protocol string
    Severity string
    Token string
    endpoint String
    sslVerify Boolean
    certificate String
    clientCert String
    clientKey String
    enableTls Boolean
    program String
    protocol String
    severity String
    token String
    endpoint string
    sslVerify boolean
    certificate string
    clientCert string
    clientKey string
    enableTls boolean
    program string
    protocol string
    severity string
    token string
    endpoint String
    sslVerify Boolean
    certificate String
    clientCert String
    clientKey String
    enableTls Boolean
    program String
    protocol String
    severity String
    token String

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the rancher2 Terraform Provider.

    rancher2 logo
    Rancher 2 v4.0.0 published on Thursday, Apr 20, 2023 by Pulumi