1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayDefaults
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

    Defaults settings

    Create GatewayDefaults Resource

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

    Constructor syntax

    new GatewayDefaults(name: string, args?: GatewayDefaultsArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayDefaults(resource_name: str,
                        args: Optional[GatewayDefaultsArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayDefaults(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cert_access_id: Optional[str] = None,
                        event_on_status_change: Optional[str] = None,
                        gateway_defaults_id: Optional[str] = None,
                        hvp_route_version: Optional[float] = None,
                        key: Optional[str] = None,
                        oidc_access_id: Optional[str] = None,
                        retry: Optional[GatewayDefaultsRetryArgs] = None,
                        saml_access_id: Optional[str] = None)
    func NewGatewayDefaults(ctx *Context, name string, args *GatewayDefaultsArgs, opts ...ResourceOption) (*GatewayDefaults, error)
    public GatewayDefaults(string name, GatewayDefaultsArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayDefaults(String name, GatewayDefaultsArgs args)
    public GatewayDefaults(String name, GatewayDefaultsArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayDefaults
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_gateway_defaults" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayDefaultsArgs
    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 GatewayDefaultsArgs
    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 GatewayDefaultsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayDefaultsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayDefaultsArgs
    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 gatewayDefaultsResource = new Akeyless.GatewayDefaults("gatewayDefaultsResource", new()
    {
        CertAccessId = "string",
        EventOnStatusChange = "string",
        GatewayDefaultsId = "string",
        HvpRouteVersion = 0.0,
        Key = "string",
        OidcAccessId = "string",
        Retry = new Akeyless.Inputs.GatewayDefaultsRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        SamlAccessId = "string",
    });
    
    example, err := akeyless.NewGatewayDefaults(ctx, "gatewayDefaultsResource", &akeyless.GatewayDefaultsArgs{
    	CertAccessId:        pulumi.String("string"),
    	EventOnStatusChange: pulumi.String("string"),
    	GatewayDefaultsId:   pulumi.String("string"),
    	HvpRouteVersion:     pulumi.Float64(0),
    	Key:                 pulumi.String("string"),
    	OidcAccessId:        pulumi.String("string"),
    	Retry: &akeyless.GatewayDefaultsRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	SamlAccessId: pulumi.String("string"),
    })
    
    resource "akeyless_gateway_defaults" "gatewayDefaultsResource" {
      lifecycle {
        create_before_destroy = true
      }
      cert_access_id         = "string"
      event_on_status_change = "string"
      gateway_defaults_id    = "string"
      hvp_route_version      = 0
      key                    = "string"
      oidc_access_id         = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      saml_access_id = "string"
    }
    
    var gatewayDefaultsResource = new GatewayDefaults("gatewayDefaultsResource", GatewayDefaultsArgs.builder()
        .certAccessId("string")
        .eventOnStatusChange("string")
        .gatewayDefaultsId("string")
        .hvpRouteVersion(0.0)
        .key("string")
        .oidcAccessId("string")
        .retry(GatewayDefaultsRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .samlAccessId("string")
        .build());
    
    gateway_defaults_resource = akeyless.GatewayDefaults("gatewayDefaultsResource",
        cert_access_id="string",
        event_on_status_change="string",
        gateway_defaults_id="string",
        hvp_route_version=float(0),
        key="string",
        oidc_access_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)],
        },
        saml_access_id="string")
    
    const gatewayDefaultsResource = new akeyless.GatewayDefaults("gatewayDefaultsResource", {
        certAccessId: "string",
        eventOnStatusChange: "string",
        gatewayDefaultsId: "string",
        hvpRouteVersion: 0,
        key: "string",
        oidcAccessId: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        samlAccessId: "string",
    });
    
    type: akeyless:GatewayDefaults
    properties:
        certAccessId: string
        eventOnStatusChange: string
        gatewayDefaultsId: string
        hvpRouteVersion: 0
        key: string
        oidcAccessId: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        samlAccessId: string
    

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

    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    HvpRouteVersion double
    Hvp route version to use [1/2]
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    Retry GatewayDefaultsRetry
    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.
    SamlAccessId string
    Default SAML access-id for UI login
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    HvpRouteVersion float64
    Hvp route version to use [1/2]
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    Retry GatewayDefaultsRetryArgs
    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.
    SamlAccessId string
    Default SAML access-id for UI login
    cert_access_id string
    Default Certificate access-id for UI login
    event_on_status_change string
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id string
    The ID of this resource.
    hvp_route_version number
    Hvp route version to use [1/2]
    key string
    The name of the gateway default encryption key
    oidc_access_id string
    Default OIDC access-id for UI login
    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.
    saml_access_id string
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    hvpRouteVersion Double
    Hvp route version to use [1/2]
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetry
    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.
    samlAccessId String
    Default SAML access-id for UI login
    certAccessId string
    Default Certificate access-id for UI login
    eventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId string
    The ID of this resource.
    hvpRouteVersion number
    Hvp route version to use [1/2]
    key string
    The name of the gateway default encryption key
    oidcAccessId string
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetry
    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.
    samlAccessId string
    Default SAML access-id for UI login
    cert_access_id str
    Default Certificate access-id for UI login
    event_on_status_change str
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id str
    The ID of this resource.
    hvp_route_version float
    Hvp route version to use [1/2]
    key str
    The name of the gateway default encryption key
    oidc_access_id str
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetryArgs
    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.
    saml_access_id str
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    hvpRouteVersion Number
    Hvp route version to use [1/2]
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    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.
    samlAccessId String
    Default SAML access-id for UI login

    Outputs

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

    Get an existing GatewayDefaults 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?: GatewayDefaultsState, opts?: CustomResourceOptions): GatewayDefaults
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cert_access_id: Optional[str] = None,
            event_on_status_change: Optional[str] = None,
            gateway_defaults_id: Optional[str] = None,
            hvp_route_version: Optional[float] = None,
            key: Optional[str] = None,
            oidc_access_id: Optional[str] = None,
            retry: Optional[GatewayDefaultsRetryArgs] = None,
            saml_access_id: Optional[str] = None) -> GatewayDefaults
    func GetGatewayDefaults(ctx *Context, name string, id IDInput, state *GatewayDefaultsState, opts ...ResourceOption) (*GatewayDefaults, error)
    public static GatewayDefaults Get(string name, Input<string> id, GatewayDefaultsState? state, CustomResourceOptions? opts = null)
    public static GatewayDefaults get(String name, Output<String> id, GatewayDefaultsState state, CustomResourceOptions options)
    resources:  existingGatewayDefaults:    type: akeyless:GatewayDefaults    get:      id: ${id}
    import {
      to = akeyless_gateway_defaults.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 GatewayDefaultsState
    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 GatewayDefaultsState
    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 GatewayDefaultsState
    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 GatewayDefaultsState
    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.
    The following state arguments are supported:
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    HvpRouteVersion double
    Hvp route version to use [1/2]
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    Retry GatewayDefaultsRetry
    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.
    SamlAccessId string
    Default SAML access-id for UI login
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    HvpRouteVersion float64
    Hvp route version to use [1/2]
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    Retry GatewayDefaultsRetryArgs
    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.
    SamlAccessId string
    Default SAML access-id for UI login
    cert_access_id string
    Default Certificate access-id for UI login
    event_on_status_change string
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id string
    The ID of this resource.
    hvp_route_version number
    Hvp route version to use [1/2]
    key string
    The name of the gateway default encryption key
    oidc_access_id string
    Default OIDC access-id for UI login
    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.
    saml_access_id string
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    hvpRouteVersion Double
    Hvp route version to use [1/2]
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetry
    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.
    samlAccessId String
    Default SAML access-id for UI login
    certAccessId string
    Default Certificate access-id for UI login
    eventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId string
    The ID of this resource.
    hvpRouteVersion number
    Hvp route version to use [1/2]
    key string
    The name of the gateway default encryption key
    oidcAccessId string
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetry
    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.
    samlAccessId string
    Default SAML access-id for UI login
    cert_access_id str
    Default Certificate access-id for UI login
    event_on_status_change str
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id str
    The ID of this resource.
    hvp_route_version float
    Hvp route version to use [1/2]
    key str
    The name of the gateway default encryption key
    oidc_access_id str
    Default OIDC access-id for UI login
    retry GatewayDefaultsRetryArgs
    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.
    saml_access_id str
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    hvpRouteVersion Number
    Hvp route version to use [1/2]
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    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.
    samlAccessId String
    Default SAML access-id for UI login

    Supporting Types

    GatewayDefaultsRetry, GatewayDefaultsRetryArgs

    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.

    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