1. Packages
  2. Heroku Provider
  3. API Docs
  4. addon
  5. getAddon
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

heroku.addon.getAddon

Explore with Pulumi AI

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

Use this data source to get information about a Heroku Addon.

Example Usage

# Lookup an existing Heroku add-on
data "heroku_addon" "example" {
  name = "example-addon-name"
}

Using getAddon

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAddon(args: GetAddonArgs, opts?: InvokeOptions): Promise<GetAddonResult>
function getAddonOutput(args: GetAddonOutputArgs, opts?: InvokeOptions): Output<GetAddonResult>
Copy
def get_addon(name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAddonResult
def get_addon_output(name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAddonResult]
Copy
func LookupAddon(ctx *Context, args *LookupAddonArgs, opts ...InvokeOption) (*LookupAddonResult, error)
func LookupAddonOutput(ctx *Context, args *LookupAddonOutputArgs, opts ...InvokeOption) LookupAddonResultOutput
Copy

> Note: This function is named LookupAddon in the Go SDK.

public static class GetAddon 
{
    public static Task<GetAddonResult> InvokeAsync(GetAddonArgs args, InvokeOptions? opts = null)
    public static Output<GetAddonResult> Invoke(GetAddonInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAddonResult> getAddon(GetAddonArgs args, InvokeOptions options)
public static Output<GetAddonResult> getAddon(GetAddonArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: heroku:addon/getAddon:getAddon
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The add-on name
Name This property is required. string
The add-on name
name This property is required. String
The add-on name
name This property is required. string
The add-on name
name This property is required. str
The add-on name
name This property is required. String
The add-on name

getAddon Result

The following output properties are available:

AppId string
Heroku app ID
ConfigVars List<string>
The Configuration variables of the add-on
Id string
The ID of the add-on
Name string
The add-on name
Plan string
The plan name
ProviderId string
The ID of the plan provider
AppId string
Heroku app ID
ConfigVars []string
The Configuration variables of the add-on
Id string
The ID of the add-on
Name string
The add-on name
Plan string
The plan name
ProviderId string
The ID of the plan provider
appId String
Heroku app ID
configVars List<String>
The Configuration variables of the add-on
id String
The ID of the add-on
name String
The add-on name
plan String
The plan name
providerId String
The ID of the plan provider
appId string
Heroku app ID
configVars string[]
The Configuration variables of the add-on
id string
The ID of the add-on
name string
The add-on name
plan string
The plan name
providerId string
The ID of the plan provider
app_id str
Heroku app ID
config_vars Sequence[str]
The Configuration variables of the add-on
id str
The ID of the add-on
name str
The add-on name
plan str
The plan name
provider_id str
The ID of the plan provider
appId String
Heroku app ID
configVars List<String>
The Configuration variables of the add-on
id String
The ID of the add-on
name String
The add-on name
plan String
The plan name
providerId String
The ID of the plan provider

Package Details

Repository
heroku pulumiverse/pulumi-heroku
License
Apache-2.0
Notes
This Pulumi package is based on the heroku Terraform Provider.
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns