1. Packages
  2. Koyeb
  3. API Docs
  4. App
Koyeb v0.1.11 published on Monday, Dec 9, 2024 by Koyeb

koyeb.App

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as koyeb from "@koyeb/pulumi-koyeb";

const my_app = new koyeb.App("my-app", {name: "my-app"});
Copy
import pulumi
import pulumi_koyeb as koyeb

my_app = koyeb.App("my-app", name="my-app")
Copy
package main

import (
	"github.com/koyeb/pulumi-koyeb/sdk/go/koyeb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := koyeb.NewApp(ctx, "my-app", &koyeb.AppArgs{
			Name: pulumi.String("my-app"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Koyeb = Pulumi.Koyeb;

return await Deployment.RunAsync(() => 
{
    var my_app = new Koyeb.App("my-app", new()
    {
        Name = "my-app",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.koyeb.App;
import com.pulumi.koyeb.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_app = new App("my-app", AppArgs.builder()
            .name("my-app")
            .build());

    }
}
Copy
resources:
  my-app:
    type: koyeb:App
    properties:
      name: my-app
Copy

Create App Resource

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

Constructor syntax

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

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None)
func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)
type: koyeb:App
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 AppArgs
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 AppArgs
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 AppArgs
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 AppArgs
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. AppArgs
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 appResource = new Koyeb.App("appResource", new()
{
    Name = "string",
});
Copy
example, err := koyeb.NewApp(ctx, "appResource", &koyeb.AppArgs{
	Name: pulumi.String("string"),
})
Copy
var appResource = new App("appResource", AppArgs.builder()
    .name("string")
    .build());
Copy
app_resource = koyeb.App("appResource", name="string")
Copy
const appResource = new koyeb.App("appResource", {name: "string"});
Copy
type: koyeb:App
properties:
    name: string
Copy

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

Name Changes to this property will trigger replacement. string
The app name
Name Changes to this property will trigger replacement. string
The app name
name Changes to this property will trigger replacement. String
The app name
name Changes to this property will trigger replacement. string
The app name
name Changes to this property will trigger replacement. str
The app name
name Changes to this property will trigger replacement. String
The app name

Outputs

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

CreatedAt string
The date and time of when the app was created
Domains List<AppDomain>
The app domains
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The organization ID owning the app
UpdatedAt string
The date and time of when the app was last updated
CreatedAt string
The date and time of when the app was created
Domains []AppDomain
The app domains
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The organization ID owning the app
UpdatedAt string
The date and time of when the app was last updated
createdAt String
The date and time of when the app was created
domains List<AppDomain>
The app domains
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The organization ID owning the app
updatedAt String
The date and time of when the app was last updated
createdAt string
The date and time of when the app was created
domains AppDomain[]
The app domains
id string
The provider-assigned unique ID for this managed resource.
organizationId string
The organization ID owning the app
updatedAt string
The date and time of when the app was last updated
created_at str
The date and time of when the app was created
domains Sequence[AppDomain]
The app domains
id str
The provider-assigned unique ID for this managed resource.
organization_id str
The organization ID owning the app
updated_at str
The date and time of when the app was last updated
createdAt String
The date and time of when the app was created
domains List<Property Map>
The app domains
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The organization ID owning the app
updatedAt String
The date and time of when the app was last updated

Look up Existing App Resource

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        domains: Optional[Sequence[AppDomainArgs]] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        updated_at: Optional[str] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
resources:  _:    type: koyeb:App    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:
CreatedAt string
The date and time of when the app was created
Domains List<AppDomain>
The app domains
Name Changes to this property will trigger replacement. string
The app name
OrganizationId string
The organization ID owning the app
UpdatedAt string
The date and time of when the app was last updated
CreatedAt string
The date and time of when the app was created
Domains []AppDomainArgs
The app domains
Name Changes to this property will trigger replacement. string
The app name
OrganizationId string
The organization ID owning the app
UpdatedAt string
The date and time of when the app was last updated
createdAt String
The date and time of when the app was created
domains List<AppDomain>
The app domains
name Changes to this property will trigger replacement. String
The app name
organizationId String
The organization ID owning the app
updatedAt String
The date and time of when the app was last updated
createdAt string
The date and time of when the app was created
domains AppDomain[]
The app domains
name Changes to this property will trigger replacement. string
The app name
organizationId string
The organization ID owning the app
updatedAt string
The date and time of when the app was last updated
created_at str
The date and time of when the app was created
domains Sequence[AppDomainArgs]
The app domains
name Changes to this property will trigger replacement. str
The app name
organization_id str
The organization ID owning the app
updated_at str
The date and time of when the app was last updated
createdAt String
The date and time of when the app was created
domains List<Property Map>
The app domains
name Changes to this property will trigger replacement. String
The app name
organizationId String
The organization ID owning the app
updatedAt String
The date and time of when the app was last updated

Supporting Types

AppDomain
, AppDomainArgs

Name
This property is required.
Changes to this property will trigger replacement.
string
The domain name
AppName string
The app name the domain is assigned to
CreatedAt string
The date and time of when the domain was created
DeploymentGroup string
The deployment group assigned to the domain
Id string
The domain ID
IntendedCname string
The CNAME record to point the domain to
Messages string
The status messages of the domain
OrganizationId string
The organization ID owning the domain
Status string
The status of the domain
Type string
The domain type
UpdatedAt string
The date and time of when the domain was last updated
VerifiedAt string
The date and time of when the domain was last verified
Version string
The version of the domain
Name
This property is required.
Changes to this property will trigger replacement.
string
The domain name
AppName string
The app name the domain is assigned to
CreatedAt string
The date and time of when the domain was created
DeploymentGroup string
The deployment group assigned to the domain
Id string
The domain ID
IntendedCname string
The CNAME record to point the domain to
Messages string
The status messages of the domain
OrganizationId string
The organization ID owning the domain
Status string
The status of the domain
Type string
The domain type
UpdatedAt string
The date and time of when the domain was last updated
VerifiedAt string
The date and time of when the domain was last verified
Version string
The version of the domain
name
This property is required.
Changes to this property will trigger replacement.
String
The domain name
appName String
The app name the domain is assigned to
createdAt String
The date and time of when the domain was created
deploymentGroup String
The deployment group assigned to the domain
id String
The domain ID
intendedCname String
The CNAME record to point the domain to
messages String
The status messages of the domain
organizationId String
The organization ID owning the domain
status String
The status of the domain
type String
The domain type
updatedAt String
The date and time of when the domain was last updated
verifiedAt String
The date and time of when the domain was last verified
version String
The version of the domain
name
This property is required.
Changes to this property will trigger replacement.
string
The domain name
appName string
The app name the domain is assigned to
createdAt string
The date and time of when the domain was created
deploymentGroup string
The deployment group assigned to the domain
id string
The domain ID
intendedCname string
The CNAME record to point the domain to
messages string
The status messages of the domain
organizationId string
The organization ID owning the domain
status string
The status of the domain
type string
The domain type
updatedAt string
The date and time of when the domain was last updated
verifiedAt string
The date and time of when the domain was last verified
version string
The version of the domain
name
This property is required.
Changes to this property will trigger replacement.
str
The domain name
app_name str
The app name the domain is assigned to
created_at str
The date and time of when the domain was created
deployment_group str
The deployment group assigned to the domain
id str
The domain ID
intended_cname str
The CNAME record to point the domain to
messages str
The status messages of the domain
organization_id str
The organization ID owning the domain
status str
The status of the domain
type str
The domain type
updated_at str
The date and time of when the domain was last updated
verified_at str
The date and time of when the domain was last verified
version str
The version of the domain
name
This property is required.
Changes to this property will trigger replacement.
String
The domain name
appName String
The app name the domain is assigned to
createdAt String
The date and time of when the domain was created
deploymentGroup String
The deployment group assigned to the domain
id String
The domain ID
intendedCname String
The CNAME record to point the domain to
messages String
The status messages of the domain
organizationId String
The organization ID owning the domain
status String
The status of the domain
type String
The domain type
updatedAt String
The date and time of when the domain was last updated
verifiedAt String
The date and time of when the domain was last verified
version String
The version of the domain

Package Details

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