Docs Packages
  1. Packages
  2. Heroku
  3. API Docs
  4. formation
  5. Formation
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

heroku.formation.Formation

Explore with Pulumi AI

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

    Create Formation Resource

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

    Constructor syntax

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

@overload
def Formation(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              app_id: Optional[str] = None,
              quantity: Optional[int] = None,
              size: Optional[str] = None,
              type: Optional[str] = None)
    func NewFormation(ctx *Context, name string, args FormationArgs, opts ...ResourceOption) (*Formation, error)
    public Formation(string name, FormationArgs args, CustomResourceOptions? opts = null)
    public Formation(String name, FormationArgs args)
public Formation(String name, FormationArgs args, CustomResourceOptions options)

    type: heroku:formation:Formation
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 FormationArgs
    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 FormationArgs
    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 FormationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FormationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FormationArgs
    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 formationResource = new Heroku.Formation.Formation("formationResource", new()
{
    AppId = "string",
    Quantity = 0,
    Size = "string",
    Type = "string",
});

    example, err := formation.NewFormation(ctx, "formationResource", &formation.FormationArgs{
	AppId:    pulumi.String("string"),
	Quantity: pulumi.Int(0),
	Size:     pulumi.String("string"),
	Type:     pulumi.String("string"),
})

    var formationResource = new Formation("formationResource", FormationArgs.builder()
    .appId("string")
    .quantity(0)
    .size("string")
    .type("string")
    .build());

    formation_resource = heroku.formation.Formation("formationResource",
    app_id="string",
    quantity=0,
    size="string",
    type="string")

    const formationResource = new heroku.formation.Formation("formationResource", {
    appId: "string",
    quantity: 0,
    size: "string",
    type: "string",
});

    type: heroku:formation:Formation
properties:
    appId: string
    quantity: 0
    size: string
    type: string

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

    AppId string
    Quantity int
    Size string
    Type string
    AppId string
    Quantity int
    Size string
    Type string
    appId String
    quantity Integer
    size String
    type String
    appId string
    quantity number
    size string
    type string
    app_id str
    quantity int
    size str
    type str
    appId String
    quantity Number
    size String
    type String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Formation Resource

    Get an existing Formation 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?: FormationState, opts?: CustomResourceOptions): Formation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        quantity: Optional[int] = None,
        size: Optional[str] = None,
        type: Optional[str] = None) -> Formation
    func GetFormation(ctx *Context, name string, id IDInput, state *FormationState, opts ...ResourceOption) (*Formation, error)
    public static Formation Get(string name, Input<string> id, FormationState? state, CustomResourceOptions? opts = null)
    public static Formation get(String name, Output<String> id, FormationState 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
    Quantity int
    Size string
    Type string
    AppId string
    Quantity int
    Size string
    Type string
    appId String
    quantity Integer
    size String
    type String
    appId string
    quantity number
    size string
    type string
    app_id str
    quantity int
    size str
    type str
    appId String
    quantity Number
    size String
    type String

    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
    pulumiverse/pulumi-heroku