1. Pulumi Registry
  2. Heroku
  3. API Docs
  4. domain
  5. Domain
heroku logo
Heroku v1.0.2, Dec 5 22

heroku.domain.Domain

Create Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           app_id: Optional[str] = None,
           hostname: Optional[str] = None,
           sni_endpoint_id: Optional[str] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)
func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: heroku:domain:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainArgs
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 DomainArgs
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 DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AppId string
Hostname string
SniEndpointId string
AppId string
Hostname string
SniEndpointId string
appId String
hostname String
sniEndpointId String
appId string
hostname string
sniEndpointId string
appId String
hostname String
sniEndpointId String

Outputs

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

Cname string
Id string

The provider-assigned unique ID for this managed resource.

Cname string
Id string

The provider-assigned unique ID for this managed resource.

cname String
id String

The provider-assigned unique ID for this managed resource.

cname string
id string

The provider-assigned unique ID for this managed resource.

cname str
id str

The provider-assigned unique ID for this managed resource.

cname String
id String

The provider-assigned unique ID for this managed resource.

Look up Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        cname: Optional[str] = None,
        hostname: Optional[str] = None,
        sni_endpoint_id: Optional[str] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState 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
Cname string
Hostname string
SniEndpointId string
AppId string
Cname string
Hostname string
SniEndpointId string
appId String
cname String
hostname String
sniEndpointId String
appId string
cname string
hostname string
sniEndpointId string
appId String
cname String
hostname String
sniEndpointId String

Package Details

Repository
heroku pulumiverse/pulumi-heroku
License
Apache-2.0
Notes

This Pulumi package is based on the heroku Terraform Provider.