awscc_amplify_branch (Resource)

The AWS::Amplify::Branch resource creates a new branch within an app.

Example Usage

Single Branch Creation

To use awscc_amplify_branch to create a single branch:

resource "awscc_amplify_app" "example" {
  name = "app"
}

resource "awscc_amplify_branch" "main" {
  app_id      = awscc_amplify_app.example.app_id
  branch_name = "main"

  framework = "React"
  stage     = "PRODUCTION"

  environment_variables = [
    {
      name  = "REACT_APP_API_SERVER"
      value = "https://api.example.com"
    },
    {
      name  = "Environment"
      value = "PROD"
    },
  ]
}

Multiple Branch Creation

To use awscc_amplify_branch to create multiple branches:

resource "awscc_amplify_app" "example" {
  name = "app"
}

resource "awscc_amplify_branch" "main" {
  app_id      = awscc_amplify_app.example.app_id
  branch_name = "main"

  framework = "React"
  stage     = "PRODUCTION"

  environment_variables = [
    {
      name  = "REACT_APP_API_SERVER"
      value = "https://api.example.com"
    },
    {
      name  = "Environment"
      value = "PROD"
    },
  ]
}

resource "awscc_amplify_branch" "dev" {
  app_id      = awscc_amplify_app.example.app_id
  branch_name = "dev"

  framework = "React"
  stage     = "DEVELOPMENT"

  environment_variables = [
    {
      name  = "REACT_APP_API_SERVER"
      value = "https://dev.api.example.com"
    },
    {
      name  = "Environment"
      value = "DEV"
    },
  ]
}

Basic Authentication

resource "awscc_amplify_app" "example" {
  name = "app"
}

resource "awscc_amplify_branch" "main" {
  app_id      = awscc_amplify_app.example.app_id
  branch_name = "main"

  # Used to restrict access to your branches with a username and password
  basic_auth_config = {
    enable_basic_auth = true
    username          = "your-username"
    password          = "your-password"
  }
}

Schema

Required

Optional

Read-Only

Nested Schema for backend

Optional:

Nested Schema for basic_auth_config

Required:

Optional:

Nested Schema for environment_variables

Required:

Nested Schema for tags

Required:

Import

Import is supported using the following syntax:

$ terraform import awscc_amplify_branch.example <resource ID>