1. Packages
  2. Gandi
  3. API Docs
  4. simplehosting
  5. VHost
Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse

gandi.simplehosting.VHost

Explore with Pulumi AI

Create VHost Resource

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

Constructor syntax

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

@overload
def VHost(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          fqdn: Optional[str] = None,
          instance_id: Optional[str] = None,
          application: Optional[str] = None,
          linked_dns_zone_alteration: Optional[bool] = None)
func NewVHost(ctx *Context, name string, args VHostArgs, opts ...ResourceOption) (*VHost, error)
public VHost(string name, VHostArgs args, CustomResourceOptions? opts = null)
public VHost(String name, VHostArgs args)
public VHost(String name, VHostArgs args, CustomResourceOptions options)
type: gandi:simplehosting:VHost
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VHostArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VHostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VHostArgs
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 vhostResource = new Gandi.Simplehosting.VHost("vhostResource", new()
{
    Fqdn = "string",
    InstanceId = "string",
    Application = "string",
    LinkedDnsZoneAlteration = false,
});
Copy
example, err := simplehosting.NewVHost(ctx, "vhostResource", &simplehosting.VHostArgs{
	Fqdn:                    pulumi.String("string"),
	InstanceId:              pulumi.String("string"),
	Application:             pulumi.String("string"),
	LinkedDnsZoneAlteration: pulumi.Bool(false),
})
Copy
var vhostResource = new VHost("vhostResource", VHostArgs.builder()
    .fqdn("string")
    .instanceId("string")
    .application("string")
    .linkedDnsZoneAlteration(false)
    .build());
Copy
vhost_resource = gandi.simplehosting.VHost("vhostResource",
    fqdn="string",
    instance_id="string",
    application="string",
    linked_dns_zone_alteration=False)
Copy
const vhostResource = new gandi.simplehosting.VHost("vhostResource", {
    fqdn: "string",
    instanceId: "string",
    application: "string",
    linkedDnsZoneAlteration: false,
});
Copy
type: gandi:simplehosting:VHost
properties:
    application: string
    fqdn: string
    instanceId: string
    linkedDnsZoneAlteration: false
Copy

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

Fqdn
This property is required.
Changes to this property will trigger replacement.
string
The FQDN of the Vhost
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SimpleHosting instance
Application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
LinkedDnsZoneAlteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
Fqdn
This property is required.
Changes to this property will trigger replacement.
string
The FQDN of the Vhost
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SimpleHosting instance
Application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
LinkedDnsZoneAlteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
fqdn
This property is required.
Changes to this property will trigger replacement.
String
The FQDN of the Vhost
instanceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SimpleHosting instance
application Changes to this property will trigger replacement. String
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
linkedDnsZoneAlteration Changes to this property will trigger replacement. Boolean
Whether to alter the linked DNS Zone
fqdn
This property is required.
Changes to this property will trigger replacement.
string
The FQDN of the Vhost
instanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SimpleHosting instance
application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
linkedDnsZoneAlteration Changes to this property will trigger replacement. boolean
Whether to alter the linked DNS Zone
fqdn
This property is required.
Changes to this property will trigger replacement.
str
The FQDN of the Vhost
instance_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the SimpleHosting instance
application Changes to this property will trigger replacement. str
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
linked_dns_zone_alteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
fqdn
This property is required.
Changes to this property will trigger replacement.
String
The FQDN of the Vhost
instanceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SimpleHosting instance
application Changes to this property will trigger replacement. String
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
linkedDnsZoneAlteration Changes to this property will trigger replacement. Boolean
Whether to alter the linked DNS Zone

Outputs

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

CertificateId string
The ID of the created free certificate
Id string
The provider-assigned unique ID for this managed resource.
CertificateId string
The ID of the created free certificate
Id string
The provider-assigned unique ID for this managed resource.
certificateId String
The ID of the created free certificate
id String
The provider-assigned unique ID for this managed resource.
certificateId string
The ID of the created free certificate
id string
The provider-assigned unique ID for this managed resource.
certificate_id str
The ID of the created free certificate
id str
The provider-assigned unique ID for this managed resource.
certificateId String
The ID of the created free certificate
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VHost Resource

Get an existing VHost 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?: VHostState, opts?: CustomResourceOptions): VHost
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application: Optional[str] = None,
        certificate_id: Optional[str] = None,
        fqdn: Optional[str] = None,
        instance_id: Optional[str] = None,
        linked_dns_zone_alteration: Optional[bool] = None) -> VHost
func GetVHost(ctx *Context, name string, id IDInput, state *VHostState, opts ...ResourceOption) (*VHost, error)
public static VHost Get(string name, Input<string> id, VHostState? state, CustomResourceOptions? opts = null)
public static VHost get(String name, Output<String> id, VHostState state, CustomResourceOptions options)
resources:  _:    type: gandi:simplehosting:VHost    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
CertificateId string
The ID of the created free certificate
Fqdn Changes to this property will trigger replacement. string
The FQDN of the Vhost
InstanceId Changes to this property will trigger replacement. string
The ID of the SimpleHosting instance
LinkedDnsZoneAlteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
Application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
CertificateId string
The ID of the created free certificate
Fqdn Changes to this property will trigger replacement. string
The FQDN of the Vhost
InstanceId Changes to this property will trigger replacement. string
The ID of the SimpleHosting instance
LinkedDnsZoneAlteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
application Changes to this property will trigger replacement. String
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
certificateId String
The ID of the created free certificate
fqdn Changes to this property will trigger replacement. String
The FQDN of the Vhost
instanceId Changes to this property will trigger replacement. String
The ID of the SimpleHosting instance
linkedDnsZoneAlteration Changes to this property will trigger replacement. Boolean
Whether to alter the linked DNS Zone
application Changes to this property will trigger replacement. string
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
certificateId string
The ID of the created free certificate
fqdn Changes to this property will trigger replacement. string
The FQDN of the Vhost
instanceId Changes to this property will trigger replacement. string
The ID of the SimpleHosting instance
linkedDnsZoneAlteration Changes to this property will trigger replacement. boolean
Whether to alter the linked DNS Zone
application Changes to this property will trigger replacement. str
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
certificate_id str
The ID of the created free certificate
fqdn Changes to this property will trigger replacement. str
The FQDN of the Vhost
instance_id Changes to this property will trigger replacement. str
The ID of the SimpleHosting instance
linked_dns_zone_alteration Changes to this property will trigger replacement. bool
Whether to alter the linked DNS Zone
application Changes to this property will trigger replacement. String
The name of an application to install ('grav', 'matomo', 'nextcloud', 'prestashop', 'wordpress')
certificateId String
The ID of the created free certificate
fqdn Changes to this property will trigger replacement. String
The FQDN of the Vhost
instanceId Changes to this property will trigger replacement. String
The ID of the SimpleHosting instance
linkedDnsZoneAlteration Changes to this property will trigger replacement. Boolean
Whether to alter the linked DNS Zone

Package Details

Repository
gandi pulumiverse/pulumi-gandi
License
Apache-2.0
Notes
This Pulumi package is based on the gandi Terraform Provider.