1. Packages
  2. Routeros Provider
  3. API Docs
  4. WireguardKeys
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

routeros.WireguardKeys

Explore with Pulumi AI

routeros logo
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

    # routeros.WireguardKeys (Resource)

    Creating key sets for WireGuard tunnels.

    Create WireguardKeys Resource

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

    Constructor syntax

    new WireguardKeys(name: string, args?: WireguardKeysArgs, opts?: CustomResourceOptions);
    @overload
    def WireguardKeys(resource_name: str,
                      args: Optional[WireguardKeysArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def WireguardKeys(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      ___id_: Optional[float] = None,
                      ___path_: Optional[str] = None,
                      number: Optional[float] = None,
                      wireguard_keys_id: Optional[str] = None)
    func NewWireguardKeys(ctx *Context, name string, args *WireguardKeysArgs, opts ...ResourceOption) (*WireguardKeys, error)
    public WireguardKeys(string name, WireguardKeysArgs? args = null, CustomResourceOptions? opts = null)
    public WireguardKeys(String name, WireguardKeysArgs args)
    public WireguardKeys(String name, WireguardKeysArgs args, CustomResourceOptions options)
    
    type: routeros:WireguardKeys
    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 WireguardKeysArgs
    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 WireguardKeysArgs
    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 WireguardKeysArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WireguardKeysArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WireguardKeysArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Number double
    The number of key sets.
    WireguardKeysId string
    The ID of this resource.
    ___id_ double
    ___path_ string
    Number float64
    The number of key sets.
    WireguardKeysId string
    The ID of this resource.
    ___id_ float64
    ___path_ string
    ___id_ Double
    ___path_ String
    number Double
    The number of key sets.
    wireguardKeysId String
    The ID of this resource.
    ___id_ number
    ___path_ string
    number number
    The number of key sets.
    wireguardKeysId string
    The ID of this resource.
    ___id_ float
    ___path_ str
    number float
    The number of key sets.
    wireguard_keys_id str
    The ID of this resource.
    ___id_ Number
    ___path_ String
    number Number
    The number of key sets.
    wireguardKeysId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WireguardKeys resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Keys List<WireguardKeysKey>
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys []WireguardKeysKey
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<WireguardKeysKey>
    id string
    The provider-assigned unique ID for this managed resource.
    keys WireguardKeysKey[]
    id str
    The provider-assigned unique ID for this managed resource.
    keys Sequence[WireguardKeysKey]
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<Property Map>

    Look up Existing WireguardKeys Resource

    Get an existing WireguardKeys 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?: WireguardKeysState, opts?: CustomResourceOptions): WireguardKeys
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            keys: Optional[Sequence[WireguardKeysKeyArgs]] = None,
            number: Optional[float] = None,
            wireguard_keys_id: Optional[str] = None) -> WireguardKeys
    func GetWireguardKeys(ctx *Context, name string, id IDInput, state *WireguardKeysState, opts ...ResourceOption) (*WireguardKeys, error)
    public static WireguardKeys Get(string name, Input<string> id, WireguardKeysState? state, CustomResourceOptions? opts = null)
    public static WireguardKeys get(String name, Output<String> id, WireguardKeysState state, CustomResourceOptions options)
    resources:  _:    type: routeros:WireguardKeys    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:
    Keys List<WireguardKeysKey>
    Number double
    The number of key sets.
    WireguardKeysId string
    The ID of this resource.
    ___id_ double
    ___path_ string
    Keys []WireguardKeysKeyArgs
    Number float64
    The number of key sets.
    WireguardKeysId string
    The ID of this resource.
    ___id_ float64
    ___path_ string
    ___id_ Double
    ___path_ String
    keys List<WireguardKeysKey>
    number Double
    The number of key sets.
    wireguardKeysId String
    The ID of this resource.
    ___id_ number
    ___path_ string
    keys WireguardKeysKey[]
    number number
    The number of key sets.
    wireguardKeysId string
    The ID of this resource.
    ___id_ float
    ___path_ str
    keys Sequence[WireguardKeysKeyArgs]
    number float
    The number of key sets.
    wireguard_keys_id str
    The ID of this resource.
    ___id_ Number
    ___path_ String
    keys List<Property Map>
    number Number
    The number of key sets.
    wireguardKeysId String
    The ID of this resource.

    Supporting Types

    WireguardKeysKey, WireguardKeysKeyArgs

    Preshared string
    Private string
    Public string
    Preshared string
    Private string
    Public string
    preshared String
    private_ String
    public_ String
    preshared string
    private string
    public string
    preshared String
    private String
    public String

    Package Details

    Repository
    routeros terraform-routeros/terraform-provider-routeros
    License
    Notes
    This Pulumi package is based on the routeros Terraform Provider.
    routeros logo
    routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros