Try AWS Native preview for resources not in the classic version.
aws.amplify.App
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an Amplify App resource, a fullstack serverless app hosted on the AWS Amplify Console.
Note: When you create/update an Amplify App from the provider, you may end up with the error “BadRequestException: You should at least provide one valid token” because of authentication issues. See the section “Repository with Tokens” below.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
repository: "https://github.com/example/app",
buildSpec: `version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
`,
customRules: [{
source: "/<*>",
status: "404",
target: "/index.html",
}],
environmentVariables: {
ENV: "test",
},
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
repository="https://github.com/example/app",
build_spec="""version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
""",
custom_rules=[{
"source": "/<*>",
"status": "404",
"target": "/index.html",
}],
environment_variables={
"ENV": "test",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
Repository: pulumi.String("https://github.com/example/app"),
BuildSpec: pulumi.String(`version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
`),
CustomRules: amplify.AppCustomRuleArray{
&lify.AppCustomRuleArgs{
Source: pulumi.String("/<*>"),
Status: pulumi.String("404"),
Target: pulumi.String("/index.html"),
},
},
EnvironmentVariables: pulumi.StringMap{
"ENV": pulumi.String("test"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
Repository = "https://github.com/example/app",
BuildSpec = @"version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
",
CustomRules = new[]
{
new Aws.Amplify.Inputs.AppCustomRuleArgs
{
Source = "/<*>",
Status = "404",
Target = "/index.html",
},
},
EnvironmentVariables =
{
{ "ENV", "test" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import com.pulumi.aws.amplify.inputs.AppCustomRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.repository("https://github.com/example/app")
.buildSpec("""
version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
""")
.customRules(AppCustomRuleArgs.builder()
.source("/<*>")
.status("404")
.target("/index.html")
.build())
.environmentVariables(Map.of("ENV", "test"))
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
repository: https://github.com/example/app
buildSpec: |
version: 0.1
frontend:
phases:
preBuild:
commands:
- yarn install
build:
commands:
- yarn run build
artifacts:
baseDirectory: build
files:
- '**/*'
cache:
paths:
- node_modules/**/*
customRules:
- source: /<*>
status: '404'
target: /index.html
environmentVariables:
ENV: test
Repository with Tokens
If you create a new Amplify App with the repository
argument, you also need to set oauth_token
or access_token
for authentication. For GitHub, get a personal access token and set access_token
as follows:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
repository: "https://github.com/example/app",
accessToken: "...",
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
repository="https://github.com/example/app",
access_token="...")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
Repository: pulumi.String("https://github.com/example/app"),
AccessToken: pulumi.String("..."),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
Repository = "https://github.com/example/app",
AccessToken = "...",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.repository("https://github.com/example/app")
.accessToken("...")
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
repository: https://github.com/example/app
accessToken: '...'
You can omit access_token
if you import an existing Amplify App created by the Amplify Console (using OAuth for authentication).
Auto Branch Creation
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
enableAutoBranchCreation: true,
autoBranchCreationPatterns: [
"*",
"*/**",
],
autoBranchCreationConfig: {
enableAutoBuild: true,
},
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
enable_auto_branch_creation=True,
auto_branch_creation_patterns=[
"*",
"*/**",
],
auto_branch_creation_config={
"enableAutoBuild": True,
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
EnableAutoBranchCreation: pulumi.Bool(true),
AutoBranchCreationPatterns: pulumi.StringArray{
pulumi.String("*"),
pulumi.String("*/**"),
},
AutoBranchCreationConfig: &lify.AppAutoBranchCreationConfigArgs{
EnableAutoBuild: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
EnableAutoBranchCreation = true,
AutoBranchCreationPatterns = new[]
{
"*",
"*/**",
},
AutoBranchCreationConfig = new Aws.Amplify.Inputs.AppAutoBranchCreationConfigArgs
{
EnableAutoBuild = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import com.pulumi.aws.amplify.inputs.AppAutoBranchCreationConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.enableAutoBranchCreation(true)
.autoBranchCreationPatterns(
"*",
"*/**")
.autoBranchCreationConfig(AppAutoBranchCreationConfigArgs.builder()
.enableAutoBuild(true)
.build())
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
enableAutoBranchCreation: true # The default patterns added by the Amplify Console.
autoBranchCreationPatterns:
- '*'
- '*/**'
autoBranchCreationConfig:
enableAutoBuild: true
Basic Authorization
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const example = new aws.amplify.App("example", {
name: "example",
enableBasicAuth: true,
basicAuthCredentials: std.base64encode({
input: "username1:password1",
}).then(invoke => invoke.result),
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
example = aws.amplify.App("example",
name="example",
enable_basic_auth=True,
basic_auth_credentials=std.base64encode(input="username1:password1").result)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeBase64encode, err := std.Base64encode(ctx, &std.Base64encodeArgs{
Input: "username1:password1",
}, nil)
if err != nil {
return err
}
_, err = amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
EnableBasicAuth: pulumi.Bool(true),
BasicAuthCredentials: invokeBase64encode.Result,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
EnableBasicAuth = true,
BasicAuthCredentials = Std.Base64encode.Invoke(new()
{
Input = "username1:password1",
}).Apply(invoke => invoke.Result),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.enableBasicAuth(true)
.basicAuthCredentials(StdFunctions.base64encode(Base64encodeArgs.builder()
.input("username1:password1")
.build()).result())
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
enableBasicAuth: true
basicAuthCredentials:
fn::invoke:
Function: std:base64encode
Arguments:
input: username1:password1
Return: result
Rewrites and Redirects
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
customRules: [
{
source: "/api/<*>",
status: "200",
target: "https://api.example.com/api/<*>",
},
{
source: "</^[^.]+$|\\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>",
status: "200",
target: "/index.html",
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
custom_rules=[
{
"source": "/api/<*>",
"status": "200",
"target": "https://api.example.com/api/<*>",
},
{
"source": "</^[^.]+$|\\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>",
"status": "200",
"target": "/index.html",
},
])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
CustomRules: amplify.AppCustomRuleArray{
&lify.AppCustomRuleArgs{
Source: pulumi.String("/api/<*>"),
Status: pulumi.String("200"),
Target: pulumi.String("https://api.example.com/api/<*>"),
},
&lify.AppCustomRuleArgs{
Source: pulumi.String("</^[^.]+$|\\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>"),
Status: pulumi.String("200"),
Target: pulumi.String("/index.html"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
CustomRules = new[]
{
new Aws.Amplify.Inputs.AppCustomRuleArgs
{
Source = "/api/<*>",
Status = "200",
Target = "https://api.example.com/api/<*>",
},
new Aws.Amplify.Inputs.AppCustomRuleArgs
{
Source = "</^[^.]+$|\\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>",
Status = "200",
Target = "/index.html",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import com.pulumi.aws.amplify.inputs.AppCustomRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.customRules(
AppCustomRuleArgs.builder()
.source("/api/<*>")
.status("200")
.target("https://api.example.com/api/<*>")
.build(),
AppCustomRuleArgs.builder()
.source("</^[^.]+$|\\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>")
.status("200")
.target("/index.html")
.build())
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
customRules:
- source: /api/<*>
status: '200'
target: https://api.example.com/api/<*>
- source: </^[^.]+$|\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|ttf|map|json)$)([^.]+$)/>
status: '200'
target: /index.html
Custom Image
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
environmentVariables: {
_CUSTOM_IMAGE: "node:16",
},
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
environment_variables={
"_CUSTOM_IMAGE": "node:16",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
EnvironmentVariables: pulumi.StringMap{
"_CUSTOM_IMAGE": pulumi.String("node:16"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
EnvironmentVariables =
{
{ "_CUSTOM_IMAGE", "node:16" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.environmentVariables(Map.of("_CUSTOM_IMAGE", "node:16"))
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
environmentVariables:
_CUSTOM_IMAGE: node:16
Custom Headers
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {
name: "example",
customHeaders: `customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: "default-src 'self'"
`,
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example",
name="example",
custom_headers="""customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: "default-src 'self'"
""")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
CustomHeaders: pulumi.String(`customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: "default-src 'self'"
`),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
CustomHeaders = @"customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: ""default-src 'self'""
",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.customHeaders("""
customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: "default-src 'self'"
""")
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
customHeaders: |
customHeaders:
- pattern: '**'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: "default-src 'self'"
Create App Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
args: Optional[AppArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def App(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_token: Optional[str] = None,
auto_branch_creation_config: Optional[AppAutoBranchCreationConfigArgs] = None,
auto_branch_creation_patterns: Optional[Sequence[str]] = None,
basic_auth_credentials: Optional[str] = None,
build_spec: Optional[str] = None,
custom_headers: Optional[str] = None,
custom_rules: Optional[Sequence[AppCustomRuleArgs]] = None,
description: Optional[str] = None,
enable_auto_branch_creation: Optional[bool] = None,
enable_basic_auth: Optional[bool] = None,
enable_branch_auto_build: Optional[bool] = None,
enable_branch_auto_deletion: Optional[bool] = None,
environment_variables: Optional[Mapping[str, str]] = None,
iam_service_role_arn: Optional[str] = None,
name: Optional[str] = None,
oauth_token: Optional[str] = None,
platform: Optional[str] = None,
repository: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
type: aws:amplify:App
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 AppArgs
- 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 AppArgs
- 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 AppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppArgs
- 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 appResource = new Aws.Amplify.App("appResource", new()
{
AccessToken = "string",
AutoBranchCreationConfig = new Aws.Amplify.Inputs.AppAutoBranchCreationConfigArgs
{
BasicAuthCredentials = "string",
BuildSpec = "string",
EnableAutoBuild = false,
EnableBasicAuth = false,
EnablePerformanceMode = false,
EnablePullRequestPreview = false,
EnvironmentVariables =
{
{ "string", "string" },
},
Framework = "string",
PullRequestEnvironmentName = "string",
Stage = "string",
},
AutoBranchCreationPatterns = new[]
{
"string",
},
BasicAuthCredentials = "string",
BuildSpec = "string",
CustomHeaders = "string",
CustomRules = new[]
{
new Aws.Amplify.Inputs.AppCustomRuleArgs
{
Source = "string",
Target = "string",
Condition = "string",
Status = "string",
},
},
Description = "string",
EnableAutoBranchCreation = false,
EnableBasicAuth = false,
EnableBranchAutoBuild = false,
EnableBranchAutoDeletion = false,
EnvironmentVariables =
{
{ "string", "string" },
},
IamServiceRoleArn = "string",
Name = "string",
OauthToken = "string",
Platform = "string",
Repository = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := amplify.NewApp(ctx, "appResource", &lify.AppArgs{
AccessToken: pulumi.String("string"),
AutoBranchCreationConfig: &lify.AppAutoBranchCreationConfigArgs{
BasicAuthCredentials: pulumi.String("string"),
BuildSpec: pulumi.String("string"),
EnableAutoBuild: pulumi.Bool(false),
EnableBasicAuth: pulumi.Bool(false),
EnablePerformanceMode: pulumi.Bool(false),
EnablePullRequestPreview: pulumi.Bool(false),
EnvironmentVariables: pulumi.StringMap{
"string": pulumi.String("string"),
},
Framework: pulumi.String("string"),
PullRequestEnvironmentName: pulumi.String("string"),
Stage: pulumi.String("string"),
},
AutoBranchCreationPatterns: pulumi.StringArray{
pulumi.String("string"),
},
BasicAuthCredentials: pulumi.String("string"),
BuildSpec: pulumi.String("string"),
CustomHeaders: pulumi.String("string"),
CustomRules: amplify.AppCustomRuleArray{
&lify.AppCustomRuleArgs{
Source: pulumi.String("string"),
Target: pulumi.String("string"),
Condition: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
EnableAutoBranchCreation: pulumi.Bool(false),
EnableBasicAuth: pulumi.Bool(false),
EnableBranchAutoBuild: pulumi.Bool(false),
EnableBranchAutoDeletion: pulumi.Bool(false),
EnvironmentVariables: pulumi.StringMap{
"string": pulumi.String("string"),
},
IamServiceRoleArn: pulumi.String("string"),
Name: pulumi.String("string"),
OauthToken: pulumi.String("string"),
Platform: pulumi.String("string"),
Repository: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var appResource = new App("appResource", AppArgs.builder()
.accessToken("string")
.autoBranchCreationConfig(AppAutoBranchCreationConfigArgs.builder()
.basicAuthCredentials("string")
.buildSpec("string")
.enableAutoBuild(false)
.enableBasicAuth(false)
.enablePerformanceMode(false)
.enablePullRequestPreview(false)
.environmentVariables(Map.of("string", "string"))
.framework("string")
.pullRequestEnvironmentName("string")
.stage("string")
.build())
.autoBranchCreationPatterns("string")
.basicAuthCredentials("string")
.buildSpec("string")
.customHeaders("string")
.customRules(AppCustomRuleArgs.builder()
.source("string")
.target("string")
.condition("string")
.status("string")
.build())
.description("string")
.enableAutoBranchCreation(false)
.enableBasicAuth(false)
.enableBranchAutoBuild(false)
.enableBranchAutoDeletion(false)
.environmentVariables(Map.of("string", "string"))
.iamServiceRoleArn("string")
.name("string")
.oauthToken("string")
.platform("string")
.repository("string")
.tags(Map.of("string", "string"))
.build());
app_resource = aws.amplify.App("appResource",
access_token="string",
auto_branch_creation_config={
"basicAuthCredentials": "string",
"buildSpec": "string",
"enableAutoBuild": False,
"enableBasicAuth": False,
"enablePerformanceMode": False,
"enablePullRequestPreview": False,
"environmentVariables": {
"string": "string",
},
"framework": "string",
"pullRequestEnvironmentName": "string",
"stage": "string",
},
auto_branch_creation_patterns=["string"],
basic_auth_credentials="string",
build_spec="string",
custom_headers="string",
custom_rules=[{
"source": "string",
"target": "string",
"condition": "string",
"status": "string",
}],
description="string",
enable_auto_branch_creation=False,
enable_basic_auth=False,
enable_branch_auto_build=False,
enable_branch_auto_deletion=False,
environment_variables={
"string": "string",
},
iam_service_role_arn="string",
name="string",
oauth_token="string",
platform="string",
repository="string",
tags={
"string": "string",
})
const appResource = new aws.amplify.App("appResource", {
accessToken: "string",
autoBranchCreationConfig: {
basicAuthCredentials: "string",
buildSpec: "string",
enableAutoBuild: false,
enableBasicAuth: false,
enablePerformanceMode: false,
enablePullRequestPreview: false,
environmentVariables: {
string: "string",
},
framework: "string",
pullRequestEnvironmentName: "string",
stage: "string",
},
autoBranchCreationPatterns: ["string"],
basicAuthCredentials: "string",
buildSpec: "string",
customHeaders: "string",
customRules: [{
source: "string",
target: "string",
condition: "string",
status: "string",
}],
description: "string",
enableAutoBranchCreation: false,
enableBasicAuth: false,
enableBranchAutoBuild: false,
enableBranchAutoDeletion: false,
environmentVariables: {
string: "string",
},
iamServiceRoleArn: "string",
name: "string",
oauthToken: "string",
platform: "string",
repository: "string",
tags: {
string: "string",
},
});
type: aws:amplify:App
properties:
accessToken: string
autoBranchCreationConfig:
basicAuthCredentials: string
buildSpec: string
enableAutoBuild: false
enableBasicAuth: false
enablePerformanceMode: false
enablePullRequestPreview: false
environmentVariables:
string: string
framework: string
pullRequestEnvironmentName: string
stage: string
autoBranchCreationPatterns:
- string
basicAuthCredentials: string
buildSpec: string
customHeaders: string
customRules:
- condition: string
source: string
status: string
target: string
description: string
enableAutoBranchCreation: false
enableBasicAuth: false
enableBranchAutoBuild: false
enableBranchAutoDeletion: false
environmentVariables:
string: string
iamServiceRoleArn: string
name: string
oauthToken: string
platform: string
repository: string
tags:
string: string
App 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 App resource accepts the following input properties:
- Access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- Auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - Auto
Branch List<string>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- Basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- Build
Spec string - The build specification (build spec) for an Amplify app.
- Custom
Headers string - The custom HTTP headers for an Amplify app.
- Custom
Rules List<AppCustom Rule> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - Description string
- Description for an Amplify app.
- Enable
Auto boolBranch Creation - Enables automated branch creation for an Amplify app.
- Enable
Basic boolAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- Enable
Branch boolAuto Build - Enables auto-building of branches for the Amplify App.
- Enable
Branch boolAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- Environment
Variables Dictionary<string, string> - Environment variables map for an Amplify app.
- Iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- Name string
- Name for an Amplify app.
- Oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- Platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - Repository string
- Repository for an Amplify app.
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- Auto
Branch AppCreation Config Auto Branch Creation Config Args - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - Auto
Branch []stringCreation Patterns - Automated branch creation glob patterns for an Amplify app.
- Basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- Build
Spec string - The build specification (build spec) for an Amplify app.
- Custom
Headers string - The custom HTTP headers for an Amplify app.
- Custom
Rules []AppCustom Rule Args - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - Description string
- Description for an Amplify app.
- Enable
Auto boolBranch Creation - Enables automated branch creation for an Amplify app.
- Enable
Basic boolAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- Enable
Branch boolAuto Build - Enables auto-building of branches for the Amplify App.
- Enable
Branch boolAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- Environment
Variables map[string]string - Environment variables map for an Amplify app.
- Iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- Name string
- Name for an Amplify app.
- Oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- Platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - Repository string
- Repository for an Amplify app.
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- access
Token String - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch List<String>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth StringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec String - The build specification (build spec) for an Amplify app.
- custom
Headers String - The custom HTTP headers for an Amplify app.
- custom
Rules List<AppCustom Rule> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - description String
- Description for an Amplify app.
- enable
Auto BooleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic BooleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch BooleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch BooleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables Map<String,String> - Environment variables map for an Amplify app.
- iam
Service StringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name String
- Name for an Amplify app.
- oauth
Token String - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform String
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - repository String
- Repository for an Amplify app.
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch string[]Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec string - The build specification (build spec) for an Amplify app.
- custom
Headers string - The custom HTTP headers for an Amplify app.
- custom
Rules AppCustom Rule[] - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - description string
- Description for an Amplify app.
- enable
Auto booleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic booleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch booleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch booleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables {[key: string]: string} - Environment variables map for an Amplify app.
- iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name string
- Name for an Amplify app.
- oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - repository string
- Repository for an Amplify app.
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- access_
token str - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- auto_
branch_ Appcreation_ config Auto Branch Creation Config Args - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto_
branch_ Sequence[str]creation_ patterns - Automated branch creation glob patterns for an Amplify app.
- basic_
auth_ strcredentials - Credentials for basic authorization for an Amplify app.
- build_
spec str - The build specification (build spec) for an Amplify app.
- custom_
headers str - The custom HTTP headers for an Amplify app.
- custom_
rules Sequence[AppCustom Rule Args] - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - description str
- Description for an Amplify app.
- enable_
auto_ boolbranch_ creation - Enables automated branch creation for an Amplify app.
- enable_
basic_ boolauth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable_
branch_ boolauto_ build - Enables auto-building of branches for the Amplify App.
- enable_
branch_ boolauto_ deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment_
variables Mapping[str, str] - Environment variables map for an Amplify app.
- iam_
service_ strrole_ arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name str
- Name for an Amplify app.
- oauth_
token str - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform str
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - repository str
- Repository for an Amplify app.
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- access
Token String - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- auto
Branch Property MapCreation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch List<String>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth StringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec String - The build specification (build spec) for an Amplify app.
- custom
Headers String - The custom HTTP headers for an Amplify app.
- custom
Rules List<Property Map> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - description String
- Description for an Amplify app.
- enable
Auto BooleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic BooleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch BooleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch BooleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables Map<String> - Environment variables map for an Amplify app.
- iam
Service StringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name String
- Name for an Amplify app.
- oauth
Token String - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform String
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - repository String
- Repository for an Amplify app.
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
- Arn string
- ARN of the Amplify app.
- Default
Domain string - Default domain for the Amplify app.
- Id string
- The provider-assigned unique ID for this managed resource.
- Production
Branches List<AppProduction Branch> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- ARN of the Amplify app.
- Default
Domain string - Default domain for the Amplify app.
- Id string
- The provider-assigned unique ID for this managed resource.
- Production
Branches []AppProduction Branch - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- ARN of the Amplify app.
- default
Domain String - Default domain for the Amplify app.
- id String
- The provider-assigned unique ID for this managed resource.
- production
Branches List<AppProduction Branch> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- ARN of the Amplify app.
- default
Domain string - Default domain for the Amplify app.
- id string
- The provider-assigned unique ID for this managed resource.
- production
Branches AppProduction Branch[] - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- ARN of the Amplify app.
- default_
domain str - Default domain for the Amplify app.
- id str
- The provider-assigned unique ID for this managed resource.
- production_
branches Sequence[AppProduction Branch] - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- ARN of the Amplify app.
- default
Domain String - Default domain for the Amplify app.
- id String
- The provider-assigned unique ID for this managed resource.
- production
Branches List<Property Map> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing App Resource
Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_token: Optional[str] = None,
arn: Optional[str] = None,
auto_branch_creation_config: Optional[AppAutoBranchCreationConfigArgs] = None,
auto_branch_creation_patterns: Optional[Sequence[str]] = None,
basic_auth_credentials: Optional[str] = None,
build_spec: Optional[str] = None,
custom_headers: Optional[str] = None,
custom_rules: Optional[Sequence[AppCustomRuleArgs]] = None,
default_domain: Optional[str] = None,
description: Optional[str] = None,
enable_auto_branch_creation: Optional[bool] = None,
enable_basic_auth: Optional[bool] = None,
enable_branch_auto_build: Optional[bool] = None,
enable_branch_auto_deletion: Optional[bool] = None,
environment_variables: Optional[Mapping[str, str]] = None,
iam_service_role_arn: Optional[str] = None,
name: Optional[str] = None,
oauth_token: Optional[str] = None,
platform: Optional[str] = None,
production_branches: Optional[Sequence[AppProductionBranchArgs]] = None,
repository: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState 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.
- Access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- Arn string
- ARN of the Amplify app.
- Auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - Auto
Branch List<string>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- Basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- Build
Spec string - The build specification (build spec) for an Amplify app.
- Custom
Headers string - The custom HTTP headers for an Amplify app.
- Custom
Rules List<AppCustom Rule> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - Default
Domain string - Default domain for the Amplify app.
- Description string
- Description for an Amplify app.
- Enable
Auto boolBranch Creation - Enables automated branch creation for an Amplify app.
- Enable
Basic boolAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- Enable
Branch boolAuto Build - Enables auto-building of branches for the Amplify App.
- Enable
Branch boolAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- Environment
Variables Dictionary<string, string> - Environment variables map for an Amplify app.
- Iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- Name string
- Name for an Amplify app.
- Oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- Platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - Production
Branches List<AppProduction Branch> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Repository string
- Repository for an Amplify app.
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- Arn string
- ARN of the Amplify app.
- Auto
Branch AppCreation Config Auto Branch Creation Config Args - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - Auto
Branch []stringCreation Patterns - Automated branch creation glob patterns for an Amplify app.
- Basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- Build
Spec string - The build specification (build spec) for an Amplify app.
- Custom
Headers string - The custom HTTP headers for an Amplify app.
- Custom
Rules []AppCustom Rule Args - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - Default
Domain string - Default domain for the Amplify app.
- Description string
- Description for an Amplify app.
- Enable
Auto boolBranch Creation - Enables automated branch creation for an Amplify app.
- Enable
Basic boolAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- Enable
Branch boolAuto Build - Enables auto-building of branches for the Amplify App.
- Enable
Branch boolAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- Environment
Variables map[string]string - Environment variables map for an Amplify app.
- Iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- Name string
- Name for an Amplify app.
- Oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- Platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - Production
Branches []AppProduction Branch Args - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - Repository string
- Repository for an Amplify app.
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- access
Token String - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- arn String
- ARN of the Amplify app.
- auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch List<String>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth StringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec String - The build specification (build spec) for an Amplify app.
- custom
Headers String - The custom HTTP headers for an Amplify app.
- custom
Rules List<AppCustom Rule> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - default
Domain String - Default domain for the Amplify app.
- description String
- Description for an Amplify app.
- enable
Auto BooleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic BooleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch BooleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch BooleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables Map<String,String> - Environment variables map for an Amplify app.
- iam
Service StringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name String
- Name for an Amplify app.
- oauth
Token String - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform String
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - production
Branches List<AppProduction Branch> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - repository String
- Repository for an Amplify app.
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- access
Token string - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- arn string
- ARN of the Amplify app.
- auto
Branch AppCreation Config Auto Branch Creation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch string[]Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth stringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec string - The build specification (build spec) for an Amplify app.
- custom
Headers string - The custom HTTP headers for an Amplify app.
- custom
Rules AppCustom Rule[] - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - default
Domain string - Default domain for the Amplify app.
- description string
- Description for an Amplify app.
- enable
Auto booleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic booleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch booleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch booleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables {[key: string]: string} - Environment variables map for an Amplify app.
- iam
Service stringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name string
- Name for an Amplify app.
- oauth
Token string - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform string
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - production
Branches AppProduction Branch[] - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - repository string
- Repository for an Amplify app.
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- access_
token str - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- arn str
- ARN of the Amplify app.
- auto_
branch_ Appcreation_ config Auto Branch Creation Config Args - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto_
branch_ Sequence[str]creation_ patterns - Automated branch creation glob patterns for an Amplify app.
- basic_
auth_ strcredentials - Credentials for basic authorization for an Amplify app.
- build_
spec str - The build specification (build spec) for an Amplify app.
- custom_
headers str - The custom HTTP headers for an Amplify app.
- custom_
rules Sequence[AppCustom Rule Args] - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - default_
domain str - Default domain for the Amplify app.
- description str
- Description for an Amplify app.
- enable_
auto_ boolbranch_ creation - Enables automated branch creation for an Amplify app.
- enable_
basic_ boolauth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable_
branch_ boolauto_ build - Enables auto-building of branches for the Amplify App.
- enable_
branch_ boolauto_ deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment_
variables Mapping[str, str] - Environment variables map for an Amplify app.
- iam_
service_ strrole_ arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name str
- Name for an Amplify app.
- oauth_
token str - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform str
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - production_
branches Sequence[AppProduction Branch Args] - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - repository str
- Repository for an Amplify app.
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- access
Token String - Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
- arn String
- ARN of the Amplify app.
- auto
Branch Property MapCreation Config - Automated branch creation configuration for an Amplify app. An
auto_branch_creation_config
block is documented below. - auto
Branch List<String>Creation Patterns - Automated branch creation glob patterns for an Amplify app.
- basic
Auth StringCredentials - Credentials for basic authorization for an Amplify app.
- build
Spec String - The build specification (build spec) for an Amplify app.
- custom
Headers String - The custom HTTP headers for an Amplify app.
- custom
Rules List<Property Map> - Custom rewrite and redirect rules for an Amplify app. A
custom_rule
block is documented below. - default
Domain String - Default domain for the Amplify app.
- description String
- Description for an Amplify app.
- enable
Auto BooleanBranch Creation - Enables automated branch creation for an Amplify app.
- enable
Basic BooleanAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- enable
Branch BooleanAuto Build - Enables auto-building of branches for the Amplify App.
- enable
Branch BooleanAuto Deletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
- environment
Variables Map<String> - Environment variables map for an Amplify app.
- iam
Service StringRole Arn - AWS Identity and Access Management (IAM) service role for an Amplify app.
- name String
- Name for an Amplify app.
- oauth
Token String - OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
- platform String
- Platform or framework for an Amplify app. Valid values:
WEB
,WEB_COMPUTE
. Default value:WEB
. - production
Branches List<Property Map> - Describes the information about a production branch for an Amplify app. A
production_branch
block is documented below. - repository String
- Repository for an Amplify app.
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
AppAutoBranchCreationConfig, AppAutoBranchCreationConfigArgs
- Basic
Auth stringCredentials - Basic authorization credentials for the autocreated branch.
- Build
Spec string - Build specification (build spec) for the autocreated branch.
- Enable
Auto boolBuild - Enables auto building for the autocreated branch.
- Enable
Basic boolAuth - Enables basic authorization for the autocreated branch.
- Enable
Performance boolMode - Enables performance mode for the branch.
- Enable
Pull boolRequest Preview - Enables pull request previews for the autocreated branch.
- Environment
Variables Dictionary<string, string> - Environment variables for the autocreated branch.
- Framework string
- Framework for the autocreated branch.
- Pull
Request stringEnvironment Name - Amplify environment name for the pull request.
- Stage string
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
- Basic
Auth stringCredentials - Basic authorization credentials for the autocreated branch.
- Build
Spec string - Build specification (build spec) for the autocreated branch.
- Enable
Auto boolBuild - Enables auto building for the autocreated branch.
- Enable
Basic boolAuth - Enables basic authorization for the autocreated branch.
- Enable
Performance boolMode - Enables performance mode for the branch.
- Enable
Pull boolRequest Preview - Enables pull request previews for the autocreated branch.
- Environment
Variables map[string]string - Environment variables for the autocreated branch.
- Framework string
- Framework for the autocreated branch.
- Pull
Request stringEnvironment Name - Amplify environment name for the pull request.
- Stage string
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
- basic
Auth StringCredentials - Basic authorization credentials for the autocreated branch.
- build
Spec String - Build specification (build spec) for the autocreated branch.
- enable
Auto BooleanBuild - Enables auto building for the autocreated branch.
- enable
Basic BooleanAuth - Enables basic authorization for the autocreated branch.
- enable
Performance BooleanMode - Enables performance mode for the branch.
- enable
Pull BooleanRequest Preview - Enables pull request previews for the autocreated branch.
- environment
Variables Map<String,String> - Environment variables for the autocreated branch.
- framework String
- Framework for the autocreated branch.
- pull
Request StringEnvironment Name - Amplify environment name for the pull request.
- stage String
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
- basic
Auth stringCredentials - Basic authorization credentials for the autocreated branch.
- build
Spec string - Build specification (build spec) for the autocreated branch.
- enable
Auto booleanBuild - Enables auto building for the autocreated branch.
- enable
Basic booleanAuth - Enables basic authorization for the autocreated branch.
- enable
Performance booleanMode - Enables performance mode for the branch.
- enable
Pull booleanRequest Preview - Enables pull request previews for the autocreated branch.
- environment
Variables {[key: string]: string} - Environment variables for the autocreated branch.
- framework string
- Framework for the autocreated branch.
- pull
Request stringEnvironment Name - Amplify environment name for the pull request.
- stage string
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
- basic_
auth_ strcredentials - Basic authorization credentials for the autocreated branch.
- build_
spec str - Build specification (build spec) for the autocreated branch.
- enable_
auto_ boolbuild - Enables auto building for the autocreated branch.
- enable_
basic_ boolauth - Enables basic authorization for the autocreated branch.
- enable_
performance_ boolmode - Enables performance mode for the branch.
- enable_
pull_ boolrequest_ preview - Enables pull request previews for the autocreated branch.
- environment_
variables Mapping[str, str] - Environment variables for the autocreated branch.
- framework str
- Framework for the autocreated branch.
- pull_
request_ strenvironment_ name - Amplify environment name for the pull request.
- stage str
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
- basic
Auth StringCredentials - Basic authorization credentials for the autocreated branch.
- build
Spec String - Build specification (build spec) for the autocreated branch.
- enable
Auto BooleanBuild - Enables auto building for the autocreated branch.
- enable
Basic BooleanAuth - Enables basic authorization for the autocreated branch.
- enable
Performance BooleanMode - Enables performance mode for the branch.
- enable
Pull BooleanRequest Preview - Enables pull request previews for the autocreated branch.
- environment
Variables Map<String> - Environment variables for the autocreated branch.
- framework String
- Framework for the autocreated branch.
- pull
Request StringEnvironment Name - Amplify environment name for the pull request.
- stage String
- Describes the current stage for the autocreated branch. Valid values:
PRODUCTION
,BETA
,DEVELOPMENT
,EXPERIMENTAL
,PULL_REQUEST
.
AppCustomRule, AppCustomRuleArgs
- Source string
- Source pattern for a URL rewrite or redirect rule.
- Target string
- Target pattern for a URL rewrite or redirect rule.
- Condition string
- Condition for a URL rewrite or redirect rule, such as a country code.
- Status string
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
- Source string
- Source pattern for a URL rewrite or redirect rule.
- Target string
- Target pattern for a URL rewrite or redirect rule.
- Condition string
- Condition for a URL rewrite or redirect rule, such as a country code.
- Status string
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
- source String
- Source pattern for a URL rewrite or redirect rule.
- target String
- Target pattern for a URL rewrite or redirect rule.
- condition String
- Condition for a URL rewrite or redirect rule, such as a country code.
- status String
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
- source string
- Source pattern for a URL rewrite or redirect rule.
- target string
- Target pattern for a URL rewrite or redirect rule.
- condition string
- Condition for a URL rewrite or redirect rule, such as a country code.
- status string
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
- source str
- Source pattern for a URL rewrite or redirect rule.
- target str
- Target pattern for a URL rewrite or redirect rule.
- condition str
- Condition for a URL rewrite or redirect rule, such as a country code.
- status str
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
- source String
- Source pattern for a URL rewrite or redirect rule.
- target String
- Target pattern for a URL rewrite or redirect rule.
- condition String
- Condition for a URL rewrite or redirect rule, such as a country code.
- status String
- Status code for a URL rewrite or redirect rule. Valid values:
200
,301
,302
,404
,404-200
.
AppProductionBranch, AppProductionBranchArgs
- Branch
Name string - Branch name for the production branch.
- Last
Deploy stringTime - Last deploy time of the production branch.
- Status string
- Status of the production branch.
- Thumbnail
Url string - Thumbnail URL for the production branch.
- Branch
Name string - Branch name for the production branch.
- Last
Deploy stringTime - Last deploy time of the production branch.
- Status string
- Status of the production branch.
- Thumbnail
Url string - Thumbnail URL for the production branch.
- branch
Name String - Branch name for the production branch.
- last
Deploy StringTime - Last deploy time of the production branch.
- status String
- Status of the production branch.
- thumbnail
Url String - Thumbnail URL for the production branch.
- branch
Name string - Branch name for the production branch.
- last
Deploy stringTime - Last deploy time of the production branch.
- status string
- Status of the production branch.
- thumbnail
Url string - Thumbnail URL for the production branch.
- branch_
name str - Branch name for the production branch.
- last_
deploy_ strtime - Last deploy time of the production branch.
- status str
- Status of the production branch.
- thumbnail_
url str - Thumbnail URL for the production branch.
- branch
Name String - Branch name for the production branch.
- last
Deploy StringTime - Last deploy time of the production branch.
- status String
- Status of the production branch.
- thumbnail
Url String - Thumbnail URL for the production branch.
Import
Using pulumi import
, import Amplify App using Amplify App ID (appId). For example:
$ pulumi import aws:amplify/app:App example d2ypk4k47z8u6
App ID can be obtained from App ARN (e.g., arn:aws:amplify:us-east-1:12345678:apps/d2ypk4k47z8u6
).
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.