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

fortios.user.Pop3

Explore with Pulumi AI

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

    POP3 server entry configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.user.Pop3("trname", {
        port: 0,
        secure: "pop3s",
        server: "1.1.1.1",
        sslMinProtoVersion: "default",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.user.Pop3("trname",
        port=0,
        secure="pop3s",
        server="1.1.1.1",
        ssl_min_proto_version="default")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/user"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := user.NewPop3(ctx, "trname", &user.Pop3Args{
    			Port:               pulumi.Int(0),
    			Secure:             pulumi.String("pop3s"),
    			Server:             pulumi.String("1.1.1.1"),
    			SslMinProtoVersion: pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.User.Pop3("trname", new()
        {
            Port = 0,
            Secure = "pop3s",
            Server = "1.1.1.1",
            SslMinProtoVersion = "default",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.user.Pop3;
    import com.pulumi.fortios.user.Pop3Args;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var trname = new Pop3("trname", Pop3Args.builder()        
                .port(0)
                .secure("pop3s")
                .server("1.1.1.1")
                .sslMinProtoVersion("default")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:user:Pop3
        properties:
          port: 0
          secure: pop3s
          server: 1.1.1.1
          sslMinProtoVersion: default
    

    Create Pop3 Resource

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

    Constructor syntax

    new Pop3(name: string, args: Pop3Args, opts?: CustomResourceOptions);
    @overload
    def Pop3(resource_name: str,
             args: Pop3Args,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Pop3(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             server: Optional[str] = None,
             name: Optional[str] = None,
             port: Optional[int] = None,
             secure: Optional[str] = None,
             ssl_min_proto_version: Optional[str] = None,
             vdomparam: Optional[str] = None)
    func NewPop3(ctx *Context, name string, args Pop3Args, opts ...ResourceOption) (*Pop3, error)
    public Pop3(string name, Pop3Args args, CustomResourceOptions? opts = null)
    public Pop3(String name, Pop3Args args)
    public Pop3(String name, Pop3Args args, CustomResourceOptions options)
    
    type: fortios:user:Pop3
    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 Pop3Args
    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 Pop3Args
    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 Pop3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Pop3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Pop3Args
    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 pop3Resource = new Fortios.User.Pop3("pop3Resource", new()
    {
        Server = "string",
        Name = "string",
        Port = 0,
        Secure = "string",
        SslMinProtoVersion = "string",
        Vdomparam = "string",
    });
    
    example, err := user.NewPop3(ctx, "pop3Resource", &user.Pop3Args{
    	Server:             pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Port:               pulumi.Int(0),
    	Secure:             pulumi.String("string"),
    	SslMinProtoVersion: pulumi.String("string"),
    	Vdomparam:          pulumi.String("string"),
    })
    
    var pop3Resource = new Pop3("pop3Resource", Pop3Args.builder()
        .server("string")
        .name("string")
        .port(0)
        .secure("string")
        .sslMinProtoVersion("string")
        .vdomparam("string")
        .build());
    
    pop3_resource = fortios.user.Pop3("pop3Resource",
        server="string",
        name="string",
        port=0,
        secure="string",
        ssl_min_proto_version="string",
        vdomparam="string")
    
    const pop3Resource = new fortios.user.Pop3("pop3Resource", {
        server: "string",
        name: "string",
        port: 0,
        secure: "string",
        sslMinProtoVersion: "string",
        vdomparam: "string",
    });
    
    type: fortios:user:Pop3
    properties:
        name: string
        port: 0
        secure: string
        server: string
        sslMinProtoVersion: string
        vdomparam: string
    

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

    Server string
    {<name_str|ip_str>} server domain name or IP.
    Name string
    POP3 server entry name.
    Port int
    POP3 service port number.
    Secure string
    SSL connection. Valid values: none, starttls, pop3s.
    SslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    Server string
    {<name_str|ip_str>} server domain name or IP.
    Name string
    POP3 server entry name.
    Port int
    POP3 service port number.
    Secure string
    SSL connection. Valid values: none, starttls, pop3s.
    SslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    server String
    {<name_str|ip_str>} server domain name or IP.
    name String
    POP3 server entry name.
    port Integer
    POP3 service port number.
    secure String
    SSL connection. Valid values: none, starttls, pop3s.
    sslMinProtoVersion String
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    server string
    {<name_str|ip_str>} server domain name or IP.
    name string
    POP3 server entry name.
    port number
    POP3 service port number.
    secure string
    SSL connection. Valid values: none, starttls, pop3s.
    sslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    server str
    {<name_str|ip_str>} server domain name or IP.
    name str
    POP3 server entry name.
    port int
    POP3 service port number.
    secure str
    SSL connection. Valid values: none, starttls, pop3s.
    ssl_min_proto_version str
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    server String
    {<name_str|ip_str>} server domain name or IP.
    name String
    POP3 server entry name.
    port Number
    POP3 service port number.
    secure String
    SSL connection. Valid values: none, starttls, pop3s.
    sslMinProtoVersion String
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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 Pop3 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 Pop3 Resource

    Get an existing Pop3 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?: Pop3State, opts?: CustomResourceOptions): Pop3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            secure: Optional[str] = None,
            server: Optional[str] = None,
            ssl_min_proto_version: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Pop3
    func GetPop3(ctx *Context, name string, id IDInput, state *Pop3State, opts ...ResourceOption) (*Pop3, error)
    public static Pop3 Get(string name, Input<string> id, Pop3State? state, CustomResourceOptions? opts = null)
    public static Pop3 get(String name, Output<String> id, Pop3State 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:
    Name string
    POP3 server entry name.
    Port int
    POP3 service port number.
    Secure string
    SSL connection. Valid values: none, starttls, pop3s.
    Server string
    {<name_str|ip_str>} server domain name or IP.
    SslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    Name string
    POP3 server entry name.
    Port int
    POP3 service port number.
    Secure string
    SSL connection. Valid values: none, starttls, pop3s.
    Server string
    {<name_str|ip_str>} server domain name or IP.
    SslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    name String
    POP3 server entry name.
    port Integer
    POP3 service port number.
    secure String
    SSL connection. Valid values: none, starttls, pop3s.
    server String
    {<name_str|ip_str>} server domain name or IP.
    sslMinProtoVersion String
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    name string
    POP3 server entry name.
    port number
    POP3 service port number.
    secure string
    SSL connection. Valid values: none, starttls, pop3s.
    server string
    {<name_str|ip_str>} server domain name or IP.
    sslMinProtoVersion string
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    name str
    POP3 server entry name.
    port int
    POP3 service port number.
    secure str
    SSL connection. Valid values: none, starttls, pop3s.
    server str
    {<name_str|ip_str>} server domain name or IP.
    ssl_min_proto_version str
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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.
    name String
    POP3 server entry name.
    port Number
    POP3 service port number.
    secure String
    SSL connection. Valid values: none, starttls, pop3s.
    server String
    {<name_str|ip_str>} server domain name or IP.
    sslMinProtoVersion String
    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
    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

    User Pop3 can be imported using any of these accepted formats:

    $ pulumi import fortios:user/pop3:Pop3 labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/pop3:Pop3 labelname {{name}}
    

    $ 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