1. Packages
  2. Fortios
  3. API Docs
  4. firewall
  5. City
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.firewall.City

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Define city table. Applies to FortiOS Version >= 6.4.0.

    Create City Resource

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

    Constructor syntax

    new City(name: string, args?: CityArgs, opts?: CustomResourceOptions);
    @overload
    def City(resource_name: str,
             args: Optional[CityArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def City(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             fosid: Optional[int] = None,
             name: Optional[str] = None,
             vdomparam: Optional[str] = None)
    func NewCity(ctx *Context, name string, args *CityArgs, opts ...ResourceOption) (*City, error)
    public City(string name, CityArgs? args = null, CustomResourceOptions? opts = null)
    public City(String name, CityArgs args)
    public City(String name, CityArgs args, CustomResourceOptions options)
    
    type: fortios:firewall:City
    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 CityArgs
    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 CityArgs
    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 CityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CityArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var cityResource = new Fortios.Firewall.City("cityResource", new()
    {
        Fosid = 0,
        Name = "string",
        Vdomparam = "string",
    });
    
    example, err := firewall.NewCity(ctx, "cityResource", &firewall.CityArgs{
    	Fosid:     pulumi.Int(0),
    	Name:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var cityResource = new City("cityResource", CityArgs.builder()        
        .fosid(0)
        .name("string")
        .vdomparam("string")
        .build());
    
    city_resource = fortios.firewall.City("cityResource",
        fosid=0,
        name="string",
        vdomparam="string")
    
    const cityResource = new fortios.firewall.City("cityResource", {
        fosid: 0,
        name: "string",
        vdomparam: "string",
    });
    
    type: fortios:firewall:City
    properties:
        fosid: 0
        name: string
        vdomparam: string
    

    City Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The City resource accepts the following input properties:

    Fosid int
    City ID.
    Name string
    City name.
    Vdomparam 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.
    Fosid int
    City ID.
    Name string
    City name.
    Vdomparam 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.
    fosid Integer
    City ID.
    name String
    City name.
    vdomparam 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.
    fosid number
    City ID.
    name string
    City name.
    vdomparam 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.
    fosid int
    City ID.
    name str
    City name.
    vdomparam 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.
    fosid Number
    City ID.
    name String
    City name.
    vdomparam 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 City 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 City Resource

    Get an existing City 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?: CityState, opts?: CustomResourceOptions): City
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fosid: Optional[int] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> City
    func GetCity(ctx *Context, name string, id IDInput, state *CityState, opts ...ResourceOption) (*City, error)
    public static City Get(string name, Input<string> id, CityState? state, CustomResourceOptions? opts = null)
    public static City get(String name, Output<String> id, CityState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Fosid int
    City ID.
    Name string
    City name.
    Vdomparam 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.
    Fosid int
    City ID.
    Name string
    City name.
    Vdomparam 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.
    fosid Integer
    City ID.
    name String
    City name.
    vdomparam 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.
    fosid number
    City ID.
    name string
    City name.
    vdomparam 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.
    fosid int
    City ID.
    name str
    City name.
    vdomparam 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.
    fosid Number
    City ID.
    name String
    City name.
    vdomparam 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

    Firewall City can be imported using any of these accepted formats:

    $ pulumi import fortios:firewall/city:City labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/city:City labelname {{fosid}}
    

    $ 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.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse