Provider

Consul v3.14.0, Jan 30 26

Consul v3.14.0 published on Friday, Jan 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

Consul v3.14.0 published on Friday, Jan 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

The provider type for the consul package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             address: Optional[str] = None,
             auth_jwt: Optional[ProviderAuthJwtArgs] = None,
             auth_login_aws: Optional[ProviderAuthLoginAwsArgs] = None,
             ca_file: Optional[str] = None,
             ca_path: Optional[str] = None,
             ca_pem: Optional[str] = None,
             cert_file: Optional[str] = None,
             cert_pem: Optional[str] = None,
             datacenter: Optional[str] = None,
             headers: Optional[Sequence[ProviderHeaderArgs]] = None,
             http_auth: Optional[str] = None,
             insecure_https: Optional[bool] = None,
             key_file: Optional[str] = None,
             key_pem: Optional[str] = None,
             namespace: Optional[str] = None,
             scheme: Optional[str] = None,
             token: Optional[str] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:consul
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 ProviderArgs: 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 ProviderArgs: 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 ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Address string: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
AuthJwt ProviderAuthJwt: Authenticates to Consul using a JWT authentication method.
AuthLoginAws ProviderAuthLoginAws: Login to Consul using the AWS IAM auth method
CaFile string: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
CaPath string: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
CaPem string: PEM-encoded certificate authority used to verify the remote agent's certificate.
CertFile string: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
CertPem string: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
Datacenter string: The datacenter to use. Defaults to that of the agent.
Headers List<ProviderHeader>: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
HttpAuth string: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
InsecureHttps bool: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
KeyFile string: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
KeyPem string: PEM-encoded private key, required if cert_file or cert_pem is specified.
Namespace string
Scheme string: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
Token string: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

Address string: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
AuthJwt ProviderAuthJwtArgs: Authenticates to Consul using a JWT authentication method.
AuthLoginAws ProviderAuthLoginAwsArgs: Login to Consul using the AWS IAM auth method
CaFile string: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
CaPath string: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
CaPem string: PEM-encoded certificate authority used to verify the remote agent's certificate.
CertFile string: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
CertPem string: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
Datacenter string: The datacenter to use. Defaults to that of the agent.
Headers []ProviderHeaderArgs: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
HttpAuth string: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
InsecureHttps bool: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
KeyFile string: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
KeyPem string: PEM-encoded private key, required if cert_file or cert_pem is specified.
Namespace string
Scheme string: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
Token string: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

address String: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
authJwt ProviderAuthJwt: Authenticates to Consul using a JWT authentication method.
authLoginAws ProviderAuthLoginAws: Login to Consul using the AWS IAM auth method
caFile String: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
caPath String: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
caPem String: PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile String: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
certPem String: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
datacenter String: The datacenter to use. Defaults to that of the agent.
headers List<ProviderHeader>: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
httpAuth String: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
insecureHttps Boolean: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
keyFile String: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
keyPem String: PEM-encoded private key, required if cert_file or cert_pem is specified.
namespace String
scheme String: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
token String: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

address string: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
authJwt ProviderAuthJwt: Authenticates to Consul using a JWT authentication method.
authLoginAws ProviderAuthLoginAws: Login to Consul using the AWS IAM auth method
caFile string: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
caPath string: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
caPem string: PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile string: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
certPem string: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
datacenter string: The datacenter to use. Defaults to that of the agent.
headers ProviderHeader[]: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
httpAuth string: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
insecureHttps boolean: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
keyFile string: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
keyPem string: PEM-encoded private key, required if cert_file or cert_pem is specified.
namespace string
scheme string: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
token string: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

address str: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
auth_jwt ProviderAuthJwtArgs: Authenticates to Consul using a JWT authentication method.
auth_login_aws ProviderAuthLoginAwsArgs: Login to Consul using the AWS IAM auth method
ca_file str: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
ca_path str: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
ca_pem str: PEM-encoded certificate authority used to verify the remote agent's certificate.
cert_file str: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
cert_pem str: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
datacenter str: The datacenter to use. Defaults to that of the agent.
headers Sequence[ProviderHeaderArgs]: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
http_auth str: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
insecure_https bool: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
key_file str: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
key_pem str: PEM-encoded private key, required if cert_file or cert_pem is specified.
namespace str
scheme str: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
token str: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

address String: The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
authJwt Property Map: Authenticates to Consul using a JWT authentication method.
authLoginAws Property Map: Login to Consul using the AWS IAM auth method
caFile String: A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
caPath String: A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the CONSUL_CAPATH environment variable.
caPem String: PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile String: A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
certPem String: PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
datacenter String: The datacenter to use. Defaults to that of the agent.
headers List<Property Map>: A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
httpAuth String: HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using the CONSUL_HTTP_AUTH environment variable.
insecureHttps Boolean: Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
keyFile String: A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
keyPem String: PEM-encoded private key, required if cert_file or cert_pem is specified.
namespace String
scheme String: The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
token String: The ACL token to use by default when making requests to the agent. Can also be specified with CONSUL_HTTP_TOKEN or CONSUL_TOKEN as an environment variable.

Outputs

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

Provider Resource Methods

TerraformConfig Method

This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

Using TerraformConfig

terraformConfig(): Output<Provider.TerraformConfigResult>

def terraform_config() -> Output[Provider.Terraform_configResult]

func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)

public Output<Provider.TerraformConfigResult> TerraformConfig()

TerraformConfig Result

Result Dictionary<string, object>

Result map[string]interface{}

result Map<String,Object>

result {[key: string]: any}

result Mapping[str, Any]

result Map<Any>

Supporting Types

ProviderAuthJwt, ProviderAuthJwtArgs

AuthMethod string: The name of the auth method to use for login.
BearerToken string: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
Meta Dictionary<string, string>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
UseTerraformCloudWorkloadIdentity bool

AuthMethod string: The name of the auth method to use for login.
BearerToken string: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
Meta map[string]string: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
UseTerraformCloudWorkloadIdentity bool

authMethod String: The name of the auth method to use for login.
bearerToken String: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
meta Map<String,String>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
useTerraformCloudWorkloadIdentity Boolean

authMethod string: The name of the auth method to use for login.
bearerToken string: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
meta {[key: string]: string}: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
useTerraformCloudWorkloadIdentity boolean

auth_method str: The name of the auth method to use for login.
bearer_token str: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
meta Mapping[str, str]: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
use_terraform_cloud_workload_identity bool

authMethod String: The name of the auth method to use for login.
bearerToken String: The bearer token to present to the auth method during login for authentication purposes. For the Kubernetes auth method this is a Service Account Token (JWT).
meta Map<String>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
useTerraformCloudWorkloadIdentity Boolean

ProviderAuthLoginAws, ProviderAuthLoginAwsArgs

AuthMethod string: The name of the Consul auth method to use for login.
AwsAccessKeyId string: The AWS access key ID.
AwsIamEndpoint string: The IAM endpoint URL.
AwsProfile string: The name of the AWS profile.
AwsRegion string: The AWS region.
AwsRoleArn string: The ARN of the AWS Role to assume. Used during STS AssumeRole
AwsRoleSessionName string: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
AwsSecretAccessKey string: The AWS secret access key.
AwsSessionToken string: The AWS session token.
AwsSharedCredentialsFile string: Path to the AWS shared credentials file.
AwsStsEndpoint string: The STS endpoint URL.
AwsWebIdentityTokenFile string: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
Meta Dictionary<string, string>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
Namespace string: The Consul namespace to authenticate to.
Partition string: The Consul admin partition to authenticate to.
ServerIdHeaderValue string: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

AuthMethod string: The name of the Consul auth method to use for login.
AwsAccessKeyId string: The AWS access key ID.
AwsIamEndpoint string: The IAM endpoint URL.
AwsProfile string: The name of the AWS profile.
AwsRegion string: The AWS region.
AwsRoleArn string: The ARN of the AWS Role to assume. Used during STS AssumeRole
AwsRoleSessionName string: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
AwsSecretAccessKey string: The AWS secret access key.
AwsSessionToken string: The AWS session token.
AwsSharedCredentialsFile string: Path to the AWS shared credentials file.
AwsStsEndpoint string: The STS endpoint URL.
AwsWebIdentityTokenFile string: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
Meta map[string]string: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
Namespace string: The Consul namespace to authenticate to.
Partition string: The Consul admin partition to authenticate to.
ServerIdHeaderValue string: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

authMethod String: The name of the Consul auth method to use for login.
awsAccessKeyId String: The AWS access key ID.
awsIamEndpoint String: The IAM endpoint URL.
awsProfile String: The name of the AWS profile.
awsRegion String: The AWS region.
awsRoleArn String: The ARN of the AWS Role to assume. Used during STS AssumeRole
awsRoleSessionName String: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
awsSecretAccessKey String: The AWS secret access key.
awsSessionToken String: The AWS session token.
awsSharedCredentialsFile String: Path to the AWS shared credentials file.
awsStsEndpoint String: The STS endpoint URL.
awsWebIdentityTokenFile String: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
meta Map<String,String>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
namespace String: The Consul namespace to authenticate to.
partition String: The Consul admin partition to authenticate to.
serverIdHeaderValue String: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

authMethod string: The name of the Consul auth method to use for login.
awsAccessKeyId string: The AWS access key ID.
awsIamEndpoint string: The IAM endpoint URL.
awsProfile string: The name of the AWS profile.
awsRegion string: The AWS region.
awsRoleArn string: The ARN of the AWS Role to assume. Used during STS AssumeRole
awsRoleSessionName string: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
awsSecretAccessKey string: The AWS secret access key.
awsSessionToken string: The AWS session token.
awsSharedCredentialsFile string: Path to the AWS shared credentials file.
awsStsEndpoint string: The STS endpoint URL.
awsWebIdentityTokenFile string: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
meta {[key: string]: string}: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
namespace string: The Consul namespace to authenticate to.
partition string: The Consul admin partition to authenticate to.
serverIdHeaderValue string: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

auth_method str: The name of the Consul auth method to use for login.
aws_access_key_id str: The AWS access key ID.
aws_iam_endpoint str: The IAM endpoint URL.
aws_profile str: The name of the AWS profile.
aws_region str: The AWS region.
aws_role_arn str: The ARN of the AWS Role to assume. Used during STS AssumeRole
aws_role_session_name str: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
aws_secret_access_key str: The AWS secret access key.
aws_session_token str: The AWS session token.
aws_shared_credentials_file str: Path to the AWS shared credentials file.
aws_sts_endpoint str: The STS endpoint URL.
aws_web_identity_token_file str: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
meta Mapping[str, str]: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
namespace str: The Consul namespace to authenticate to.
partition str: The Consul admin partition to authenticate to.
server_id_header_value str: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

authMethod String: The name of the Consul auth method to use for login.
awsAccessKeyId String: The AWS access key ID.
awsIamEndpoint String: The IAM endpoint URL.
awsProfile String: The name of the AWS profile.
awsRegion String: The AWS region.
awsRoleArn String: The ARN of the AWS Role to assume. Used during STS AssumeRole
awsRoleSessionName String: Specifies the name to attach to the AWS role session. Used during STS AssumeRole
awsSecretAccessKey String: The AWS secret access key.
awsSessionToken String: The AWS session token.
awsSharedCredentialsFile String: Path to the AWS shared credentials file.
awsStsEndpoint String: The STS endpoint URL.
awsWebIdentityTokenFile String: Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
meta Map<String>: Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
namespace String: The Consul namespace to authenticate to.
partition String: The Consul admin partition to authenticate to.
serverIdHeaderValue String: The Consul Server ID header value to include in the STS signing request. This must match the ServerIDHeaderValue configured in the Consul auth method.

ProviderHeader, ProviderHeaderArgs

Name string: The name of the header.
Value string: The value of the header.

Name string: The name of the header.
Value string: The value of the header.

name String: The name of the header.
value String: The value of the header.

name string: The name of the header.
value string: The value of the header.

name str: The name of the header.
value str: The value of the header.

name String: The name of the header.
value String: The value of the header.

Package Details

Repository: HashiCorp Consul pulumi/pulumi-consul
License: Apache-2.0
Notes: This Pulumi package is based on the consul Terraform Provider.

Consul v3.14.0 published on Friday, Jan 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

consul.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Provider Resource Methods

TerraformConfig Method

Using TerraformConfig

TerraformConfig Result

Supporting Types

ProviderAuthJwt, ProviderAuthJwtArgs

ProviderAuthLoginAws, ProviderAuthLoginAwsArgs

ProviderHeader, ProviderHeaderArgs

Package Details

On this page

On this page