1. Packages
  2. Heroku
  3. API Docs
  4. app
  5. App
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

heroku.app.App

Explore with Pulumi AI

heroku logo
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

    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: AppArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def App(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            region: Optional[str] = None,
            acm: Optional[bool] = None,
            buildpacks: Optional[Sequence[str]] = None,
            config_vars: Optional[Mapping[str, Any]] = None,
            internal_routing: Optional[bool] = None,
            name: Optional[str] = None,
            organization: Optional[AppOrganizationArgs] = None,
            sensitive_config_vars: Optional[Mapping[str, str]] = None,
            space: Optional[str] = None,
            stack: Optional[str] = None)
    func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs args, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    type: heroku:app:App
    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 AppArgs
    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 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 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 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 String
    The unique name of the resource.
    args AppArgs
    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 appResource = new Heroku.App.App("appResource", new()
    {
        Region = "string",
        Acm = false,
        Buildpacks = new[]
        {
            "string",
        },
        ConfigVars = 
        {
            { "string", "any" },
        },
        InternalRouting = false,
        Name = "string",
        Organization = new Heroku.App.Inputs.AppOrganizationArgs
        {
            Name = "string",
            Locked = false,
            Personal = false,
        },
        SensitiveConfigVars = 
        {
            { "string", "string" },
        },
        Space = "string",
        Stack = "string",
    });
    
    example, err := app.NewApp(ctx, "appResource", &app.AppArgs{
    	Region: pulumi.String("string"),
    	Acm:    pulumi.Bool(false),
    	Buildpacks: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ConfigVars: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	InternalRouting: pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    	Organization: &app.AppOrganizationArgs{
    		Name:     pulumi.String("string"),
    		Locked:   pulumi.Bool(false),
    		Personal: pulumi.Bool(false),
    	},
    	SensitiveConfigVars: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Space: pulumi.String("string"),
    	Stack: pulumi.String("string"),
    })
    
    var appResource = new App("appResource", AppArgs.builder()
        .region("string")
        .acm(false)
        .buildpacks("string")
        .configVars(Map.of("string", "any"))
        .internalRouting(false)
        .name("string")
        .organization(AppOrganizationArgs.builder()
            .name("string")
            .locked(false)
            .personal(false)
            .build())
        .sensitiveConfigVars(Map.of("string", "string"))
        .space("string")
        .stack("string")
        .build());
    
    app_resource = heroku.app.App("appResource",
        region="string",
        acm=False,
        buildpacks=["string"],
        config_vars={
            "string": "any",
        },
        internal_routing=False,
        name="string",
        organization=heroku.app.AppOrganizationArgs(
            name="string",
            locked=False,
            personal=False,
        ),
        sensitive_config_vars={
            "string": "string",
        },
        space="string",
        stack="string")
    
    const appResource = new heroku.app.App("appResource", {
        region: "string",
        acm: false,
        buildpacks: ["string"],
        configVars: {
            string: "any",
        },
        internalRouting: false,
        name: "string",
        organization: {
            name: "string",
            locked: false,
            personal: false,
        },
        sensitiveConfigVars: {
            string: "string",
        },
        space: "string",
        stack: "string",
    });
    
    type: heroku:app:App
    properties:
        acm: false
        buildpacks:
            - string
        configVars:
            string: any
        internalRouting: false
        name: string
        organization:
            locked: false
            name: string
            personal: false
        region: string
        sensitiveConfigVars:
            string: string
        space: string
        stack: string
    

    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

    The App resource accepts the following input properties:

    Region string
    Acm bool
    Buildpacks List<string>
    ConfigVars Dictionary<string, object>
    InternalRouting bool
    Name string
    Organization Pulumiverse.Heroku.App.Inputs.AppOrganization
    SensitiveConfigVars Dictionary<string, string>
    Space string
    Stack string
    Region string
    Acm bool
    Buildpacks []string
    ConfigVars map[string]interface{}
    InternalRouting bool
    Name string
    Organization AppOrganizationArgs
    SensitiveConfigVars map[string]string
    Space string
    Stack string
    region String
    acm Boolean
    buildpacks List<String>
    configVars Map<String,Object>
    internalRouting Boolean
    name String
    organization AppOrganization
    sensitiveConfigVars Map<String,String>
    space String
    stack String
    region string
    acm boolean
    buildpacks string[]
    configVars {[key: string]: any}
    internalRouting boolean
    name string
    organization AppOrganization
    sensitiveConfigVars {[key: string]: string}
    space string
    stack string
    region str
    acm bool
    buildpacks Sequence[str]
    config_vars Mapping[str, Any]
    internal_routing bool
    name str
    organization AppOrganizationArgs
    sensitive_config_vars Mapping[str, str]
    space str
    stack str
    region String
    acm Boolean
    buildpacks List<String>
    configVars Map<Any>
    internalRouting Boolean
    name String
    organization Property Map
    sensitiveConfigVars Map<String>
    space String
    stack String

    Outputs

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

    AllConfigVars Dictionary<string, object>
    GitUrl string
    HerokuHostname string
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    WebUrl string
    AllConfigVars map[string]interface{}
    GitUrl string
    HerokuHostname string
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    WebUrl string
    allConfigVars Map<String,Object>
    gitUrl String
    herokuHostname String
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    webUrl String
    allConfigVars {[key: string]: any}
    gitUrl string
    herokuHostname string
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    webUrl string
    all_config_vars Mapping[str, Any]
    git_url str
    heroku_hostname str
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    web_url str
    allConfigVars Map<Any>
    gitUrl String
    herokuHostname String
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    webUrl String

    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,
            acm: Optional[bool] = None,
            all_config_vars: Optional[Mapping[str, Any]] = None,
            buildpacks: Optional[Sequence[str]] = None,
            config_vars: Optional[Mapping[str, Any]] = None,
            git_url: Optional[str] = None,
            heroku_hostname: Optional[str] = None,
            internal_routing: Optional[bool] = None,
            name: Optional[str] = None,
            organization: Optional[AppOrganizationArgs] = None,
            region: Optional[str] = None,
            sensitive_config_vars: Optional[Mapping[str, str]] = None,
            space: Optional[str] = None,
            stack: Optional[str] = None,
            uuid: Optional[str] = None,
            web_url: 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)
    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:
    Acm bool
    AllConfigVars Dictionary<string, object>
    Buildpacks List<string>
    ConfigVars Dictionary<string, object>
    GitUrl string
    HerokuHostname string
    InternalRouting bool
    Name string
    Organization Pulumiverse.Heroku.App.Inputs.AppOrganization
    Region string
    SensitiveConfigVars Dictionary<string, string>
    Space string
    Stack string
    Uuid string
    WebUrl string
    Acm bool
    AllConfigVars map[string]interface{}
    Buildpacks []string
    ConfigVars map[string]interface{}
    GitUrl string
    HerokuHostname string
    InternalRouting bool
    Name string
    Organization AppOrganizationArgs
    Region string
    SensitiveConfigVars map[string]string
    Space string
    Stack string
    Uuid string
    WebUrl string
    acm Boolean
    allConfigVars Map<String,Object>
    buildpacks List<String>
    configVars Map<String,Object>
    gitUrl String
    herokuHostname String
    internalRouting Boolean
    name String
    organization AppOrganization
    region String
    sensitiveConfigVars Map<String,String>
    space String
    stack String
    uuid String
    webUrl String
    acm boolean
    allConfigVars {[key: string]: any}
    buildpacks string[]
    configVars {[key: string]: any}
    gitUrl string
    herokuHostname string
    internalRouting boolean
    name string
    organization AppOrganization
    region string
    sensitiveConfigVars {[key: string]: string}
    space string
    stack string
    uuid string
    webUrl string
    acm bool
    all_config_vars Mapping[str, Any]
    buildpacks Sequence[str]
    config_vars Mapping[str, Any]
    git_url str
    heroku_hostname str
    internal_routing bool
    name str
    organization AppOrganizationArgs
    region str
    sensitive_config_vars Mapping[str, str]
    space str
    stack str
    uuid str
    web_url str
    acm Boolean
    allConfigVars Map<Any>
    buildpacks List<String>
    configVars Map<Any>
    gitUrl String
    herokuHostname String
    internalRouting Boolean
    name String
    organization Property Map
    region String
    sensitiveConfigVars Map<String>
    space String
    stack String
    uuid String
    webUrl String

    Supporting Types

    AppOrganization, AppOrganizationArgs

    Name string
    Locked bool
    Personal bool
    Name string
    Locked bool
    Personal bool
    name String
    locked Boolean
    personal Boolean
    name string
    locked boolean
    personal boolean
    name str
    locked bool
    personal bool
    name String
    locked Boolean
    personal Boolean

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns