Heroku v1.0.2, Dec 5 22

heroku.addon.Addon

Create Addon Resource

new Addon(name: string, args: AddonArgs, opts?: CustomResourceOptions);

@overload
def Addon(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          app_id: Optional[str] = None,
          config: Optional[Mapping[str, Any]] = None,
          name: Optional[str] = None,
          plan: Optional[str] = None)
@overload
def Addon(resource_name: str,
          args: AddonArgs,
          opts: Optional[ResourceOptions] = None)

func NewAddon(ctx *Context, name string, args AddonArgs, opts ...ResourceOption) (*Addon, error)

public Addon(string name, AddonArgs args, CustomResourceOptions? opts = null)

public Addon(String name, AddonArgs args)
public Addon(String name, AddonArgs args, CustomResourceOptions options)

type: heroku:addon:Addon
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AddonArgs: 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 AddonArgs: 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 AddonArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AddonArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AddonArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

AppId string
Plan string
Config Dictionary<string, object>
Name string

AppId string
Plan string
Config map[string]interface{}
Name string

appId String
plan String
config Map<String,Object>
name String

appId string
plan string
config {[key: string]: any}
name string

app_id str
plan str
config Mapping[str, Any]
name str

appId String
plan String
config Map<Any>
name String

Outputs

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

ConfigVarValues Dictionary<string, string>
ConfigVars List<string>
Id string: The provider-assigned unique ID for this managed resource.
ProviderId string

ConfigVarValues map[string]string
ConfigVars []string
Id string: The provider-assigned unique ID for this managed resource.
ProviderId string

configVarValues Map<String,String>
configVars List<String>
id String: The provider-assigned unique ID for this managed resource.
providerId String

configVarValues {[key: string]: string}
configVars string[]
id string: The provider-assigned unique ID for this managed resource.
providerId string

config_var_values Mapping[str, str]
config_vars Sequence[str]
id str: The provider-assigned unique ID for this managed resource.
provider_id str

configVarValues Map<String>
configVars List<String>
id String: The provider-assigned unique ID for this managed resource.
providerId String

Look up Existing Addon Resource

Get an existing Addon 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?: AddonState, opts?: CustomResourceOptions): Addon

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        config: Optional[Mapping[str, Any]] = None,
        config_var_values: Optional[Mapping[str, str]] = None,
        config_vars: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        plan: Optional[str] = None,
        provider_id: Optional[str] = None) -> Addon

func GetAddon(ctx *Context, name string, id IDInput, state *AddonState, opts ...ResourceOption) (*Addon, error)

public static Addon Get(string name, Input<string> id, AddonState? state, CustomResourceOptions? opts = null)

public static Addon get(String name, Output<String> id, AddonState 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:

AppId string
Config Dictionary<string, object>
ConfigVarValues Dictionary<string, string>
ConfigVars List<string>
Name string
Plan string
ProviderId string

AppId string
Config map[string]interface{}
ConfigVarValues map[string]string
ConfigVars []string
Name string
Plan string
ProviderId string

appId String
config Map<String,Object>
configVarValues Map<String,String>
configVars List<String>
name String
plan String
providerId String

appId string
config {[key: string]: any}
configVarValues {[key: string]: string}
configVars string[]
name string
plan string
providerId string

app_id str
config Mapping[str, Any]
config_var_values Mapping[str, str]
config_vars Sequence[str]
name str
plan str
provider_id str

appId String
config Map<Any>
configVarValues Map<String>
configVars List<String>
name String
plan String
providerId String

Package Details

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