heroku.account.Feature

This resource is used to create and manage User Features on Heroku.

NOTE: If this resource’s HCL is removed from a .tf file, the behavior is to disable account feature and remove resource from state.

Available Features

For a list of available features, use the heroku labs command to fetch them for the current authenticated user.

The output will contain User Features that may be managed with this resource.

Example Usage

resource "heroku_account_feature" "example_metrics" {
  name = "metrics-request-volume"
  enabled = true
}

Create Feature Resource

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

Constructor syntax

new Feature(name: string, args: FeatureArgs, opts?: CustomResourceOptions);

@overload
def Feature(resource_name: str,
            args: FeatureArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Feature(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None)

func NewFeature(ctx *Context, name string, args FeatureArgs, opts ...ResourceOption) (*Feature, error)

public Feature(string name, FeatureArgs args, CustomResourceOptions? opts = null)

public Feature(String name, FeatureArgs args)
public Feature(String name, FeatureArgs args, CustomResourceOptions options)

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

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var featureResource = new Heroku.Account.Feature("featureResource", new()
{
    Enabled = false,
    Name = "string",
});

example, err := account.NewFeature(ctx, "featureResource", &account.FeatureArgs{
	Enabled: pulumi.Bool(false),
	Name:    pulumi.String("string"),
})

var featureResource = new com.pulumi.heroku.account.Feature("featureResource", com.pulumi.heroku.account.FeatureArgs.builder()
    .enabled(false)
    .name("string")
    .build());

feature_resource = heroku.account.Feature("featureResource",
    enabled=False,
    name="string")

const featureResource = new heroku.account.Feature("featureResource", {
    enabled: false,
    name: "string",
});

type: heroku:account:Feature
properties:
    enabled: false
    name: string

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

Outputs

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

Look up Existing Feature Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        state: Optional[str] = None) -> Feature

func GetFeature(ctx *Context, name string, id IDInput, state *FeatureState, opts ...ResourceOption) (*Feature, error)

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

public static Feature get(String name, Output<String> id, FeatureState state, CustomResourceOptions options)

resources:  _:    type: heroku:account:Feature    get:      id: ${id}

Import

Existing account features can be imported using a combination of the account email (the email address tied to the Heroku API key) and the feature name.

For example:

$ pulumi import heroku:account/feature:Feature example_metrics name@example.com:metrics-request-volume

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

heroku pulumiverse/pulumi-heroku

License

Apache-2.0

Notes

This Pulumi package is based on the heroku Terraform Provider.