fortimanager 1.13.0, Mar 13 25

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortinetdev/terraform-provider-fortimanager

fortimanager.SystemAdminProfileDatamaskcustomfields

Explore with Pulumi AI

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortinetdev/terraform-provider-fortimanager

Create SystemAdminProfileDatamaskcustomfields Resource

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

Constructor syntax

new SystemAdminProfileDatamaskcustomfields(name: string, args: SystemAdminProfileDatamaskcustomfieldsArgs, opts?: CustomResourceOptions);

@overload
def SystemAdminProfileDatamaskcustomfields(resource_name: str,
                                           args: SystemAdminProfileDatamaskcustomfieldsArgs,
                                           opts: Optional[ResourceOptions] = None)

@overload
def SystemAdminProfileDatamaskcustomfields(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           profile: Optional[str] = None,
                                           field_categories: Optional[Sequence[str]] = None,
                                           field_name: Optional[str] = None,
                                           field_status: Optional[str] = None,
                                           field_type: Optional[str] = None,
                                           system_admin_profile_datamaskcustomfields_id: Optional[str] = None)

func NewSystemAdminProfileDatamaskcustomfields(ctx *Context, name string, args SystemAdminProfileDatamaskcustomfieldsArgs, opts ...ResourceOption) (*SystemAdminProfileDatamaskcustomfields, error)

public SystemAdminProfileDatamaskcustomfields(string name, SystemAdminProfileDatamaskcustomfieldsArgs args, CustomResourceOptions? opts = null)

public SystemAdminProfileDatamaskcustomfields(String name, SystemAdminProfileDatamaskcustomfieldsArgs args)
public SystemAdminProfileDatamaskcustomfields(String name, SystemAdminProfileDatamaskcustomfieldsArgs args, CustomResourceOptions options)

type: fortimanager:SystemAdminProfileDatamaskcustomfields
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 SystemAdminProfileDatamaskcustomfieldsArgs: 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 SystemAdminProfileDatamaskcustomfieldsArgs: 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 SystemAdminProfileDatamaskcustomfieldsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SystemAdminProfileDatamaskcustomfieldsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SystemAdminProfileDatamaskcustomfieldsArgs: 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 systemAdminProfileDatamaskcustomfieldsResource = new Fortimanager.SystemAdminProfileDatamaskcustomfields("systemAdminProfileDatamaskcustomfieldsResource", new()
{
    Profile = "string",
    FieldCategories = new[]
    {
        "string",
    },
    FieldName = "string",
    FieldStatus = "string",
    FieldType = "string",
    SystemAdminProfileDatamaskcustomfieldsId = "string",
});

example, err := fortimanager.NewSystemAdminProfileDatamaskcustomfields(ctx, "systemAdminProfileDatamaskcustomfieldsResource", &fortimanager.SystemAdminProfileDatamaskcustomfieldsArgs{
Profile: pulumi.String("string"),
FieldCategories: pulumi.StringArray{
pulumi.String("string"),
},
FieldName: pulumi.String("string"),
FieldStatus: pulumi.String("string"),
FieldType: pulumi.String("string"),
SystemAdminProfileDatamaskcustomfieldsId: pulumi.String("string"),
})

var systemAdminProfileDatamaskcustomfieldsResource = new SystemAdminProfileDatamaskcustomfields("systemAdminProfileDatamaskcustomfieldsResource", SystemAdminProfileDatamaskcustomfieldsArgs.builder()
    .profile("string")
    .fieldCategories("string")
    .fieldName("string")
    .fieldStatus("string")
    .fieldType("string")
    .systemAdminProfileDatamaskcustomfieldsId("string")
    .build());

system_admin_profile_datamaskcustomfields_resource = fortimanager.SystemAdminProfileDatamaskcustomfields("systemAdminProfileDatamaskcustomfieldsResource",
    profile="string",
    field_categories=["string"],
    field_name="string",
    field_status="string",
    field_type="string",
    system_admin_profile_datamaskcustomfields_id="string")

const systemAdminProfileDatamaskcustomfieldsResource = new fortimanager.SystemAdminProfileDatamaskcustomfields("systemAdminProfileDatamaskcustomfieldsResource", {
    profile: "string",
    fieldCategories: ["string"],
    fieldName: "string",
    fieldStatus: "string",
    fieldType: "string",
    systemAdminProfileDatamaskcustomfieldsId: "string",
});

type: fortimanager:SystemAdminProfileDatamaskcustomfields
properties:
    fieldCategories:
        - string
    fieldName: string
    fieldStatus: string
    fieldType: string
    profile: string
    systemAdminProfileDatamaskcustomfieldsId: string

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

Profile string: Profile.
FieldCategories List<string>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
FieldName string: Field name.
FieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
FieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
SystemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

Profile string: Profile.
FieldCategories []string: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
FieldName string: Field name.
FieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
FieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
SystemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

profile String: Profile.
fieldCategories List<String>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName String: Field name.
fieldStatus String: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType String: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
systemAdminProfileDatamaskcustomfieldsId String: an identifier for the resource with format {{field_name}}.

profile string: Profile.
fieldCategories string[]: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName string: Field name.
fieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
systemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

profile str: Profile.
field_categories Sequence[str]: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
field_name str: Field name.
field_status str: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
field_type str: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
system_admin_profile_datamaskcustomfields_id str: an identifier for the resource with format {{field_name}}.

profile String: Profile.
fieldCategories List<String>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName String: Field name.
fieldStatus String: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType String: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
systemAdminProfileDatamaskcustomfieldsId String: an identifier for the resource with format {{field_name}}.

Outputs

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

Get an existing SystemAdminProfileDatamaskcustomfields 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?: SystemAdminProfileDatamaskcustomfieldsState, opts?: CustomResourceOptions): SystemAdminProfileDatamaskcustomfields

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        field_categories: Optional[Sequence[str]] = None,
        field_name: Optional[str] = None,
        field_status: Optional[str] = None,
        field_type: Optional[str] = None,
        profile: Optional[str] = None,
        system_admin_profile_datamaskcustomfields_id: Optional[str] = None) -> SystemAdminProfileDatamaskcustomfields

func GetSystemAdminProfileDatamaskcustomfields(ctx *Context, name string, id IDInput, state *SystemAdminProfileDatamaskcustomfieldsState, opts ...ResourceOption) (*SystemAdminProfileDatamaskcustomfields, error)

public static SystemAdminProfileDatamaskcustomfields Get(string name, Input<string> id, SystemAdminProfileDatamaskcustomfieldsState? state, CustomResourceOptions? opts = null)

public static SystemAdminProfileDatamaskcustomfields get(String name, Output<String> id, SystemAdminProfileDatamaskcustomfieldsState state, CustomResourceOptions options)

resources:  _:    type: fortimanager:SystemAdminProfileDatamaskcustomfields    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:

FieldCategories List<string>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
FieldName string: Field name.
FieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
FieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
Profile string: Profile.
SystemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

FieldCategories []string: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
FieldName string: Field name.
FieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
FieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
Profile string: Profile.
SystemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

fieldCategories List<String>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName String: Field name.
fieldStatus String: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType String: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
profile String: Profile.
systemAdminProfileDatamaskcustomfieldsId String: an identifier for the resource with format {{field_name}}.

fieldCategories string[]: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName string: Field name.
fieldStatus string: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType string: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
profile string: Profile.
systemAdminProfileDatamaskcustomfieldsId string: an identifier for the resource with format {{field_name}}.

field_categories Sequence[str]: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
field_name str: Field name.
field_status str: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
field_type str: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
profile str: Profile.
system_admin_profile_datamaskcustomfields_id str: an identifier for the resource with format {{field_name}}.

fieldCategories List<String>: Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Valid values: log, fortiview, alert, ueba, all.
fieldName String: Field name.
fieldStatus String: Field status. disable - Disable field. enable - Enable field. Valid values: disable, enable.
fieldType String: Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Valid values: string, ip, mac, email, unknown.
profile String: Profile.
systemAdminProfileDatamaskcustomfieldsId String: an identifier for the resource with format {{field_name}}.

Import

System AdminProfileDatamaskCustomFields can be imported using any of these accepted formats:

Set import_options = [“profile=YOUR_VALUE”] in the provider section.

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemAdminProfileDatamaskcustomfields:SystemAdminProfileDatamaskcustomfields labelname {{field_name}}

$ unset “FORTIMANAGER_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes: This Pulumi package is based on the fortimanager Terraform Provider.

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortinetdev/terraform-provider-fortimanager

fortimanager.SystemAdminProfileDatamaskcustomfields

On this page

On this page

Create SystemAdminProfileDatamaskcustomfields Resource

Constructor syntax

Parameters

Constructor example

SystemAdminProfileDatamaskcustomfields Resource Properties

Inputs

Outputs

Look up Existing SystemAdminProfileDatamaskcustomfields Resource

Import

Package Details

On this page

On this page