1. Docs
  2. User Guides
  3. Automation API
  4. Getting Started with Automation API

Getting Started with Automation API

Pulumi’s Automation API enables you to provision your infrastructure programmatically using the Pulumi engine by exposing Pulumi programs and stacks as strongly-typed and composable building blocks.

In this guide, you will deploy an inline Pulumi program to create a static website using Automation API.

Prerequisites

Install Pulumi

Install Pulumi on macOS through Homebrew:

$ brew install pulumi/tap/pulumi

Install Pulumi on Linux by running the installation script:

$ curl -fsSL https://get.pulumi.com | sh

Install Pulumi on Windows using elevated permissions through the Chocolatey package manager:

> choco install pulumi

For alternative installation instructions (e.g. script-based installation, binaries, etc.) or troubleshooting, see Download and Install.

Install the required language runtime, if you have not already.

Install language runtime

Choose your language

Install Node.js.

Install Python version 3.7 or later. To reduce potential issues with setting up your Python environment on Windows or macOS, you should install Python through the official Python installer.

Install Go.

Install .NET SDK.

Obtain a Pulumi access token

You’ll need a Pulumi access token so that your programs can store the resulting state in the Pulumi Service. The easiest way to obtain such a token is to run pulumi login from the command line.

Define your Pulumi program

First, define the Pulumi program you want to run as a function within your overall program. Note how it looks like a standard Pulumi program.
const pulumiProgram = async () => {
    // Create a bucket and expose a website index document.
    const siteBucket = new s3.Bucket("s3-website-bucket", {
        website: {
            indexDocument: "index.html",
        },
    });

    const indexContent = `<html><head>
<title>Hello S3</title><meta charset="UTF-8">
</head>
<body><p>Hello, world!</p><p>Made with ❤️ with <a href="https://pulumi.com">Pulumi</a></p>
</body></html>
`

    // Write our index.html into the site bucket.
    let object = new s3.BucketObject("index", {
        bucket: siteBucket,
        content: indexContent,
        contentType: "text/html; charset=utf-8",
        key: "index.html"
    });

    // Create an S3 Bucket Policy to allow public read of all objects in bucket.
    function publicReadPolicyForBucket(bucketName): PolicyDocument {
        return {
            Version: "2012-10-17",
            Statement: [{
                Effect: "Allow",
                Principal: "*",
                Action: [
                    "s3:GetObject"
                ],
                Resource: [
                    `arn:aws:s3:::${bucketName}/*` // Policy refers to bucket name explicitly.
                ]
            }]
        };
    }

    // Set the access policy for the bucket so all objects are readable.
    let bucketPolicy = new s3.BucketPolicy("bucketPolicy", {
        bucket: siteBucket.bucket, // Refer to the bucket created earlier.
        policy: siteBucket.bucket.apply(publicReadPolicyForBucket) // Use output property `siteBucket.bucket`.
    });

    return {
        websiteUrl: siteBucket.websiteEndpoint,
    };
};

def pulumi_program():
    # Create a bucket and expose a website index document.
    site_bucket = s3.Bucket("s3-website-bucket", website=s3.BucketWebsiteArgs(index_document="index.html"))
    index_content = """
    <html>
        <head><title>Hello S3</title><meta charset="UTF-8"></head>
        <body>
            <p>Hello, world!</p>
            <p>Made with ❤️ with <a href="https://pulumi.com">Pulumi</a></p>
        </body>
    </html>
    """

    # Write our index.html into the site bucket.
    s3.BucketObject("index",
                    bucket=site_bucket.id,  # Reference to the s3.Bucket object.
                    content=index_content,
                    key="index.html",  # Set the key of the object.
                    content_type="text/html; charset=utf-8")  # Set the MIME type of the file.

    # Set the access policy for the bucket so all objects are readable.
    s3.BucketPolicy("bucket-policy", bucket=site_bucket.id, policy={
        "Version": "2012-10-17",
        "Statement": {
            "Effect": "Allow",
            "Principal": "*",
            "Action": ["s3:GetObject"],
            # Policy refers to bucket explicitly.
            "Resource": [pulumi.Output.concat("arn:aws:s3:::", site_bucket.id, "/*")]
        },
    })

    # Export the website URL.
    pulumi.export("website_url", site_bucket.website_endpoint)

deployFunc := func(ctx *pulumi.Context) error {
  // Similar go git_repo_program, our program defines a s3 website.
  // Here we create the bucket.
  siteBucket, err := s3.NewBucket(ctx, "s3-website-bucket", &s3.BucketArgs{
    Website: s3.BucketWebsiteArgs{
      IndexDocument: pulumi.String("index.html"),
    },
  })
  if err != nil {
    return err
  }

  // We define and upload our HTML inline.
  indexContent := `<html><head>
  <title>Hello S3</title><meta charset="UTF-8">
</head>
<body><p>Hello, world!</p><p>Made with ❤️ with <a href="https://pulumi.com">Pulumi</a></p>
</body></html>
`
  // Upload our index.html.
  if _, err := s3.NewBucketObject(ctx, "index", &s3.BucketObjectArgs{
    Bucket:      siteBucket.ID(), // Reference to the s3.Bucket object.
    Content:     pulumi.String(indexContent),
    Key:         pulumi.String("index.html"),               // Set the key of the object.
    ContentType: pulumi.String("text/html; charset=utf-8"), // Set the MIME type of the file.
  }); err != nil {
    return err
  }

  // Set the access policy for the bucket so all objects are readable.
  if _, err := s3.NewBucketPolicy(ctx, "bucketPolicy", &s3.BucketPolicyArgs{
    Bucket: siteBucket.ID(), // Refer to the bucket created earlier.
    Policy: pulumi.Any(map[string]interface{}{
      "Version": "2012-10-17",
      "Statement": []map[string]interface{}{
        {
          "Effect":    "Allow",
          "Principal": "*",
          "Action": []interface{}{
            "s3:GetObject",
          },
          "Resource": []interface{}{
            pulumi.Sprintf("arn:aws:s3:::%s/*", siteBucket.ID()), // Policy refers to bucket name explicitly.
          },
        },
      },
    }),
  }); err != nil {
    return err
  }

  // Export the website URL.
  ctx.Export("websiteUrl", siteBucket.WebsiteEndpoint)
  return nil
}

var program = PulumiFn.Create(() =>
{
    // Create a bucket and expose a website index document.
    var siteBucket = new Pulumi.Aws.S3.Bucket(
        "s3-website-bucket",
        new Pulumi.Aws.S3.BucketArgs
        {
            Website = new Pulumi.Aws.S3.Inputs.BucketWebsiteArgs
            {
                IndexDocument = "index.html",
            },
        });

                const string indexContent = @"
<html>
    <head><titl>Hello S3</title><meta charset=""UTF-8""></head>
    <body>
        <p>Hello, world!</p>
        <p>Made with ❤️ with <a href=""https://pulumi.com"">Pulumi</a></p>
    </body>
</html>
";

    // Write our index.html into the site bucket.
    var @object = new Pulumi.Aws.S3.BucketObject(
        "index",
        new Pulumi.Aws.S3.BucketObjectArgs
        {
            Bucket = siteBucket.BucketName, // Reference to the s3 bucket object.
            Content = indexContent,
            Key = "index.html", // Set the key of the object.
            ContentType = "text/html; charset=utf-8", // Set the MIME type of the file.
        });

    var bucketPolicyDocument = siteBucket.Arn.Apply(bucketArn =>
    {
        return Output.Create(Pulumi.Aws.Iam.GetPolicyDocument.InvokeAsync(
            new Pulumi.Aws.Iam.GetPolicyDocumentArgs
            {
                Statements = new List<Pulumi.Aws.Iam.Inputs.GetPolicyDocumentStatementArgs>
                {
                    new Pulumi.Aws.Iam.Inputs.GetPolicyDocumentStatementArgs
                    {
                        Effect = "Allow",
                        Principals = new List<Pulumi.Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalArgs>
                        {
                            new Pulumi.Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalArgs
                            {
                                Identifiers = new List<string> { "*" },
                                Type = "AWS",
                            },
                        },
                        Actions = new List<string> { "s3:GetObject" },
                        Resources = new List<string> { $"{bucketArn}/*" },
                    },
                },
            }));
    });

    // Set the access policy for the bucket so all objects are readable.
    new Pulumi.Aws.S3.BucketPolicy(
        "bucket-policy",
        new Pulumi.Aws.S3.BucketPolicyArgs
        {
            Bucket = siteBucket.BucketName,
            Policy = bucketPolicyDocument.Apply(x => x.Json),
        });

    // Export the website url.
    return new Dictionary<string, object?>
    {
        ["website_url"] = siteBucket.WebsiteEndpoint,
    };
});

Associate with a stack

As with executing Pulumi programs through the CLI, you need to associate your Pulumi program with a Stack. Automation API provides methods to create or select stacks.

Here’s a convenient method to select an existing Stack or create one if none exists:

const args: InlineProgramArgs = {
    stackName: "dev",
    projectName: "inlineNode",
    program: pulumiProgram
};

const stack = await LocalWorkspace.createOrSelectStack(args);

project_name = "inline_s3_project"
stack_name = "dev"

stack = auto.create_or_select_stack(stack_name=stack_name,
                                    project_name=project_name,
                                    program=pulumi_program)

projectName := "inlineS3Project"
stackName := "dev"
s, err := auto.UpsertStackInlineSource(ctx, stackName, projectName, deployFunc)

var projectName = "inline_s3_project";
var stackName = "dev";

var stackArgs = new InlineProgramArgs(projectName, stackName, program);
var stack = await LocalWorkspace.CreateOrSelectStackAsync(stackArgs);

A Stack object operates within the context of a Workspace. A Workspace is the execution context containing a single Pulumi project, a program, and multiple stacks. Workspaces are used to manage the execution environment, providing various utilities such as plugin installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of stacks. Because you are deploying AWS resources in this tutorial, you must install the AWS provider plugin within your Workspace so that your Pulumi program will have it available during execution.

Configure your provider plugins

The AWS plugin also needs configuration. You can provide that configuration just as you would with other Pulumi programs: either through stack configuration or environment variables. In this tutorial, you’ll use the Stack object to set the AWS region for the AWS provider plugin.

await stack.workspace.installPlugin("aws", "v4.0.0");
await stack.setConfig("aws:region", { value: "us-west-2" });

stack.workspace.install_plugin("aws", "v4.0.0")
stack.set_config("aws:region", auto.ConfigValue(value="us-west-2"))

err = w.InstallPlugin(ctx, "aws", "v4.0.0")
if err != nil {
  fmt.Printf("Failed to install program plugins: %v\n", err)
  os.Exit(1)
}

s.SetConfig(ctx, "aws:region", auto.ConfigValue{Value: "us-west-2"})

await stack.Workspace.InstallPluginAsync("aws", "v4.0.0");
await stack.SetConfigAsync("aws:region", new ConfigValue("us-west-2"));

Invoke Pulumi commands against the stack

You’re now ready to execute commands against the Stack, including update, preview, refresh, destroy, import, and export. If you want to update the stack, invoke the update method (up) against the Stack object:

const upRes = await stack.up({ onOutput: console.info });

up_res = stack.up(on_output=print)

res, err := s.Up(ctx, stdoutStreamer)
if err != nil {
  fmt.Printf("Failed to update stack: %v\n\n", err)
  os.Exit(1)
}

var result = await stack.UpAsync(new UpOptions { OnStandardOutput = Console.WriteLine });

Notice how you can choose to have a callback function for standard output. In addition, the command returns a result of the update, which you can programmatically use to drive decisions within your program. For example, the result includes the stack outputs as well as a summary of the changes. This means you could choose to take different actions if there were no resources updated. Conversely, you could use the stack outputs to drive another Pulumi program within the same Automation program.

By now, you’ve hopefully gained a clearer understanding of how to utilize the Automation API. For additional ideas, see the Automation API examples.

Register for Pulumi UP, June 15, 2023