Skip to main content

Creating Deployments

A Deployment is the core unit of work in Amnify Deploy — it represents a specific piece of infrastructure provisioned in a real cloud environment. This guide walks through every step of the Deployment Creation wizard.

Before You Start​

Make sure you have:

  • A Project to assign the deployment to (or create one — see Managing Projects)
  • A template selected from the library (or know the GitHub repository source you want to use)
  • The variable values required by the template
  • The cloud environment details (provider, region, account/subscription)

Opening the Wizard​

There are two ways to start:

From the Template Library:

  1. Navigate to Deploy → Templates
  2. Find the template you want
  3. Click Use Template — the wizard opens with this template pre-selected

From a Project:

  1. Open a Project detail page
  2. Click New Deployment
  3. The wizard opens at Step 1 (source selection)

Step 1 — Choose a Source​

Select the source of your infrastructure definition:

OptionDescription
TemplateChoose from the Amnify template library (synced from your GitHub repository)
GitHub RepositoryPoint directly to a GitHub repository for advanced, bespoke use cases where custom definitions don't fit the shared template model

For most use cases, choose Template.

Step 2 — Basic Details​

Fill in the core information for this deployment:

FieldRequiredGuidance
NameYesBe specific and descriptive. Include the environment or region if relevant (e.g., "EU Staging — PostgreSQL")
DescriptionNoExplain what this deployment is for, especially if the name alone is not self-explanatory
ProjectYesThe project this deployment will belong to

Step 3 — Template Variables​

For each variable defined by the template, provide a value:

Required variables must have a value before you can proceed. They are marked with a red asterisk.

Optional variables have defaults or are not strictly needed. You can leave them blank or override the default.

Sensitive variables (e.g., database passwords, API keys) are marked with a lock icon. Enter the value — it will be stored securely. Once saved, you will not be able to see the value again, only update it.

Dropdown variables offer a predefined set of allowed values. Select from the list rather than typing a value.

Cloud resource variables let you browse your connected cloud account and select an existing resource (e.g., a resource group, a virtual network). Click the picker icon to browse and select.

tip

If you are unsure about a variable's purpose, hover over the info icon next to it for a description provided by the template author.

Step 4 — Cloud Environment​

Configure where this deployment will run:

FieldDescription
Cloud ProviderAzure, AWS, or GCP
RegionThe geographic region to deploy into (e.g., East US 2, eu-west-1, europe-west1)
Account / SubscriptionThe specific cloud account or subscription to use (from your configured integrations)

The available options depend on which cloud integrations have been configured for your organization.

Step 5 — Tags (Optional)​

Tags are key–value pairs attached to this deployment. They are useful for filtering (find deployments by team, environment, or owner), cost tracking (associate deployments with billing codes or cost centers), and recording any useful context that does not fit in the description.

Examples:

env: production
team: platform
region: eu-west
cost-center: engineering

Step 6 — Review and Create​

Review all the details you have entered:

  • Deployment name, description, and project
  • Template and variable values (sensitive values are shown as •••••••)
  • Cloud environment (provider, region, account)
  • Tags

If everything looks correct, click Create Deployment.

The deployment is created — but no infrastructure has been provisioned yet. The next step is to execute it.

Executing the Deployment​

After creating the deployment, you are taken to the Deployment detail page. To provision the infrastructure:

  1. Click Execute
  2. A new Run is created and the process begins
  3. Follow the Approval Workflow guide to review and approve the plan

Editing an Existing Deployment​

You can update a deployment's variable values at any time:

  1. Open the Deployment detail page
  2. Click Edit
  3. Update the variable values as needed
  4. Save the changes

Editing does not trigger a new run automatically. To apply the updated values to the cloud infrastructure, execute the deployment again after saving.

Next Steps​