config

package
v3.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAddress

func GetAddress(ctx *pulumi.Context) string

The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".

func GetAuthJwt

func GetAuthJwt(ctx *pulumi.Context) string

Authenticates to Consul using a JWT authentication method.

func GetCaFile

func GetCaFile(ctx *pulumi.Context) string

A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

func GetCaPath

func GetCaPath(ctx *pulumi.Context) 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.

func GetCaPem

func GetCaPem(ctx *pulumi.Context) string

PEM-encoded certificate authority used to verify the remote agent's certificate.

func GetCertFile

func GetCertFile(ctx *pulumi.Context) string

A path to a PEM-encoded certificate provided to the remote agent; requires use of `keyFile` or `keyPem`.

func GetCertPem

func GetCertPem(ctx *pulumi.Context) string

PEM-encoded certificate provided to the remote agent; requires use of `keyFile` or `keyPem`.

func GetDatacenter

func GetDatacenter(ctx *pulumi.Context) string

The datacenter to use. Defaults to that of the agent.

func GetHeaders

func GetHeaders(ctx *pulumi.Context) string

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.

func GetHttpAuth

func GetHttpAuth(ctx *pulumi.Context) 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.

func GetInsecureHttps

func GetInsecureHttps(ctx *pulumi.Context) 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".

func GetKeyFile

func GetKeyFile(ctx *pulumi.Context) string

A path to a PEM-encoded private key, required if `certFile` or `certPem` is specified.

func GetKeyPem

func GetKeyPem(ctx *pulumi.Context) string

PEM-encoded private key, required if `certFile` or `certPem` is specified.

func GetNamespace

func GetNamespace(ctx *pulumi.Context) string

func GetScheme

func GetScheme(ctx *pulumi.Context) string

The URL scheme of the agent to use ("http" or "https"). Defaults to "http".

func GetToken

func GetToken(ctx *pulumi.Context) 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.

Types

type AuthJwt

type AuthJwt struct {
	// The name of the auth method to use for login.
	AuthMethod string `pulumi:"authMethod"`
	// 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)](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens).
	BearerToken *string `pulumi:"bearerToken"`
	// Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
	Meta                              map[string]string `pulumi:"meta"`
	UseTerraformCloudWorkloadIdentity *bool             `pulumi:"useTerraformCloudWorkloadIdentity"`
}

type AuthJwtArgs

type AuthJwtArgs struct {
	// The name of the auth method to use for login.
	AuthMethod pulumi.StringInput `pulumi:"authMethod"`
	// 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)](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens).
	BearerToken pulumi.StringPtrInput `pulumi:"bearerToken"`
	// Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.
	Meta                              pulumi.StringMapInput `pulumi:"meta"`
	UseTerraformCloudWorkloadIdentity pulumi.BoolPtrInput   `pulumi:"useTerraformCloudWorkloadIdentity"`
}

func (AuthJwtArgs) ElementType

func (AuthJwtArgs) ElementType() reflect.Type

func (AuthJwtArgs) ToAuthJwtOutput

func (i AuthJwtArgs) ToAuthJwtOutput() AuthJwtOutput

func (AuthJwtArgs) ToAuthJwtOutputWithContext

func (i AuthJwtArgs) ToAuthJwtOutputWithContext(ctx context.Context) AuthJwtOutput

type AuthJwtInput

type AuthJwtInput interface {
	pulumi.Input

	ToAuthJwtOutput() AuthJwtOutput
	ToAuthJwtOutputWithContext(context.Context) AuthJwtOutput
}

AuthJwtInput is an input type that accepts AuthJwtArgs and AuthJwtOutput values. You can construct a concrete instance of `AuthJwtInput` via:

AuthJwtArgs{...}

type AuthJwtOutput

type AuthJwtOutput struct{ *pulumi.OutputState }

func (AuthJwtOutput) AuthMethod

func (o AuthJwtOutput) AuthMethod() pulumi.StringOutput

The name of the auth method to use for login.

func (AuthJwtOutput) BearerToken

func (o AuthJwtOutput) BearerToken() pulumi.StringPtrOutput

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)](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens).

func (AuthJwtOutput) ElementType

func (AuthJwtOutput) ElementType() reflect.Type

func (AuthJwtOutput) Meta

Specifies arbitrary KV metadata linked to the token. Can be useful to track origins.

func (AuthJwtOutput) ToAuthJwtOutput

func (o AuthJwtOutput) ToAuthJwtOutput() AuthJwtOutput

func (AuthJwtOutput) ToAuthJwtOutputWithContext

func (o AuthJwtOutput) ToAuthJwtOutputWithContext(ctx context.Context) AuthJwtOutput

func (AuthJwtOutput) UseTerraformCloudWorkloadIdentity

func (o AuthJwtOutput) UseTerraformCloudWorkloadIdentity() pulumi.BoolPtrOutput

type Headers

type Headers struct {
	// The name of the header.
	Name string `pulumi:"name"`
	// The value of the header.
	Value string `pulumi:"value"`
}

type HeadersArgs

type HeadersArgs struct {
	// The name of the header.
	Name pulumi.StringInput `pulumi:"name"`
	// The value of the header.
	Value pulumi.StringInput `pulumi:"value"`
}

func (HeadersArgs) ElementType

func (HeadersArgs) ElementType() reflect.Type

func (HeadersArgs) ToHeadersOutput

func (i HeadersArgs) ToHeadersOutput() HeadersOutput

func (HeadersArgs) ToHeadersOutputWithContext

func (i HeadersArgs) ToHeadersOutputWithContext(ctx context.Context) HeadersOutput

type HeadersArray

type HeadersArray []HeadersInput

func (HeadersArray) ElementType

func (HeadersArray) ElementType() reflect.Type

func (HeadersArray) ToHeadersArrayOutput

func (i HeadersArray) ToHeadersArrayOutput() HeadersArrayOutput

func (HeadersArray) ToHeadersArrayOutputWithContext

func (i HeadersArray) ToHeadersArrayOutputWithContext(ctx context.Context) HeadersArrayOutput

type HeadersArrayInput

type HeadersArrayInput interface {
	pulumi.Input

	ToHeadersArrayOutput() HeadersArrayOutput
	ToHeadersArrayOutputWithContext(context.Context) HeadersArrayOutput
}

HeadersArrayInput is an input type that accepts HeadersArray and HeadersArrayOutput values. You can construct a concrete instance of `HeadersArrayInput` via:

HeadersArray{ HeadersArgs{...} }

type HeadersArrayOutput

type HeadersArrayOutput struct{ *pulumi.OutputState }

func (HeadersArrayOutput) ElementType

func (HeadersArrayOutput) ElementType() reflect.Type

func (HeadersArrayOutput) Index

func (HeadersArrayOutput) ToHeadersArrayOutput

func (o HeadersArrayOutput) ToHeadersArrayOutput() HeadersArrayOutput

func (HeadersArrayOutput) ToHeadersArrayOutputWithContext

func (o HeadersArrayOutput) ToHeadersArrayOutputWithContext(ctx context.Context) HeadersArrayOutput

type HeadersInput

type HeadersInput interface {
	pulumi.Input

	ToHeadersOutput() HeadersOutput
	ToHeadersOutputWithContext(context.Context) HeadersOutput
}

HeadersInput is an input type that accepts HeadersArgs and HeadersOutput values. You can construct a concrete instance of `HeadersInput` via:

HeadersArgs{...}

type HeadersOutput

type HeadersOutput struct{ *pulumi.OutputState }

func (HeadersOutput) ElementType

func (HeadersOutput) ElementType() reflect.Type

func (HeadersOutput) Name

The name of the header.

func (HeadersOutput) ToHeadersOutput

func (o HeadersOutput) ToHeadersOutput() HeadersOutput

func (HeadersOutput) ToHeadersOutputWithContext

func (o HeadersOutput) ToHeadersOutputWithContext(ctx context.Context) HeadersOutput

func (HeadersOutput) Value

func (o HeadersOutput) Value() pulumi.StringOutput

The value of the header.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL