Docs Home
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
heroku.drain.Drain
Explore with Pulumi AI
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
Create Drain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Drain(name: string, args: DrainArgs, opts?: CustomResourceOptions);@overload
def Drain(resource_name: str,
args: DrainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Drain(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
sensitive_url: Optional[str] = None,
url: Optional[str] = None)func NewDrain(ctx *Context, name string, args DrainArgs, opts ...ResourceOption) (*Drain, error)public Drain(string name, DrainArgs args, CustomResourceOptions? opts = null)type: heroku:drain:Drain
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 DrainArgs
- 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 DrainArgs
- 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 DrainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DrainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DrainArgs
- 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 drainResource = new Heroku.Drain.Drain("drainResource", new()
{
AppId = "string",
SensitiveUrl = "string",
Url = "string",
});
example, err := drain.NewDrain(ctx, "drainResource", &drain.DrainArgs{
AppId: pulumi.String("string"),
SensitiveUrl: pulumi.String("string"),
Url: pulumi.String("string"),
})
var drainResource = new Drain("drainResource", DrainArgs.builder()
.appId("string")
.sensitiveUrl("string")
.url("string")
.build());
drain_resource = heroku.drain.Drain("drainResource",
app_id="string",
sensitive_url="string",
url="string")
const drainResource = new heroku.drain.Drain("drainResource", {
appId: "string",
sensitiveUrl: "string",
url: "string",
});
type: heroku:drain:Drain
properties:
appId: string
sensitiveUrl: string
url: string
Drain 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 Drain resource accepts the following input properties:
- App
Id string - Sensitive
Url string - Url string
- App
Id string - Sensitive
Url string - Url string
- app
Id String - sensitive
Url String - url String
- app
Id string - sensitive
Url string - url string
- app_
id str - sensitive_
url str - url str
- app
Id String - sensitive
Url String - url String
Outputs
All input properties are implicitly available as output properties. Additionally, the Drain resource produces the following output properties:
Look up Existing Drain Resource
Get an existing Drain 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?: DrainState, opts?: CustomResourceOptions): Drain@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
sensitive_url: Optional[str] = None,
token: Optional[str] = None,
url: Optional[str] = None) -> Drainfunc GetDrain(ctx *Context, name string, id IDInput, state *DrainState, opts ...ResourceOption) (*Drain, error)public static Drain Get(string name, Input<string> id, DrainState? state, CustomResourceOptions? opts = null)public static Drain get(String name, Output<String> id, DrainState 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.
- App
Id string - Sensitive
Url string - Token string
- Url string
- App
Id string - Sensitive
Url string - Token string
- Url string
- app
Id String - sensitive
Url String - token String
- url String
- app
Id string - sensitive
Url string - token string
- url string
- app_
id str - sensitive_
url str - token str
- url str
- app
Id String - sensitive
Url String - token String
- url String
Package Details
- Repository
- heroku pulumiverse/pulumi-heroku
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
herokuTerraform Provider.
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns