Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. threefold
  3. API Docs
  4. GatewayName
Threefold Grid v0.8.1 published on Wednesday, Nov 6, 2024 by Threefold
threefoldtech/pulumi-threefold

threefold.GatewayName

Explore with Pulumi AI

threefold logo
Threefold Grid v0.8.1 published on Wednesday, Nov 6, 2024 by Threefold
threefoldtech/pulumi-threefold

    Create GatewayName Resource

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

    Constructor syntax

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

@overload
def GatewayName(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                backends: Optional[Sequence[str]] = None,
                name: Optional[str] = None,
                node_id: Optional[Any] = None,
                description: Optional[str] = None,
                network_name: Optional[str] = None,
                solution_type: Optional[str] = None,
                tls_passthrough: Optional[bool] = None)
    func NewGatewayName(ctx *Context, name string, args GatewayNameArgs, opts ...ResourceOption) (*GatewayName, error)
    public GatewayName(string name, GatewayNameArgs args, CustomResourceOptions? opts = null)
    public GatewayName(String name, GatewayNameArgs args)
public GatewayName(String name, GatewayNameArgs args, CustomResourceOptions options)

    type: threefold:GatewayName
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 GatewayNameArgs
    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 GatewayNameArgs
    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 GatewayNameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayNameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayNameArgs
    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 gatewayNameResource = new Threefold.GatewayName("gatewayNameResource", new()
{
    Backends = new[]
    {
        "string",
    },
    Name = "string",
    Node_id = "any",
    Description = "string",
    Network_name = "string",
    Solution_type = "string",
    Tls_passthrough = false,
});

    example, err := threefold.NewGatewayName(ctx, "gatewayNameResource", &threefold.GatewayNameArgs{
	Backends: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	Node_id:         pulumi.Any("any"),
	Description:     pulumi.String("string"),
	Network_name:    pulumi.String("string"),
	Solution_type:   pulumi.String("string"),
	Tls_passthrough: pulumi.Bool(false),
})

    var gatewayNameResource = new GatewayName("gatewayNameResource", GatewayNameArgs.builder()
    .backends("string")
    .name("string")
    .node_id("any")
    .description("string")
    .network_name("string")
    .solution_type("string")
    .tls_passthrough(false)
    .build());

    gateway_name_resource = threefold.GatewayName("gatewayNameResource",
    backends=["string"],
    name="string",
    node_id="any",
    description="string",
    network_name="string",
    solution_type="string",
    tls_passthrough=False)

    const gatewayNameResource = new threefold.GatewayName("gatewayNameResource", {
    backends: ["string"],
    name: "string",
    node_id: "any",
    description: "string",
    network_name: "string",
    solution_type: "string",
    tls_passthrough: false,
});

    type: threefold:GatewayName
properties:
    backends:
        - string
    description: string
    name: string
    network_name: string
    node_id: any
    solution_type: string
    tls_passthrough: false

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

    Backends List<string>
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    Name string
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    Node_id object
    The gateway's node ID
    Description string
    The description of the virtual machine workload, optional with no restrictions
    Network_name string
    Network name to join, if backend IP is private
    Solution_type string
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    Tls_passthrough bool
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service
    Backends []string
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    Name string
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    Node_id interface{}
    The gateway's node ID
    Description string
    The description of the virtual machine workload, optional with no restrictions
    Network_name string
    Network name to join, if backend IP is private
    Solution_type string
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    Tls_passthrough bool
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service
    backends List<String>
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    name String
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    node_id Object
    The gateway's node ID
    description String
    The description of the virtual machine workload, optional with no restrictions
    network_name String
    Network name to join, if backend IP is private
    solution_type String
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    tls_passthrough Boolean
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service
    backends string[]
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    name string
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    node_id any
    The gateway's node ID
    description string
    The description of the virtual machine workload, optional with no restrictions
    network_name string
    Network name to join, if backend IP is private
    solution_type string
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    tls_passthrough boolean
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service
    backends Sequence[str]
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    name str
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    node_id Any
    The gateway's node ID
    description str
    The description of the virtual machine workload, optional with no restrictions
    network_name str
    Network name to join, if backend IP is private
    solution_type str
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    tls_passthrough bool
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service
    backends List<String>
    The backends of the gateway proxy. must be in the format ip:port if tls_passthrough is set, otherwise the format should be http://ip[:port]
    name String
    Domain prefix. The fqdn will be .. This has to be unique within the deployment. It's required and cannot exceed 50 characters. Must contain only alphanumeric and underscore characters
    node_id Any
    The gateway's node ID
    description String
    The description of the virtual machine workload, optional with no restrictions
    network_name String
    Network name to join, if backend IP is private
    solution_type String
    The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
    tls_passthrough Boolean
    TLS passthrough controls the TLS termination, if false, the gateway will terminate the TLS, if True, it will only be terminated by the backend service

    Outputs

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

    Contract_id int
    The deployment ID
    Fqdn string
    The computed fully qualified domain name of the deployed workload
    Id string
    The provider-assigned unique ID for this managed resource.
    Name_contract_id int
    The reserved name contract ID
    Node_deployment_id Dictionary<string, int>
    Mapping from each node to its deployment ID
    Contract_id int
    The deployment ID
    Fqdn string
    The computed fully qualified domain name of the deployed workload
    Id string
    The provider-assigned unique ID for this managed resource.
    Name_contract_id int
    The reserved name contract ID
    Node_deployment_id map[string]int
    Mapping from each node to its deployment ID
    contract_id Integer
    The deployment ID
    fqdn String
    The computed fully qualified domain name of the deployed workload
    id String
    The provider-assigned unique ID for this managed resource.
    name_contract_id Integer
    The reserved name contract ID
    node_deployment_id Map<String,Integer>
    Mapping from each node to its deployment ID
    contract_id number
    The deployment ID
    fqdn string
    The computed fully qualified domain name of the deployed workload
    id string
    The provider-assigned unique ID for this managed resource.
    name_contract_id number
    The reserved name contract ID
    node_deployment_id {[key: string]: number}
    Mapping from each node to its deployment ID
    contract_id int
    The deployment ID
    fqdn str
    The computed fully qualified domain name of the deployed workload
    id str
    The provider-assigned unique ID for this managed resource.
    name_contract_id int
    The reserved name contract ID
    node_deployment_id Mapping[str, int]
    Mapping from each node to its deployment ID
    contract_id Number
    The deployment ID
    fqdn String
    The computed fully qualified domain name of the deployed workload
    id String
    The provider-assigned unique ID for this managed resource.
    name_contract_id Number
    The reserved name contract ID
    node_deployment_id Map<Number>
    Mapping from each node to its deployment ID

    Package Details

    Repository
    threefold threefoldtech/pulumi-threefold
    License
    Apache-2.0
    threefold logo
    Threefold Grid v0.8.1 published on Wednesday, Nov 6, 2024 by Threefold
    threefoldtech/pulumi-threefold