1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. AccountCustomField
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.AccountCustomField

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    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)
    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.

    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,
});

    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),
})

    var accountCustomFieldResource = new AccountCustomField("accountCustomFieldResource", AccountCustomFieldArgs.builder()
    .objectType("string")
    .accountCustomFieldId("string")
    .name("string")
    .object("string")
    .required(false)
    .build());

    account_custom_field_resource = akeyless.AccountCustomField("accountCustomFieldResource",
    object_type="string",
    account_custom_field_id="string",
    name="string",
    object="string",
    required=False)

    const accountCustomFieldResource = new akeyless.AccountCustomField("accountCustomFieldResource", {
    objectType: "string",
    accountCustomFieldId: "string",
    name: "string",
    object: "string",
    required: false,
});

    type: akeyless:AccountCustomField
properties:
    accountCustomFieldId: string
    name: string
    object: string
    objectType: string
    required: false

    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:

    ObjectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    AccountCustomFieldId string
    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
    ObjectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    AccountCustomFieldId string
    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
    objectType String
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    accountCustomFieldId String
    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
    objectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    accountCustomFieldId string
    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
    object_type str
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    account_custom_field_id str
    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
    objectType String
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    accountCustomFieldId String
    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

    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 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) -> AccountCustomField
    func 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:  _:    type: akeyless:AccountCustomField    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountCustomFieldId string
    The ID of this resource.
    Name string
    The name of the custom field
    Object string
    The object the custom field applies to
    ObjectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    Required bool
    Whether the custom field is mandatory
    AccountCustomFieldId string
    The ID of this resource.
    Name string
    The name of the custom field
    Object string
    The object the custom field applies to
    ObjectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    Required bool
    Whether the custom field is mandatory
    accountCustomFieldId String
    The ID of this resource.
    name String
    The name of the custom field
    object String
    The object the custom field applies to
    objectType String
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    required Boolean
    Whether the custom field is mandatory
    accountCustomFieldId string
    The ID of this resource.
    name string
    The name of the custom field
    object string
    The object the custom field applies to
    objectType string
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    required boolean
    Whether the custom field is mandatory
    account_custom_field_id str
    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
    accountCustomFieldId String
    The ID of this resource.
    name String
    The name of the custom field
    object String
    The object the custom field applies to
    objectType String
    The type of object [STATICSECRET, DYNAMICSECRET, ROTATED_SECRET]
    required Boolean
    Whether the custom field is mandatory

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.