1. Packages
  2. HashiCorp Consul
  3. API Docs
  4. Provider
Consul v3.11.0 published on Monday, Nov 20, 2023 by Pulumi

consul.Provider

Explore with Pulumi AI

consul logo
Consul v3.11.0 published on Monday, Nov 20, 2023 by Pulumi

    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

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 address: Optional[str] = None,
                 auth_jwt: Optional[ProviderAuthJwtArgs] = 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)
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = 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.
    
    
    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

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    Supporting Types

    ProviderAuthJwt, ProviderAuthJwtArgs

    AuthMethod string
    BearerToken string
    Meta Dictionary<string, string>
    UseTerraformCloudWorkloadIdentity bool
    authMethod String
    bearerToken String
    meta Map<String,String>
    useTerraformCloudWorkloadIdentity Boolean
    authMethod string
    bearerToken string
    meta {[key: string]: string}
    useTerraformCloudWorkloadIdentity boolean

    ProviderHeader, ProviderHeaderArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    Package Details

    Repository
    HashiCorp Consul pulumi/pulumi-consul
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the consul Terraform Provider.

    consul logo
    Consul v3.11.0 published on Monday, Nov 20, 2023 by Pulumi