1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. Hostname
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.LoadBalancer.Hostname

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    Example Usage

    Create Hostname Resource

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

    Constructor syntax

    new Hostname(name: string, args: HostnameArgs, opts?: CustomResourceOptions);
    @overload
    def Hostname(resource_name: str,
                 args: HostnameArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Hostname(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 hostname: Optional[str] = None,
                 load_balancer_id: Optional[str] = None,
                 name: Optional[str] = None)
    func NewHostname(ctx *Context, name string, args HostnameArgs, opts ...ResourceOption) (*Hostname, error)
    public Hostname(string name, HostnameArgs args, CustomResourceOptions? opts = null)
    public Hostname(String name, HostnameArgs args)
    public Hostname(String name, HostnameArgs args, CustomResourceOptions options)
    
    type: oci:LoadBalancer:Hostname
    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 HostnameArgs
    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 HostnameArgs
    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 HostnameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostnameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostnameArgs
    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 hostnameResource = new Oci.LoadBalancer.Hostname("hostnameResource", new()
    {
        VirtualHostname = "string",
        LoadBalancerId = "string",
        Name = "string",
    });
    
    example, err := LoadBalancer.NewHostname(ctx, "hostnameResource", &LoadBalancer.HostnameArgs{
    	Hostname:       pulumi.String("string"),
    	LoadBalancerId: pulumi.String("string"),
    	Name:           pulumi.String("string"),
    })
    
    var hostnameResource = new Hostname("hostnameResource", HostnameArgs.builder()
        .hostname("string")
        .loadBalancerId("string")
        .name("string")
        .build());
    
    hostname_resource = oci.load_balancer.Hostname("hostnameResource",
        hostname="string",
        load_balancer_id="string",
        name="string")
    
    const hostnameResource = new oci.loadbalancer.Hostname("hostnameResource", {
        hostname: "string",
        loadBalancerId: "string",
        name: "string",
    });
    
    type: oci:LoadBalancer:Hostname
    properties:
        hostname: string
        loadBalancerId: string
        name: string
    

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

    LoadBalancerId string
    The OCID of the load balancer to add the hostname to.
    VirtualHostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    Name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Hostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    LoadBalancerId string
    The OCID of the load balancer to add the hostname to.
    Name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    hostname String
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId String
    The OCID of the load balancer to add the hostname to.
    name String

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    hostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId string
    The OCID of the load balancer to add the hostname to.
    name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    hostname str
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    load_balancer_id str
    The OCID of the load balancer to add the hostname to.
    name str

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    hostname String
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId String
    The OCID of the load balancer to add the hostname to.
    name String

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    id String
    The provider-assigned unique ID for this managed resource.
    state String

    Look up Existing Hostname Resource

    Get an existing Hostname 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?: HostnameState, opts?: CustomResourceOptions): Hostname
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            hostname: Optional[str] = None,
            load_balancer_id: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None) -> Hostname
    func GetHostname(ctx *Context, name string, id IDInput, state *HostnameState, opts ...ResourceOption) (*Hostname, error)
    public static Hostname Get(string name, Input<string> id, HostnameState? state, CustomResourceOptions? opts = null)
    public static Hostname get(String name, Output<String> id, HostnameState 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:
    LoadBalancerId string
    The OCID of the load balancer to add the hostname to.
    Name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    VirtualHostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    Hostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    LoadBalancerId string
    The OCID of the load balancer to add the hostname to.
    Name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    hostname String
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId String
    The OCID of the load balancer to add the hostname to.
    name String

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    hostname string
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId string
    The OCID of the load balancer to add the hostname to.
    name string

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state string
    hostname str
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    load_balancer_id str
    The OCID of the load balancer to add the hostname to.
    name str

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state str
    hostname String
    (Updatable) A virtual hostname. For more information about virtual hostname string construction, see Managing Request Routing. Example: app.example.com
    loadBalancerId String
    The OCID of the load balancer to add the hostname to.
    name String

    A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_hostname_001

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String

    Import

    Hostnames can be imported using the id, e.g.

    $ pulumi import oci:LoadBalancer/hostname:Hostname test_hostname "loadBalancers/{loadBalancerId}/hostnames/{name}"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi