1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectUmsSetting
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.ObjectUmsSetting

Explore with Pulumi AI

fortimanager logo
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

    ObjectUms Setting

    Create ObjectUmsSetting Resource

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

    Constructor syntax

    new ObjectUmsSetting(name: string, args?: ObjectUmsSettingArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectUmsSetting(resource_name: str,
                         args: Optional[ObjectUmsSettingArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectUmsSetting(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         adom: Optional[str] = None,
                         connectors: Optional[Sequence[str]] = None,
                         description: Optional[str] = None,
                         flags: Optional[float] = None,
                         name: Optional[str] = None,
                         object_ums_setting_id: Optional[str] = None,
                         scopetype: Optional[str] = None,
                         type: Optional[str] = None)
    func NewObjectUmsSetting(ctx *Context, name string, args *ObjectUmsSettingArgs, opts ...ResourceOption) (*ObjectUmsSetting, error)
    public ObjectUmsSetting(string name, ObjectUmsSettingArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectUmsSetting(String name, ObjectUmsSettingArgs args)
    public ObjectUmsSetting(String name, ObjectUmsSettingArgs args, CustomResourceOptions options)
    
    type: fortimanager:ObjectUmsSetting
    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 ObjectUmsSettingArgs
    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 ObjectUmsSettingArgs
    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 ObjectUmsSettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectUmsSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectUmsSettingArgs
    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 objectUmsSettingResource = new Fortimanager.ObjectUmsSetting("objectUmsSettingResource", new()
    {
        Adom = "string",
        Connectors = new[]
        {
            "string",
        },
        Description = "string",
        Flags = 0,
        Name = "string",
        ObjectUmsSettingId = "string",
        Scopetype = "string",
        Type = "string",
    });
    
    example, err := fortimanager.NewObjectUmsSetting(ctx, "objectUmsSettingResource", &fortimanager.ObjectUmsSettingArgs{
    	Adom: pulumi.String("string"),
    	Connectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:        pulumi.String("string"),
    	Flags:              pulumi.Float64(0),
    	Name:               pulumi.String("string"),
    	ObjectUmsSettingId: pulumi.String("string"),
    	Scopetype:          pulumi.String("string"),
    	Type:               pulumi.String("string"),
    })
    
    var objectUmsSettingResource = new ObjectUmsSetting("objectUmsSettingResource", ObjectUmsSettingArgs.builder()
        .adom("string")
        .connectors("string")
        .description("string")
        .flags(0)
        .name("string")
        .objectUmsSettingId("string")
        .scopetype("string")
        .type("string")
        .build());
    
    object_ums_setting_resource = fortimanager.ObjectUmsSetting("objectUmsSettingResource",
        adom="string",
        connectors=["string"],
        description="string",
        flags=0,
        name="string",
        object_ums_setting_id="string",
        scopetype="string",
        type="string")
    
    const objectUmsSettingResource = new fortimanager.ObjectUmsSetting("objectUmsSettingResource", {
        adom: "string",
        connectors: ["string"],
        description: "string",
        flags: 0,
        name: "string",
        objectUmsSettingId: "string",
        scopetype: "string",
        type: "string",
    });
    
    type: fortimanager:ObjectUmsSetting
    properties:
        adom: string
        connectors:
            - string
        description: string
        flags: 0
        name: string
        objectUmsSettingId: string
        scopetype: string
        type: string
    

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Connectors List<string>
    Connector.
    Description string
    Description.
    Flags double
    Flags.
    Name string
    Name.
    ObjectUmsSettingId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Type. Valid values: aws, azure, gcp.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Connectors []string
    Connector.
    Description string
    Description.
    Flags float64
    Flags.
    Name string
    Name.
    ObjectUmsSettingId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Type. Valid values: aws, azure, gcp.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors List<String>
    Connector.
    description String
    Description.
    flags Double
    Flags.
    name String
    Name.
    objectUmsSettingId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Type. Valid values: aws, azure, gcp.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors string[]
    Connector.
    description string
    Description.
    flags number
    Flags.
    name string
    Name.
    objectUmsSettingId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Type. Valid values: aws, azure, gcp.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors Sequence[str]
    Connector.
    description str
    Description.
    flags float
    Flags.
    name str
    Name.
    object_ums_setting_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Type. Valid values: aws, azure, gcp.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors List<String>
    Connector.
    description String
    Description.
    flags Number
    Flags.
    name String
    Name.
    objectUmsSettingId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Type. Valid values: aws, azure, gcp.

    Outputs

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

    Get an existing ObjectUmsSetting 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?: ObjectUmsSettingState, opts?: CustomResourceOptions): ObjectUmsSetting
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adom: Optional[str] = None,
            connectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            flags: Optional[float] = None,
            name: Optional[str] = None,
            object_ums_setting_id: Optional[str] = None,
            scopetype: Optional[str] = None,
            type: Optional[str] = None) -> ObjectUmsSetting
    func GetObjectUmsSetting(ctx *Context, name string, id IDInput, state *ObjectUmsSettingState, opts ...ResourceOption) (*ObjectUmsSetting, error)
    public static ObjectUmsSetting Get(string name, Input<string> id, ObjectUmsSettingState? state, CustomResourceOptions? opts = null)
    public static ObjectUmsSetting get(String name, Output<String> id, ObjectUmsSettingState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectUmsSetting    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Connectors List<string>
    Connector.
    Description string
    Description.
    Flags double
    Flags.
    Name string
    Name.
    ObjectUmsSettingId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Type. Valid values: aws, azure, gcp.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Connectors []string
    Connector.
    Description string
    Description.
    Flags float64
    Flags.
    Name string
    Name.
    ObjectUmsSettingId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Type string
    Type. Valid values: aws, azure, gcp.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors List<String>
    Connector.
    description String
    Description.
    flags Double
    Flags.
    name String
    Name.
    objectUmsSettingId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Type. Valid values: aws, azure, gcp.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors string[]
    Connector.
    description string
    Description.
    flags number
    Flags.
    name string
    Name.
    objectUmsSettingId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type string
    Type. Valid values: aws, azure, gcp.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors Sequence[str]
    Connector.
    description str
    Description.
    flags float
    Flags.
    name str
    Name.
    object_ums_setting_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type str
    Type. Valid values: aws, azure, gcp.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    connectors List<String>
    Connector.
    description String
    Description.
    flags Number
    Flags.
    name String
    Name.
    objectUmsSettingId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    type String
    Type. Valid values: aws, azure, gcp.

    Import

    ObjectUms Setting can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectUmsSetting:ObjectUmsSetting labelname {{name}}
    

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    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 logo
    fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev