1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. DomainRoute
Control Plane v0.0.14 published on Monday, Apr 1, 2024 by pulumiverse

cpln.DomainRoute

Explore with Pulumi AI

cpln logo
Control Plane v0.0.14 published on Monday, Apr 1, 2024 by pulumiverse

    Create DomainRoute Resource

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

    Constructor syntax

    new DomainRoute(name: string, args: DomainRouteArgs, opts?: CustomResourceOptions);
    @overload
    def DomainRoute(resource_name: str,
                    args: DomainRouteArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainRoute(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_link: Optional[str] = None,
                    prefix: Optional[str] = None,
                    workload_link: Optional[str] = None,
                    domain_port: Optional[int] = None,
                    host_prefix: Optional[str] = None,
                    port: Optional[int] = None,
                    replace_prefix: Optional[str] = None)
    func NewDomainRoute(ctx *Context, name string, args DomainRouteArgs, opts ...ResourceOption) (*DomainRoute, error)
    public DomainRoute(string name, DomainRouteArgs args, CustomResourceOptions? opts = null)
    public DomainRoute(String name, DomainRouteArgs args)
    public DomainRoute(String name, DomainRouteArgs args, CustomResourceOptions options)
    
    type: cpln:DomainRoute
    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 DomainRouteArgs
    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 DomainRouteArgs
    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 DomainRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainRouteArgs
    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 domainRouteResource = new Cpln.DomainRoute("domainRouteResource", new()
    {
        DomainLink = "string",
        Prefix = "string",
        WorkloadLink = "string",
        DomainPort = 0,
        HostPrefix = "string",
        Port = 0,
        ReplacePrefix = "string",
    });
    
    example, err := cpln.NewDomainRoute(ctx, "domainRouteResource", &cpln.DomainRouteArgs{
    	DomainLink:    pulumi.String("string"),
    	Prefix:        pulumi.String("string"),
    	WorkloadLink:  pulumi.String("string"),
    	DomainPort:    pulumi.Int(0),
    	HostPrefix:    pulumi.String("string"),
    	Port:          pulumi.Int(0),
    	ReplacePrefix: pulumi.String("string"),
    })
    
    var domainRouteResource = new DomainRoute("domainRouteResource", DomainRouteArgs.builder()        
        .domainLink("string")
        .prefix("string")
        .workloadLink("string")
        .domainPort(0)
        .hostPrefix("string")
        .port(0)
        .replacePrefix("string")
        .build());
    
    domain_route_resource = cpln.DomainRoute("domainRouteResource",
        domain_link="string",
        prefix="string",
        workload_link="string",
        domain_port=0,
        host_prefix="string",
        port=0,
        replace_prefix="string")
    
    const domainRouteResource = new cpln.DomainRoute("domainRouteResource", {
        domainLink: "string",
        prefix: "string",
        workloadLink: "string",
        domainPort: 0,
        hostPrefix: "string",
        port: 0,
        replacePrefix: "string",
    });
    
    type: cpln:DomainRoute
    properties:
        domainLink: string
        domainPort: 0
        hostPrefix: string
        port: 0
        prefix: string
        replacePrefix: string
        workloadLink: string
    

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

    domainLink String
    prefix String
    workloadLink String
    domainPort Integer
    hostPrefix String
    port Integer
    replacePrefix String
    domainLink string
    prefix string
    workloadLink string
    domainPort number
    hostPrefix string
    port number
    replacePrefix string
    domainLink String
    prefix String
    workloadLink String
    domainPort Number
    hostPrefix String
    port Number
    replacePrefix String

    Outputs

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

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

    Look up Existing DomainRoute Resource

    Get an existing DomainRoute 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?: DomainRouteState, opts?: CustomResourceOptions): DomainRoute
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_link: Optional[str] = None,
            domain_port: Optional[int] = None,
            host_prefix: Optional[str] = None,
            port: Optional[int] = None,
            prefix: Optional[str] = None,
            replace_prefix: Optional[str] = None,
            workload_link: Optional[str] = None) -> DomainRoute
    func GetDomainRoute(ctx *Context, name string, id IDInput, state *DomainRouteState, opts ...ResourceOption) (*DomainRoute, error)
    public static DomainRoute Get(string name, Input<string> id, DomainRouteState? state, CustomResourceOptions? opts = null)
    public static DomainRoute get(String name, Output<String> id, DomainRouteState 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:
    domainLink String
    domainPort Integer
    hostPrefix String
    port Integer
    prefix String
    replacePrefix String
    workloadLink String
    domainLink string
    domainPort number
    hostPrefix string
    port number
    prefix string
    replacePrefix string
    workloadLink string
    domainLink String
    domainPort Number
    hostPrefix String
    port Number
    prefix String
    replacePrefix String
    workloadLink String

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.14 published on Monday, Apr 1, 2024 by pulumiverse