Class AutopilotConfig

Provides access to the Autopilot Configuration of Consul to automatically manage Consul servers.

It includes to automatically cleanup dead servers, monitor the status of the Raft cluster and stable server introduction.

Example Usage

using Pulumi;
using Consul = Pulumi.Consul;

class MyStack : Stack
{
public MyStack()
{
    var config = new Consul.AutopilotConfig("config", new Consul.AutopilotConfigArgs
    {
        CleanupDeadServers = false,
        LastContactThreshold = "1s",
        MaxTrailingLogs = 500,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AutopilotConfig

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.Consul

Assembly: Pulumi.Consul.dll

Syntax

public class AutopilotConfig : CustomResource

Constructors

AutopilotConfig(String, AutopilotConfigArgs, CustomResourceOptions)

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

Declaration

public AutopilotConfig(string name, AutopilotConfigArgs args = null, CustomResourceOptions options = null)

Parameters

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

Properties

CleanupDeadServers

Whether to remove failing servers when a replacement comes online. Defaults to true.

Declaration

public Output<bool?> CleanupDeadServers { get; }

Property Value

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

Datacenter

The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.

Declaration

public Output<string> Datacenter { get; }

Property Value

Type	Description
Output<System.String>

DisableUpgradeMigration

Whether to disable upgrade migrations. Defaults to false.

Declaration

public Output<bool?> DisableUpgradeMigration { get; }

Property Value

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

LastContactThreshold

The time after which a server is considered as unhealthy and will be removed. Defaults to "200ms".

Declaration

public Output<string> LastContactThreshold { get; }

Property Value

Type	Description
Output<System.String>

MaxTrailingLogs

The maximum number of Raft log entries a server can trail the leader. Defaults to 250.

Declaration

public Output<int?> MaxTrailingLogs { get; }

Property Value

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

RedundancyZoneTag

The redundancy zone tag to use. Consul will try to keep one voting server by zone to take advantage of isolated failure domains. Defaults to an empty string.

Declaration

public Output<string> RedundancyZoneTag { get; }

Property Value

Type	Description
Output<System.String>

ServerStabilizationTime

The period to wait for a server to be healthy and stable before being promoted to a full, voting member. Defaults to "10s".

Declaration

public Output<string> ServerStabilizationTime { get; }

Property Value

Type	Description
Output<System.String>

UpgradeVersionTag

The tag to override the version information used during a migration. Defaults to an empty string.

Declaration

public Output<string> UpgradeVersionTag { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static AutopilotConfig Get(string name, Input<string> id, AutopilotConfigState 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.
AutopilotConfigState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AutopilotConfig