Docs Packages
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. Gateway
OVHCloud v0.43.1 published on Tuesday, Apr 23, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.Gateway

Explore with Pulumi AI

ovh logo
OVHCloud v0.43.1 published on Tuesday, Apr 23, 2024 by OVHcloud
ovh/pulumi-ovh

    Create a new Gateway for existing subnet in the specified public cloud project.

    Create Gateway Resource

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

    Constructor syntax

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

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            model: Optional[str] = None,
            network_id: Optional[str] = None,
            region: Optional[str] = None,
            service_name: Optional[str] = None,
            subnet_id: Optional[str] = None,
            name: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: ovh:CloudProject:Gateway
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 GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    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 gatewayResource = new Ovh.CloudProject.Gateway("gatewayResource", new()
{
    Model = "string",
    NetworkId = "string",
    Region = "string",
    ServiceName = "string",
    SubnetId = "string",
    Name = "string",
});

    example, err := CloudProject.NewGateway(ctx, "gatewayResource", &CloudProject.GatewayArgs{
	Model:       pulumi.String("string"),
	NetworkId:   pulumi.String("string"),
	Region:      pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	SubnetId:    pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()        
    .model("string")
    .networkId("string")
    .region("string")
    .serviceName("string")
    .subnetId("string")
    .name("string")
    .build());

    gateway_resource = ovh.cloud_project.Gateway("gatewayResource",
    model="string",
    network_id="string",
    region="string",
    service_name="string",
    subnet_id="string",
    name="string")

    const gatewayResource = new ovh.cloudproject.Gateway("gatewayResource", {
    model: "string",
    networkId: "string",
    region: "string",
    serviceName: "string",
    subnetId: "string",
    name: "string",
});

    type: ovh:CloudProject:Gateway
properties:
    model: string
    name: string
    networkId: string
    region: string
    serviceName: string
    subnetId: string

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

    Model string
    The model of the gateway.
    NetworkId string
    The ID of the private network.
    Region string
    The region of the gateway.
    ServiceName string
    The ID of the private network.
    SubnetId string
    The ID of the subnet.
    Name string
    The name of the gateway.
    Model string
    The model of the gateway.
    NetworkId string
    The ID of the private network.
    Region string
    The region of the gateway.
    ServiceName string
    The ID of the private network.
    SubnetId string
    The ID of the subnet.
    Name string
    The name of the gateway.
    model String
    The model of the gateway.
    networkId String
    The ID of the private network.
    region String
    The region of the gateway.
    serviceName String
    The ID of the private network.
    subnetId String
    The ID of the subnet.
    name String
    The name of the gateway.
    model string
    The model of the gateway.
    networkId string
    The ID of the private network.
    region string
    The region of the gateway.
    serviceName string
    The ID of the private network.
    subnetId string
    The ID of the subnet.
    name string
    The name of the gateway.
    model str
    The model of the gateway.
    network_id str
    The ID of the private network.
    region str
    The region of the gateway.
    service_name str
    The ID of the private network.
    subnet_id str
    The ID of the subnet.
    name str
    The name of the gateway.
    model String
    The model of the gateway.
    networkId String
    The ID of the private network.
    region String
    The region of the gateway.
    serviceName String
    The ID of the private network.
    subnetId String
    The ID of the subnet.
    name String
    The name of the gateway.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the gateway.

    Look up Existing Gateway Resource

    Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        model: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        region: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState 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:
    Model string
    The model of the gateway.
    Name string
    The name of the gateway.
    NetworkId string
    The ID of the private network.
    Region string
    The region of the gateway.
    ServiceName string
    The ID of the private network.
    Status string
    The status of the gateway.
    SubnetId string
    The ID of the subnet.
    Model string
    The model of the gateway.
    Name string
    The name of the gateway.
    NetworkId string
    The ID of the private network.
    Region string
    The region of the gateway.
    ServiceName string
    The ID of the private network.
    Status string
    The status of the gateway.
    SubnetId string
    The ID of the subnet.
    model String
    The model of the gateway.
    name String
    The name of the gateway.
    networkId String
    The ID of the private network.
    region String
    The region of the gateway.
    serviceName String
    The ID of the private network.
    status String
    The status of the gateway.
    subnetId String
    The ID of the subnet.
    model string
    The model of the gateway.
    name string
    The name of the gateway.
    networkId string
    The ID of the private network.
    region string
    The region of the gateway.
    serviceName string
    The ID of the private network.
    status string
    The status of the gateway.
    subnetId string
    The ID of the subnet.
    model str
    The model of the gateway.
    name str
    The name of the gateway.
    network_id str
    The ID of the private network.
    region str
    The region of the gateway.
    service_name str
    The ID of the private network.
    status str
    The status of the gateway.
    subnet_id str
    The ID of the subnet.
    model String
    The model of the gateway.
    name String
    The name of the gateway.
    networkId String
    The ID of the private network.
    region String
    The region of the gateway.
    serviceName String
    The ID of the private network.
    status String
    The status of the gateway.
    subnetId String
    The ID of the subnet.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v0.43.1 published on Tuesday, Apr 23, 2024 by OVHcloud
    ovh/pulumi-ovh