1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. Provider
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    The provider type for the akeyless 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,
                 api_gateway_address: Optional[str] = None,
                 api_key_logins: Optional[Sequence[ProviderApiKeyLoginArgs]] = None,
                 aws_iam_logins: Optional[Sequence[ProviderAwsIamLoginArgs]] = None,
                 azure_ad_logins: Optional[Sequence[ProviderAzureAdLoginArgs]] = None,
                 cert_logins: Optional[Sequence[ProviderCertLoginArgs]] = None,
                 email_logins: Optional[Sequence[ProviderEmailLoginArgs]] = None,
                 gcp_logins: Optional[Sequence[ProviderGcpLoginArgs]] = None,
                 jwt_logins: Optional[Sequence[ProviderJwtLoginArgs]] = None,
                 retry: Optional[ProviderRetryArgs] = None,
                 token_logins: Optional[Sequence[ProviderTokenLoginArgs]] = None,
                 uid_logins: Optional[Sequence[ProviderUidLoginArgs]] = 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:akeyless
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumi_providers_akeyless" "name" {
        # resource properties
    }

    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:

    ApiGatewayAddress string
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    ApiKeyLogins List<ProviderApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins List<ProviderAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins List<ProviderAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins List<ProviderCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    EmailLogins List<ProviderEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins List<ProviderGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    JwtLogins List<ProviderJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    Retry ProviderRetry
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    TokenLogins List<ProviderTokenLogin>
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    UidLogins List<ProviderUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    ApiGatewayAddress string
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    ApiKeyLogins []ProviderApiKeyLoginArgs
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins []ProviderAwsIamLoginArgs
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins []ProviderAzureAdLoginArgs
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins []ProviderCertLoginArgs
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    EmailLogins []ProviderEmailLoginArgs
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins []ProviderGcpLoginArgs
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    JwtLogins []ProviderJwtLoginArgs
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    Retry ProviderRetryArgs
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    TokenLogins []ProviderTokenLoginArgs
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    UidLogins []ProviderUidLoginArgs
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    api_gateway_address string
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    api_key_logins list(object)
    A configuration block, described below, that attempts to authenticate using API-Key.
    aws_iam_logins list(object)
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azure_ad_logins list(object)
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    cert_logins list(object)
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    email_logins list(object)
    A configuration block, described below, that attempts to authenticate using email and password.
    gcp_logins list(object)
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwt_logins list(object)
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    retry object
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    token_logins list(object)
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    uid_logins list(object)
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiGatewayAddress String
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    apiKeyLogins List<ProviderApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<ProviderAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<ProviderAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<ProviderCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    emailLogins List<ProviderEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<ProviderGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins List<ProviderJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    retry ProviderRetry
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    tokenLogins List<ProviderTokenLogin>
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    uidLogins List<ProviderUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiGatewayAddress string
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    apiKeyLogins ProviderApiKeyLogin[]
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins ProviderAwsIamLogin[]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins ProviderAzureAdLogin[]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins ProviderCertLogin[]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    emailLogins ProviderEmailLogin[]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins ProviderGcpLogin[]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins ProviderJwtLogin[]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    retry ProviderRetry
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    tokenLogins ProviderTokenLogin[]
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    uidLogins ProviderUidLogin[]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    api_gateway_address str
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    api_key_logins Sequence[ProviderApiKeyLoginArgs]
    A configuration block, described below, that attempts to authenticate using API-Key.
    aws_iam_logins Sequence[ProviderAwsIamLoginArgs]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azure_ad_logins Sequence[ProviderAzureAdLoginArgs]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    cert_logins Sequence[ProviderCertLoginArgs]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    email_logins Sequence[ProviderEmailLoginArgs]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcp_logins Sequence[ProviderGcpLoginArgs]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwt_logins Sequence[ProviderJwtLoginArgs]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    retry ProviderRetryArgs
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    token_logins Sequence[ProviderTokenLoginArgs]
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    uid_logins Sequence[ProviderUidLoginArgs]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiGatewayAddress String
    Origin URL of the API Gateway server. This is a URL with a scheme, a hostname and a port.
    apiKeyLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_CERT and AKEYLESS_AUTH_KEY.
    emailLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_JWT.
    retry Property Map
    Default retry for all resources when the error matches error_message_regex or the HTTP status is in retry_on_status_codes. A resource retry block overrides it. See the Customized Retry guide.
    tokenLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using akeyless token. The token can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESS_AUTH_TOKEN.
    uidLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.

    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 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<{[key: string]: any}>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (pulumi.MapOutput, error)
    public Output<ImmutableDictionary<string, object>> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result map(any)
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Supporting Types

    ProviderApiKeyLogin, ProviderApiKeyLoginArgs

    AccessId string
    AccessKey string
    AccessId string
    AccessKey string
    access_id string
    access_key string
    accessId String
    accessKey String
    accessId string
    accessKey string
    accessId String
    accessKey String

    ProviderAwsIamLogin, ProviderAwsIamLoginArgs

    AccessId string
    AccessId string
    access_id string
    accessId String
    accessId string
    accessId String

    ProviderAzureAdLogin, ProviderAzureAdLoginArgs

    AccessId string
    AccessId string
    access_id string
    accessId String
    accessId string
    accessId String

    ProviderCertLogin, ProviderCertLoginArgs

    AccessId string
    CertData string
    CertFileName string
    KeyData string
    KeyFileName string
    AccessId string
    CertData string
    CertFileName string
    KeyData string
    KeyFileName string
    accessId String
    certData String
    certFileName String
    keyData String
    keyFileName String
    accessId string
    certData string
    certFileName string
    keyData string
    keyFileName string
    accessId String
    certData String
    certFileName String
    keyData String
    keyFileName String

    ProviderEmailLogin, ProviderEmailLoginArgs

    ProviderGcpLogin, ProviderGcpLoginArgs

    AccessId string
    Audience string
    AccessId string
    Audience string
    access_id string
    audience string
    accessId String
    audience String
    accessId string
    audience string
    accessId String
    audience String

    ProviderJwtLogin, ProviderJwtLoginArgs

    AccessId string
    Jwt string
    AccessId string
    Jwt string
    access_id string
    jwt string
    accessId String
    jwt String
    accessId string
    jwt string
    access_id str
    jwt str
    accessId String
    jwt String

    ProviderRetry, ProviderRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    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_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    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_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    ProviderTokenLogin, ProviderTokenLoginArgs

    Token string
    Token string
    token string
    token String
    token string
    token str
    token String

    ProviderUidLogin, ProviderUidLoginArgs

    UidToken string
    AccessId string
    UidToken string
    AccessId string
    uid_token string
    access_id string
    uidToken String
    accessId String
    uidToken string
    accessId string
    uidToken String
    accessId String

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial