Class ClusterLogging

Provides a Rancher v2 Cluster Logging resource. This can be used to configure Cluster Logging for Rancher v2 environments and retrieve their information.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new Rancher2 Cluster Logging
    var foo = new Rancher2.ClusterLogging("foo", new Rancher2.ClusterLoggingArgs
    {
        ClusterId = "<cluster_id>",
        Kind = "syslog",
        SyslogConfig = new Rancher2.Inputs.ClusterLoggingSyslogConfigArgs
        {
            Endpoint = "<syslog_endpoint>",
            Protocol = "udp",
            Severity = "notice",
            SslVerify = false,
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ClusterLogging

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class ClusterLogging : CustomResource

Constructors

ClusterLogging(String, ClusterLoggingArgs, CustomResourceOptions)

Create a ClusterLogging resource with the given unique name, arguments, and options.

Declaration

public ClusterLogging(string name, ClusterLoggingArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterLoggingArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Annotations

Annotations for Cluster Logging object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ClusterId

The cluster id to configure logging (string)

Declaration

public Output<string> ClusterId { get; }

Property Value

Type	Description
Output<System.String>

CustomTargetConfig

The custom target config for Cluster Logging. For kind = custom. Conflicts with elasticsearch_config, fluentd_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

Declaration

public Output<ClusterLoggingCustomTargetConfig> CustomTargetConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingCustomTargetConfig>

ElasticsearchConfig

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with custom_target_config, fluentd_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

Declaration

public Output<ClusterLoggingElasticsearchConfig> ElasticsearchConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingElasticsearchConfig>

EnableJsonParsing

Enable json log parsing. Default: false (bool)

Declaration

public Output<bool?> EnableJsonParsing { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

FluentdConfig

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with custom_target_config, elasticsearch_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

Declaration

public Output<ClusterLoggingFluentdConfig> FluentdConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingFluentdConfig>

KafkaConfig

The kafka config for Cluster Logging. For kind = kafka. Conflicts with custom_target_config, elasticsearch_config, fluentd_config, splunk_config and syslog_config (list maxitems:1)

Declaration

public Output<ClusterLoggingKafkaConfig> KafkaConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingKafkaConfig>

Kind

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

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

Labels

Labels for Cluster Logging object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

The name of the cluster logging config (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamespaceId

The namespace id from cluster logging (string)

Declaration

public Output<string> NamespaceId { get; }

Property Value

Type	Description
Output<System.String>

OutputFlushInterval

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

Declaration

public Output<int?> OutputFlushInterval { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

OutputTags

The output tags for Cluster Logging (map)

Declaration

public Output<ImmutableDictionary<string, object>> OutputTags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

SplunkConfig

The splunk config for Cluster Logging. For kind = splunk. Conflicts with custom_target_config, elasticsearch_config, fluentd_config, kafka_config, and syslog_config (list maxitems:1)

Declaration

public Output<ClusterLoggingSplunkConfig> SplunkConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingSplunkConfig>

SyslogConfig

The syslog config for Cluster Logging. For kind = syslog. Conflicts with custom_target_config, elasticsearch_config, fluentd_config, kafka_config, and splunk_config (list maxitems:1)

Declaration

public Output<ClusterLoggingSyslogConfig> SyslogConfig { get; }

Property Value

Type	Description
Output<ClusterLoggingSyslogConfig>

Methods

Get(String, Input<String>, ClusterLoggingState, CustomResourceOptions)

Get an existing ClusterLogging resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ClusterLogging Get(string name, Input<string> id, ClusterLoggingState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterLoggingState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClusterLogging