published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
Account Custom Field resource
Create AccountCustomField Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AccountCustomField(name: string, args: AccountCustomFieldArgs, opts?: CustomResourceOptions);@overload
def AccountCustomField(resource_name: str,
args: AccountCustomFieldArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AccountCustomField(resource_name: str,
opts: Optional[ResourceOptions] = None,
object_type: Optional[str] = None,
account_custom_field_id: Optional[str] = None,
name: Optional[str] = None,
object: Optional[str] = None,
required: Optional[bool] = None,
retry: Optional[AccountCustomFieldRetryArgs] = None)func NewAccountCustomField(ctx *Context, name string, args AccountCustomFieldArgs, opts ...ResourceOption) (*AccountCustomField, error)public AccountCustomField(string name, AccountCustomFieldArgs args, CustomResourceOptions? opts = null)
public AccountCustomField(String name, AccountCustomFieldArgs args)
public AccountCustomField(String name, AccountCustomFieldArgs args, CustomResourceOptions options)
type: akeyless:AccountCustomField
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_account_custom_field" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AccountCustomFieldArgs
- 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 AccountCustomFieldArgs
- 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 AccountCustomFieldArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccountCustomFieldArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccountCustomFieldArgs
- 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 accountCustomFieldResource = new Akeyless.AccountCustomField("accountCustomFieldResource", new()
{
ObjectType = "string",
AccountCustomFieldId = "string",
Name = "string",
Object = "string",
Required = false,
Retry = new Akeyless.Inputs.AccountCustomFieldRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
});
example, err := akeyless.NewAccountCustomField(ctx, "accountCustomFieldResource", &akeyless.AccountCustomFieldArgs{
ObjectType: pulumi.String("string"),
AccountCustomFieldId: pulumi.String("string"),
Name: pulumi.String("string"),
Object: pulumi.String("string"),
Required: pulumi.Bool(false),
Retry: &akeyless.AccountCustomFieldRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
})
resource "akeyless_account_custom_field" "accountCustomFieldResource" {
lifecycle {
create_before_destroy = true
}
object_type = "string"
account_custom_field_id = "string"
name = "string"
object = "string"
required = false
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
}
var accountCustomFieldResource = new AccountCustomField("accountCustomFieldResource", AccountCustomFieldArgs.builder()
.objectType("string")
.accountCustomFieldId("string")
.name("string")
.object("string")
.required(false)
.retry(AccountCustomFieldRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.build());
account_custom_field_resource = akeyless.AccountCustomField("accountCustomFieldResource",
object_type="string",
account_custom_field_id="string",
name="string",
object="string",
required=False,
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
})
const accountCustomFieldResource = new akeyless.AccountCustomField("accountCustomFieldResource", {
objectType: "string",
accountCustomFieldId: "string",
name: "string",
object: "string",
required: false,
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
});
type: akeyless:AccountCustomField
properties:
accountCustomFieldId: string
name: string
object: string
objectType: string
required: false
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
AccountCustomField 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 AccountCustomField resource accepts the following input properties:
- Object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- Account
Custom stringField Id - The ID of this resource.
- Name string
- The name of the custom field
- Object string
- The object the custom field applies to
- Required bool
- Whether the custom field is mandatory
- Retry
Account
Custom Field 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.
- Object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- Account
Custom stringField Id - The ID of this resource.
- Name string
- The name of the custom field
- Object string
- The object the custom field applies to
- Required bool
- Whether the custom field is mandatory
- Retry
Account
Custom Field 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.
- object_
type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- account_
custom_ stringfield_ id - The ID of this resource.
- name string
- The name of the custom field
- object string
- The object the custom field applies to
- required bool
- Whether the custom field is mandatory
- 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.
- object
Type String - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- account
Custom StringField Id - The ID of this resource.
- name String
- The name of the custom field
- object String
- The object the custom field applies to
- required Boolean
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- account
Custom stringField Id - The ID of this resource.
- name string
- The name of the custom field
- object string
- The object the custom field applies to
- required boolean
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- object_
type str - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- account_
custom_ strfield_ id - The ID of this resource.
- name str
- The name of the custom field
- object str
- The object the custom field applies to
- required bool
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- object
Type String - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- account
Custom StringField Id - The ID of this resource.
- name String
- The name of the custom field
- object String
- The object the custom field applies to
- required Boolean
- Whether the custom field is mandatory
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the AccountCustomField 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 AccountCustomField Resource
Get an existing AccountCustomField 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?: AccountCustomFieldState, opts?: CustomResourceOptions): AccountCustomField@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_custom_field_id: Optional[str] = None,
name: Optional[str] = None,
object: Optional[str] = None,
object_type: Optional[str] = None,
required: Optional[bool] = None,
retry: Optional[AccountCustomFieldRetryArgs] = None) -> AccountCustomFieldfunc GetAccountCustomField(ctx *Context, name string, id IDInput, state *AccountCustomFieldState, opts ...ResourceOption) (*AccountCustomField, error)public static AccountCustomField Get(string name, Input<string> id, AccountCustomFieldState? state, CustomResourceOptions? opts = null)public static AccountCustomField get(String name, Output<String> id, AccountCustomFieldState state, CustomResourceOptions options)resources: existingAccountCustomField: type: akeyless:AccountCustomField get: id: ${id}import {
to = akeyless_account_custom_field.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 AccountCustomFieldState
- 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 AccountCustomFieldState
- 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 AccountCustomFieldState
- 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 AccountCustomFieldState
- 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.
- Account
Custom stringField Id - The ID of this resource.
- Name string
- The name of the custom field
- Object string
- The object the custom field applies to
- Object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- Required bool
- Whether the custom field is mandatory
- Retry
Account
Custom Field 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.
- Account
Custom stringField Id - The ID of this resource.
- Name string
- The name of the custom field
- Object string
- The object the custom field applies to
- Object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- Required bool
- Whether the custom field is mandatory
- Retry
Account
Custom Field 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.
- account_
custom_ stringfield_ id - The ID of this resource.
- name string
- The name of the custom field
- object string
- The object the custom field applies to
- object_
type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- required bool
- Whether the custom field is mandatory
- 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.
- account
Custom StringField Id - The ID of this resource.
- name String
- The name of the custom field
- object String
- The object the custom field applies to
- object
Type String - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- required Boolean
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- account
Custom stringField Id - The ID of this resource.
- name string
- The name of the custom field
- object string
- The object the custom field applies to
- object
Type string - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- required boolean
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- account_
custom_ strfield_ id - The ID of this resource.
- name str
- The name of the custom field
- object str
- The object the custom field applies to
- object_
type str - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- required bool
- Whether the custom field is mandatory
- retry
Account
Custom Field 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.
- account
Custom StringField Id - The ID of this resource.
- name String
- The name of the custom field
- object String
- The object the custom field applies to
- object
Type String - The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
- required Boolean
- Whether the custom field is mandatory
- 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.
Supporting Types
AccountCustomFieldRetry, AccountCustomFieldRetryArgs
- 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