published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
K8S Auth config
Create K8sAuthConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new K8sAuthConfig(name: string, args: K8sAuthConfigArgs, opts?: CustomResourceOptions);@overload
def K8sAuthConfig(resource_name: str,
args: K8sAuthConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def K8sAuthConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_id: Optional[str] = None,
cluster_api_type: Optional[str] = None,
disable_issuer_validation: Optional[str] = None,
k8s_auth_config_id: Optional[str] = None,
k8s_auth_type: Optional[str] = None,
k8s_ca_cert: Optional[str] = None,
k8s_client_certificate: Optional[str] = None,
k8s_client_key: Optional[str] = None,
k8s_host: Optional[str] = None,
k8s_issuer: Optional[str] = None,
name: Optional[str] = None,
rancher_api_key: Optional[str] = None,
rancher_cluster_id: Optional[str] = None,
retry: Optional[K8sAuthConfigRetryArgs] = None,
signing_key: Optional[str] = None,
token_exp: Optional[float] = None,
token_reviewer_jwt: Optional[str] = None,
use_local_ca_jwt: Optional[bool] = None)func NewK8sAuthConfig(ctx *Context, name string, args K8sAuthConfigArgs, opts ...ResourceOption) (*K8sAuthConfig, error)public K8sAuthConfig(string name, K8sAuthConfigArgs args, CustomResourceOptions? opts = null)
public K8sAuthConfig(String name, K8sAuthConfigArgs args)
public K8sAuthConfig(String name, K8sAuthConfigArgs args, CustomResourceOptions options)
type: akeyless:K8sAuthConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_k8s_auth_config" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args K8sAuthConfigArgs
- 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 K8sAuthConfigArgs
- 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 K8sAuthConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args K8sAuthConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args K8sAuthConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var k8sAuthConfigResource = new Akeyless.K8sAuthConfig("k8sAuthConfigResource", new()
{
AccessId = "string",
ClusterApiType = "string",
DisableIssuerValidation = "string",
K8sAuthConfigId = "string",
K8sAuthType = "string",
K8sCaCert = "string",
K8sClientCertificate = "string",
K8sClientKey = "string",
K8sHost = "string",
K8sIssuer = "string",
Name = "string",
RancherApiKey = "string",
RancherClusterId = "string",
Retry = new Akeyless.Inputs.K8sAuthConfigRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
SigningKey = "string",
TokenExp = 0.0,
TokenReviewerJwt = "string",
UseLocalCaJwt = false,
});
example, err := akeyless.NewK8sAuthConfig(ctx, "k8sAuthConfigResource", &akeyless.K8sAuthConfigArgs{
AccessId: pulumi.String("string"),
ClusterApiType: pulumi.String("string"),
DisableIssuerValidation: pulumi.String("string"),
K8sAuthConfigId: pulumi.String("string"),
K8sAuthType: pulumi.String("string"),
K8sCaCert: pulumi.String("string"),
K8sClientCertificate: pulumi.String("string"),
K8sClientKey: pulumi.String("string"),
K8sHost: pulumi.String("string"),
K8sIssuer: pulumi.String("string"),
Name: pulumi.String("string"),
RancherApiKey: pulumi.String("string"),
RancherClusterId: pulumi.String("string"),
Retry: &akeyless.K8sAuthConfigRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SigningKey: pulumi.String("string"),
TokenExp: pulumi.Float64(0),
TokenReviewerJwt: pulumi.String("string"),
UseLocalCaJwt: pulumi.Bool(false),
})
resource "akeyless_k8s_auth_config" "k8sAuthConfigResource" {
lifecycle {
create_before_destroy = true
}
access_id = "string"
cluster_api_type = "string"
disable_issuer_validation = "string"
k8s_auth_config_id = "string"
k8s_auth_type = "string"
k8s_ca_cert = "string"
k8s_client_certificate = "string"
k8s_client_key = "string"
k8s_host = "string"
k8s_issuer = "string"
name = "string"
rancher_api_key = "string"
rancher_cluster_id = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
signing_key = "string"
token_exp = 0
token_reviewer_jwt = "string"
use_local_ca_jwt = false
}
var k8sAuthConfigResource = new K8sAuthConfig("k8sAuthConfigResource", K8sAuthConfigArgs.builder()
.accessId("string")
.clusterApiType("string")
.disableIssuerValidation("string")
.k8sAuthConfigId("string")
.k8sAuthType("string")
.k8sCaCert("string")
.k8sClientCertificate("string")
.k8sClientKey("string")
.k8sHost("string")
.k8sIssuer("string")
.name("string")
.rancherApiKey("string")
.rancherClusterId("string")
.retry(K8sAuthConfigRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.signingKey("string")
.tokenExp(0.0)
.tokenReviewerJwt("string")
.useLocalCaJwt(false)
.build());
k8s_auth_config_resource = akeyless.K8sAuthConfig("k8sAuthConfigResource",
access_id="string",
cluster_api_type="string",
disable_issuer_validation="string",
k8s_auth_config_id="string",
k8s_auth_type="string",
k8s_ca_cert="string",
k8s_client_certificate="string",
k8s_client_key="string",
k8s_host="string",
k8s_issuer="string",
name="string",
rancher_api_key="string",
rancher_cluster_id="string",
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
},
signing_key="string",
token_exp=float(0),
token_reviewer_jwt="string",
use_local_ca_jwt=False)
const k8sAuthConfigResource = new akeyless.K8sAuthConfig("k8sAuthConfigResource", {
accessId: "string",
clusterApiType: "string",
disableIssuerValidation: "string",
k8sAuthConfigId: "string",
k8sAuthType: "string",
k8sCaCert: "string",
k8sClientCertificate: "string",
k8sClientKey: "string",
k8sHost: "string",
k8sIssuer: "string",
name: "string",
rancherApiKey: "string",
rancherClusterId: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
signingKey: "string",
tokenExp: 0,
tokenReviewerJwt: "string",
useLocalCaJwt: false,
});
type: akeyless:K8sAuthConfig
properties:
accessId: string
clusterApiType: string
disableIssuerValidation: string
k8sAuthConfigId: string
k8sAuthType: string
k8sCaCert: string
k8sClientCertificate: string
k8sClientKey: string
k8sHost: string
k8sIssuer: string
name: string
rancherApiKey: string
rancherClusterId: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
signingKey: string
tokenExp: 0
tokenReviewerJwt: string
useLocalCaJwt: false
K8sAuthConfig 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 K8sAuthConfig resource accepts the following input properties:
- Access
Id string - The access ID of the Kubernetes auth method
- Cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- Disable
Issuer stringValidation - Disable issuer validation [true/false]
- K8s
Auth stringConfig Id - The ID of this resource.
- K8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- K8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- K8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Host string - The URL of the kubernetes API server
- K8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- Name string
- K8S Auth config name
- Rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- Rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- Retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- Token
Exp double - Time in seconds of expiration of the Akeyless Kube Auth Method token
- Token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- Use
Local boolCa Jwt - Use the GW's service account
- Access
Id string - The access ID of the Kubernetes auth method
- Cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- Disable
Issuer stringValidation - Disable issuer validation [true/false]
- K8s
Auth stringConfig Id - The ID of this resource.
- K8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- K8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- K8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Host string - The URL of the kubernetes API server
- K8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- Name string
- K8S Auth config name
- Rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- Rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- Retry
K8s
Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- Token
Exp float64 - Time in seconds of expiration of the Akeyless Kube Auth Method token
- Token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- Use
Local boolCa Jwt - Use the GW's service account
- access_
id string - The access ID of the Kubernetes auth method
- cluster_
api_ stringtype - Cluster access type. options: [native_k8s, rancher]
- disable_
issuer_ stringvalidation - Disable issuer validation [true/false]
- k8s_
auth_ stringconfig_ id - The ID of this resource.
- k8s_
auth_ stringtype - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s_
ca_ stringcert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s_
client_ stringcertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
client_ stringkey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
host string - The URL of the kubernetes API server
- k8s_
issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name string
- K8S Auth config name
- rancher_
api_ stringkey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher_
cluster_ stringid - The cluster id as define in rancher (relevant for "rancher" only)
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token_
exp number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token_
reviewer_ stringjwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use_
local_ boolca_ jwt - Use the GW's service account
- access
Id String - The access ID of the Kubernetes auth method
- cluster
Api StringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer StringValidation - Disable issuer validation [true/false]
- k8s
Auth StringConfig Id - The ID of this resource.
- k8s
Auth StringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca StringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client StringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client StringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host String - The URL of the kubernetes API server
- k8s
Issuer String - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name String
- K8S Auth config name
- rancher
Api StringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster StringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key String - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp Double - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer StringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local BooleanCa Jwt - Use the GW's service account
- access
Id string - The access ID of the Kubernetes auth method
- cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer stringValidation - Disable issuer validation [true/false]
- k8s
Auth stringConfig Id - The ID of this resource.
- k8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host string - The URL of the kubernetes API server
- k8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name string
- K8S Auth config name
- rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local booleanCa Jwt - Use the GW's service account
- access_
id str - The access ID of the Kubernetes auth method
- cluster_
api_ strtype - Cluster access type. options: [native_k8s, rancher]
- disable_
issuer_ strvalidation - Disable issuer validation [true/false]
- k8s_
auth_ strconfig_ id - The ID of this resource.
- k8s_
auth_ strtype - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s_
ca_ strcert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s_
client_ strcertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
client_ strkey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
host str - The URL of the kubernetes API server
- k8s_
issuer str - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name str
- K8S Auth config name
- rancher_
api_ strkey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher_
cluster_ strid - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key str - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token_
exp float - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token_
reviewer_ strjwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use_
local_ boolca_ jwt - Use the GW's service account
- access
Id String - The access ID of the Kubernetes auth method
- cluster
Api StringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer StringValidation - Disable issuer validation [true/false]
- k8s
Auth StringConfig Id - The ID of this resource.
- k8s
Auth StringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca StringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client StringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client StringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host String - The URL of the kubernetes API server
- k8s
Issuer String - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name String
- K8S Auth config name
- rancher
Api StringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster StringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key String - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp Number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer StringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local BooleanCa Jwt - Use the GW's service account
Outputs
All input properties are implicitly available as output properties. Additionally, the K8sAuthConfig 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 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.
Look up Existing K8sAuthConfig Resource
Get an existing K8sAuthConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: K8sAuthConfigState, opts?: CustomResourceOptions): K8sAuthConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_id: Optional[str] = None,
cluster_api_type: Optional[str] = None,
disable_issuer_validation: Optional[str] = None,
k8s_auth_config_id: Optional[str] = None,
k8s_auth_type: Optional[str] = None,
k8s_ca_cert: Optional[str] = None,
k8s_client_certificate: Optional[str] = None,
k8s_client_key: Optional[str] = None,
k8s_host: Optional[str] = None,
k8s_issuer: Optional[str] = None,
name: Optional[str] = None,
rancher_api_key: Optional[str] = None,
rancher_cluster_id: Optional[str] = None,
retry: Optional[K8sAuthConfigRetryArgs] = None,
signing_key: Optional[str] = None,
token_exp: Optional[float] = None,
token_reviewer_jwt: Optional[str] = None,
use_local_ca_jwt: Optional[bool] = None) -> K8sAuthConfigfunc GetK8sAuthConfig(ctx *Context, name string, id IDInput, state *K8sAuthConfigState, opts ...ResourceOption) (*K8sAuthConfig, error)public static K8sAuthConfig Get(string name, Input<string> id, K8sAuthConfigState? state, CustomResourceOptions? opts = null)public static K8sAuthConfig get(String name, Output<String> id, K8sAuthConfigState state, CustomResourceOptions options)resources: existingK8sAuthConfig: type: akeyless:K8sAuthConfig get: id: ${id}import {
to = akeyless_k8s_auth_config.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state K8sAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state K8sAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state K8sAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state K8sAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Access
Id string - The access ID of the Kubernetes auth method
- Cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- Disable
Issuer stringValidation - Disable issuer validation [true/false]
- K8s
Auth stringConfig Id - The ID of this resource.
- K8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- K8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- K8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Host string - The URL of the kubernetes API server
- K8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- Name string
- K8S Auth config name
- Rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- Rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- Retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- Token
Exp double - Time in seconds of expiration of the Akeyless Kube Auth Method token
- Token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- Use
Local boolCa Jwt - Use the GW's service account
- Access
Id string - The access ID of the Kubernetes auth method
- Cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- Disable
Issuer stringValidation - Disable issuer validation [true/false]
- K8s
Auth stringConfig Id - The ID of this resource.
- K8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- K8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- K8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- K8s
Host string - The URL of the kubernetes API server
- K8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- Name string
- K8S Auth config name
- Rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- Rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- Retry
K8s
Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- Token
Exp float64 - Time in seconds of expiration of the Akeyless Kube Auth Method token
- Token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- Use
Local boolCa Jwt - Use the GW's service account
- access_
id string - The access ID of the Kubernetes auth method
- cluster_
api_ stringtype - Cluster access type. options: [native_k8s, rancher]
- disable_
issuer_ stringvalidation - Disable issuer validation [true/false]
- k8s_
auth_ stringconfig_ id - The ID of this resource.
- k8s_
auth_ stringtype - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s_
ca_ stringcert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s_
client_ stringcertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
client_ stringkey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
host string - The URL of the kubernetes API server
- k8s_
issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name string
- K8S Auth config name
- rancher_
api_ stringkey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher_
cluster_ stringid - The cluster id as define in rancher (relevant for "rancher" only)
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token_
exp number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token_
reviewer_ stringjwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use_
local_ boolca_ jwt - Use the GW's service account
- access
Id String - The access ID of the Kubernetes auth method
- cluster
Api StringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer StringValidation - Disable issuer validation [true/false]
- k8s
Auth StringConfig Id - The ID of this resource.
- k8s
Auth StringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca StringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client StringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client StringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host String - The URL of the kubernetes API server
- k8s
Issuer String - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name String
- K8S Auth config name
- rancher
Api StringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster StringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key String - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp Double - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer StringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local BooleanCa Jwt - Use the GW's service account
- access
Id string - The access ID of the Kubernetes auth method
- cluster
Api stringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer stringValidation - Disable issuer validation [true/false]
- k8s
Auth stringConfig Id - The ID of this resource.
- k8s
Auth stringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca stringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client stringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client stringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host string - The URL of the kubernetes API server
- k8s
Issuer string - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name string
- K8S Auth config name
- rancher
Api stringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster stringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key string - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer stringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local booleanCa Jwt - Use the GW's service account
- access_
id str - The access ID of the Kubernetes auth method
- cluster_
api_ strtype - Cluster access type. options: [native_k8s, rancher]
- disable_
issuer_ strvalidation - Disable issuer validation [true/false]
- k8s_
auth_ strconfig_ id - The ID of this resource.
- k8s_
auth_ strtype - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s_
ca_ strcert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s_
client_ strcertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
client_ strkey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s_
host str - The URL of the kubernetes API server
- k8s_
issuer str - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name str
- K8S Auth config name
- rancher_
api_ strkey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher_
cluster_ strid - The cluster id as define in rancher (relevant for "rancher" only)
- retry
K8s
Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key str - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token_
exp float - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token_
reviewer_ strjwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use_
local_ boolca_ jwt - Use the GW's service account
- access
Id String - The access ID of the Kubernetes auth method
- cluster
Api StringType - Cluster access type. options: [native_k8s, rancher]
- disable
Issuer StringValidation - Disable issuer validation [true/false]
- k8s
Auth StringConfig Id - The ID of this resource.
- k8s
Auth StringType - K8S auth type [token/certificate]. (relevant for "native_k8s" only)
- k8s
Ca StringCert - The CA Certificate (base64 encoded) to use to call into the kubernetes API server
- k8s
Client StringCertificate - Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Client StringKey - Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)
- k8s
Host String - The URL of the kubernetes API server
- k8s
Issuer String - The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token
- name String
- K8S Auth config name
- rancher
Api StringKey - The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)
- rancher
Cluster StringId - The cluster id as define in rancher (relevant for "rancher" only)
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key String - The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth
- token
Exp Number - Time in seconds of expiration of the Akeyless Kube Auth Method token
- token
Reviewer StringJwt - A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.
- use
Local BooleanCa Jwt - Use the GW's service account
Supporting Types
K8sAuthConfigRetry, K8sAuthConfigRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community