Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/esc
  7. EnvironmentDraft

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api/esc.EnvironmentDraft

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Creates a new draft change request for a Pulumi ESC environment. Drafts allow proposing changes to an environment definition that can be reviewed and approved before being applied. This is part of the approvals workflow for environments. Returns a ChangeRequestRef containing the draft identifier. Requires the Approvals feature to be enabled for the organization.

    Create EnvironmentDraft Resource

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

    Constructor syntax

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

@overload
def EnvironmentDraft(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     env_name: Optional[str] = None,
                     org_name: Optional[str] = None,
                     project_name: Optional[str] = None,
                     change_request_id: Optional[str] = None)
    func NewEnvironmentDraft(ctx *Context, name string, args EnvironmentDraftArgs, opts ...ResourceOption) (*EnvironmentDraft, error)
    public EnvironmentDraft(string name, EnvironmentDraftArgs args, CustomResourceOptions? opts = null)
    public EnvironmentDraft(String name, EnvironmentDraftArgs args)
public EnvironmentDraft(String name, EnvironmentDraftArgs args, CustomResourceOptions options)

    type: pulumiservice:api/esc:EnvironmentDraft
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_esc_environmentdraft" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentDraftArgs
    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 EnvironmentDraftArgs
    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 EnvironmentDraftArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentDraftArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentDraftArgs
    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 environmentDraftResource = new PulumiService.Api.Esc.EnvironmentDraft("environmentDraftResource", new()
{
    EnvName = "string",
    OrgName = "string",
    ProjectName = "string",
    ChangeRequestId = "string",
});

    example, err := esc.NewEnvironmentDraft(ctx, "environmentDraftResource", &esc.EnvironmentDraftArgs{
	EnvName:         pulumi.String("string"),
	OrgName:         pulumi.String("string"),
	ProjectName:     pulumi.String("string"),
	ChangeRequestId: pulumi.String("string"),
})

    resource "pulumiservice_api_esc_environmentdraft" "environmentDraftResource" {
  env_name          = "string"
  org_name          = "string"
  project_name      = "string"
  change_request_id = "string"
}

    var environmentDraftResource = new EnvironmentDraft("environmentDraftResource", EnvironmentDraftArgs.builder()
    .envName("string")
    .orgName("string")
    .projectName("string")
    .changeRequestId("string")
    .build());

    environment_draft_resource = pulumiservice.api.esc.EnvironmentDraft("environmentDraftResource",
    env_name="string",
    org_name="string",
    project_name="string",
    change_request_id="string")

    const environmentDraftResource = new pulumiservice.api.esc.EnvironmentDraft("environmentDraftResource", {
    envName: "string",
    orgName: "string",
    projectName: "string",
    changeRequestId: "string",
});

    type: pulumiservice:api/esc:EnvironmentDraft
properties:
    changeRequestId: string
    envName: string
    orgName: string
    projectName: string

    EnvironmentDraft Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EnvironmentDraft resource accepts the following input properties:

    EnvName string
    The environment name
    OrgName string
    The organization name
    ProjectName string
    The project name
    ChangeRequestId string
    The change request ID
    EnvName string
    The environment name
    OrgName string
    The organization name
    ProjectName string
    The project name
    ChangeRequestId string
    The change request ID
    env_name string
    The environment name
    org_name string
    The organization name
    project_name string
    The project name
    change_request_id string
    The change request ID
    envName String
    The environment name
    orgName String
    The organization name
    projectName String
    The project name
    changeRequestId String
    The change request ID
    envName string
    The environment name
    orgName string
    The organization name
    projectName string
    The project name
    changeRequestId string
    The change request ID
    env_name str
    The environment name
    org_name str
    The organization name
    project_name str
    The project name
    change_request_id str
    The change request ID
    envName String
    The environment name
    orgName String
    The organization name
    projectName String
    The project name
    changeRequestId String
    The change request ID

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevisionNumber int
    The latest revision number
    Yaml string
    Raw YAML body content.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevisionNumber int
    The latest revision number
    Yaml string
    Raw YAML body content.
    id string
    The provider-assigned unique ID for this managed resource.
    latest_revision_number number
    The latest revision number
    yaml string
    Raw YAML body content.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevisionNumber Integer
    The latest revision number
    yaml String
    Raw YAML body content.
    id string
    The provider-assigned unique ID for this managed resource.
    latestRevisionNumber number
    The latest revision number
    yaml string
    Raw YAML body content.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_revision_number int
    The latest revision number
    yaml str
    Raw YAML body content.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevisionNumber Number
    The latest revision number
    yaml String
    Raw YAML body content.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial