1. Packages
  2. Fortios
  3. API Docs
  4. wirelesscontroller
  5. Region
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.wirelesscontroller.Region

Explore with Pulumi AI

Configure FortiAP regions (for floor plans and maps).

Create Region Resource

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

Constructor syntax

new Region(name: string, args?: RegionArgs, opts?: CustomResourceOptions);
@overload
def Region(resource_name: str,
           args: Optional[RegionArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Region(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           comments: Optional[str] = None,
           grayscale: Optional[str] = None,
           image_type: Optional[str] = None,
           name: Optional[str] = None,
           opacity: Optional[int] = None,
           vdomparam: Optional[str] = None)
func NewRegion(ctx *Context, name string, args *RegionArgs, opts ...ResourceOption) (*Region, error)
public Region(string name, RegionArgs? args = null, CustomResourceOptions? opts = null)
public Region(String name, RegionArgs args)
public Region(String name, RegionArgs args, CustomResourceOptions options)
type: fortios:wirelesscontroller:Region
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args RegionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args RegionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args RegionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args RegionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RegionArgs
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 fortiosRegionResource = new Fortios.Wirelesscontroller.Region("fortiosRegionResource", new()
{
    Comments = "string",
    Grayscale = "string",
    ImageType = "string",
    Name = "string",
    Opacity = 0,
    Vdomparam = "string",
});
Copy
example, err := wirelesscontroller.NewRegion(ctx, "fortiosRegionResource", &wirelesscontroller.RegionArgs{
	Comments:  pulumi.String("string"),
	Grayscale: pulumi.String("string"),
	ImageType: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Opacity:   pulumi.Int(0),
	Vdomparam: pulumi.String("string"),
})
Copy
var fortiosRegionResource = new com.pulumi.fortios.wirelesscontroller.Region("fortiosRegionResource", com.pulumi.fortios.wirelesscontroller.RegionArgs.builder()
    .comments("string")
    .grayscale("string")
    .imageType("string")
    .name("string")
    .opacity(0)
    .vdomparam("string")
    .build());
Copy
fortios_region_resource = fortios.wirelesscontroller.Region("fortiosRegionResource",
    comments="string",
    grayscale="string",
    image_type="string",
    name="string",
    opacity=0,
    vdomparam="string")
Copy
const fortiosRegionResource = new fortios.wirelesscontroller.Region("fortiosRegionResource", {
    comments: "string",
    grayscale: "string",
    imageType: "string",
    name: "string",
    opacity: 0,
    vdomparam: "string",
});
Copy
type: fortios:wirelesscontroller:Region
properties:
    comments: string
    grayscale: string
    imageType: string
    name: string
    opacity: 0
    vdomparam: string
Copy

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

Comments string
Comments.
Grayscale string
Region image grayscale. Valid values: enable, disable.
ImageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
Name Changes to this property will trigger replacement. string
FortiAP region name.
Opacity int
Region image opacity (0 - 100).
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Comments string
Comments.
Grayscale string
Region image grayscale. Valid values: enable, disable.
ImageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
Name Changes to this property will trigger replacement. string
FortiAP region name.
Opacity int
Region image opacity (0 - 100).
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments String
Comments.
grayscale String
Region image grayscale. Valid values: enable, disable.
imageType String
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. String
FortiAP region name.
opacity Integer
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments string
Comments.
grayscale string
Region image grayscale. Valid values: enable, disable.
imageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. string
FortiAP region name.
opacity number
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments str
Comments.
grayscale str
Region image grayscale. Valid values: enable, disable.
image_type str
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. str
FortiAP region name.
opacity int
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments String
Comments.
grayscale String
Region image grayscale. Valid values: enable, disable.
imageType String
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. String
FortiAP region name.
opacity Number
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

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

Get an existing Region 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?: RegionState, opts?: CustomResourceOptions): Region
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comments: Optional[str] = None,
        grayscale: Optional[str] = None,
        image_type: Optional[str] = None,
        name: Optional[str] = None,
        opacity: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Region
func GetRegion(ctx *Context, name string, id IDInput, state *RegionState, opts ...ResourceOption) (*Region, error)
public static Region Get(string name, Input<string> id, RegionState? state, CustomResourceOptions? opts = null)
public static Region get(String name, Output<String> id, RegionState state, CustomResourceOptions options)
resources:  _:    type: fortios:wirelesscontroller:Region    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Comments string
Comments.
Grayscale string
Region image grayscale. Valid values: enable, disable.
ImageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
Name Changes to this property will trigger replacement. string
FortiAP region name.
Opacity int
Region image opacity (0 - 100).
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Comments string
Comments.
Grayscale string
Region image grayscale. Valid values: enable, disable.
ImageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
Name Changes to this property will trigger replacement. string
FortiAP region name.
Opacity int
Region image opacity (0 - 100).
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments String
Comments.
grayscale String
Region image grayscale. Valid values: enable, disable.
imageType String
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. String
FortiAP region name.
opacity Integer
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments string
Comments.
grayscale string
Region image grayscale. Valid values: enable, disable.
imageType string
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. string
FortiAP region name.
opacity number
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments str
Comments.
grayscale str
Region image grayscale. Valid values: enable, disable.
image_type str
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. str
FortiAP region name.
opacity int
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
comments String
Comments.
grayscale String
Region image grayscale. Valid values: enable, disable.
imageType String
FortiAP region image type (png|jpeg|gif). Valid values: png, jpeg, gif.
name Changes to this property will trigger replacement. String
FortiAP region name.
opacity Number
Region image opacity (0 - 100).
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Import

WirelessController Region can be imported using any of these accepted formats:

$ pulumi import fortios:wirelesscontroller/region:Region labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:wirelesscontroller/region:Region labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.