1. Packages
  2. Vercel
  3. API Docs
  4. Alias
Vercel v1.3.0 published on Wednesday, Mar 13, 2024 by Pulumiverse

vercel.Alias

Explore with Pulumi AI

vercel logo
Vercel v1.3.0 published on Wednesday, Mar 13, 2024 by Pulumiverse

    Provides an Alias resource.

    An Alias allows a vercel.Deployment to be accessed through a different URL.

    Create Alias Resource

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

    Constructor syntax

    new Alias(name: string, args: AliasArgs, opts?: CustomResourceOptions);
    @overload
    def Alias(resource_name: str,
              args: AliasArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Alias(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              alias: Optional[str] = None,
              deployment_id: Optional[str] = None,
              team_id: Optional[str] = None)
    func NewAlias(ctx *Context, name string, args AliasArgs, opts ...ResourceOption) (*Alias, error)
    public Alias(string name, AliasArgs args, CustomResourceOptions? opts = null)
    public Alias(String name, AliasArgs args)
    public Alias(String name, AliasArgs args, CustomResourceOptions options)
    
    type: vercel:Alias
    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 AliasArgs
    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 AliasArgs
    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 AliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var aliasResource = new Vercel.Alias("aliasResource", new()
    {
        DeploymentAlias = "string",
        DeploymentId = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewAlias(ctx, "aliasResource", &vercel.AliasArgs{
    	Alias:        pulumi.String("string"),
    	DeploymentId: pulumi.String("string"),
    	TeamId:       pulumi.String("string"),
    })
    
    var aliasResource = new Alias("aliasResource", AliasArgs.builder()        
        .alias("string")
        .deploymentId("string")
        .teamId("string")
        .build());
    
    alias_resource = vercel.Alias("aliasResource",
        alias="string",
        deployment_id="string",
        team_id="string")
    
    const aliasResource = new vercel.Alias("aliasResource", {
        alias: "string",
        deploymentId: "string",
        teamId: "string",
    });
    
    type: vercel:Alias
    properties:
        alias: string
        deploymentId: string
        teamId: string
    

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

    DeploymentAlias string
    The Alias we want to assign to the deployment defined in the URL.
    DeploymentId string
    The id of the Deployment the Alias should be associated with.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Alias string
    The Alias we want to assign to the deployment defined in the URL.
    DeploymentId string
    The id of the Deployment the Alias should be associated with.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId String
    The id of the Deployment the Alias should be associated with.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias string
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId string
    The id of the Deployment the Alias should be associated with.
    teamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias str
    The Alias we want to assign to the deployment defined in the URL.
    deployment_id str
    The id of the Deployment the Alias should be associated with.
    team_id str
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId String
    The id of the Deployment the Alias should be associated with.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Alias 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 Alias Resource

    Get an existing Alias 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?: AliasState, opts?: CustomResourceOptions): Alias
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alias: Optional[str] = None,
            deployment_id: Optional[str] = None,
            team_id: Optional[str] = None) -> Alias
    func GetAlias(ctx *Context, name string, id IDInput, state *AliasState, opts ...ResourceOption) (*Alias, error)
    public static Alias Get(string name, Input<string> id, AliasState? state, CustomResourceOptions? opts = null)
    public static Alias get(String name, Output<String> id, AliasState 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:
    DeploymentAlias string
    The Alias we want to assign to the deployment defined in the URL.
    DeploymentId string
    The id of the Deployment the Alias should be associated with.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Alias string
    The Alias we want to assign to the deployment defined in the URL.
    DeploymentId string
    The id of the Deployment the Alias should be associated with.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId String
    The id of the Deployment the Alias should be associated with.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias string
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId string
    The id of the Deployment the Alias should be associated with.
    teamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias str
    The Alias we want to assign to the deployment defined in the URL.
    deployment_id str
    The id of the Deployment the Alias should be associated with.
    team_id str
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias we want to assign to the deployment defined in the URL.
    deploymentId String
    The id of the Deployment the Alias should be associated with.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Vercel v1.3.0 published on Wednesday, Mar 13, 2024 by Pulumiverse