We recommend new projects start with resources from the AWS provider.
aws-native.amplify.App
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
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,
        basic_auth_config: Optional[AppBasicAuthConfigArgs] = None,
        build_spec: Optional[str] = None,
        cache_config: Optional[AppCacheConfigArgs] = None,
        compute_role_arn: Optional[str] = None,
        custom_headers: Optional[str] = None,
        custom_rules: Optional[Sequence[AppCustomRuleArgs]] = None,
        description: Optional[str] = None,
        enable_branch_auto_deletion: Optional[bool] = None,
        environment_variables: Optional[Sequence[AppEnvironmentVariableArgs]] = None,
        iam_service_role: Optional[str] = None,
        name: Optional[str] = None,
        oauth_token: Optional[str] = None,
        platform: Optional[AppPlatform] = None,
        repository: Optional[str] = None,
        tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The App resource accepts the following input properties:
- AccessToken string
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- AutoBranch Pulumi.Creation Config Aws Native. Amplify. Inputs. App Auto Branch Creation Config 
- Sets the configuration for your automatic branch creation.
- BasicAuth Pulumi.Config Aws Native. Amplify. Inputs. App Basic Auth Config 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- BuildSpec string
- The build specification (build spec) for an Amplify app.
- CacheConfig Pulumi.Aws Native. Amplify. Inputs. App Cache Config 
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- ComputeRole stringArn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- CustomHeaders string
- The custom HTTP headers for an Amplify app.
- CustomRules List<Pulumi.Aws Native. Amplify. Inputs. App Custom Rule> 
- The custom rewrite and redirect rules for an Amplify app.
- Description string
- The description of the Amplify app.
- EnableBranch boolAuto Deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- EnvironmentVariables List<Pulumi.Aws Native. Amplify. Inputs. App Environment Variable> 
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- IamService stringRole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- Name string
- The name of the Amplify app.
- OauthToken string
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- Platform
Pulumi.Aws Native. Amplify. App Platform 
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- Repository string
- The Git repository for the Amplify app.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- The tag for an Amplify app.
- AccessToken string
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- AutoBranch AppCreation Config Auto Branch Creation Config Args 
- Sets the configuration for your automatic branch creation.
- BasicAuth AppConfig Basic Auth Config Args 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- BuildSpec string
- The build specification (build spec) for an Amplify app.
- CacheConfig AppCache Config Args 
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- ComputeRole stringArn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- CustomHeaders string
- The custom HTTP headers for an Amplify app.
- CustomRules []AppCustom Rule Args 
- The custom rewrite and redirect rules for an Amplify app.
- Description string
- The description of the Amplify app.
- EnableBranch boolAuto Deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- EnvironmentVariables []AppEnvironment Variable Args 
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- IamService stringRole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- Name string
- The name of the Amplify app.
- OauthToken string
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- Platform
AppPlatform 
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- Repository string
- The Git repository for the Amplify app.
- 
TagArgs 
- The tag for an Amplify app.
- accessToken String
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- autoBranch AppCreation Config Auto Branch Creation Config 
- Sets the configuration for your automatic branch creation.
- basicAuth AppConfig Basic Auth Config 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- buildSpec String
- The build specification (build spec) for an Amplify app.
- cacheConfig AppCache Config 
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- computeRole StringArn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- customHeaders String
- The custom HTTP headers for an Amplify app.
- customRules List<AppCustom Rule> 
- The custom rewrite and redirect rules for an Amplify app.
- description String
- The description of the Amplify app.
- enableBranch BooleanAuto Deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- environmentVariables List<AppEnvironment Variable> 
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- iamService StringRole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- name String
- The name of the Amplify app.
- oauthToken String
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- platform
AppPlatform 
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- repository String
- The Git repository for the Amplify app.
- List<Tag>
- The tag for an Amplify app.
- accessToken string
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- autoBranch AppCreation Config Auto Branch Creation Config 
- Sets the configuration for your automatic branch creation.
- basicAuth AppConfig Basic Auth Config 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- buildSpec string
- The build specification (build spec) for an Amplify app.
- cacheConfig AppCache Config 
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- computeRole stringArn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- customHeaders string
- The custom HTTP headers for an Amplify app.
- customRules AppCustom Rule[] 
- The custom rewrite and redirect rules for an Amplify app.
- description string
- The description of the Amplify app.
- enableBranch booleanAuto Deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- environmentVariables AppEnvironment Variable[] 
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- iamService stringRole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- name string
- The name of the Amplify app.
- oauthToken string
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- platform
AppPlatform 
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- repository string
- The Git repository for the Amplify app.
- Tag[]
- The tag for an Amplify app.
- access_token str
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- auto_branch_ Appcreation_ config Auto Branch Creation Config Args 
- Sets the configuration for your automatic branch creation.
- basic_auth_ Appconfig Basic Auth Config Args 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- build_spec str
- The build specification (build spec) for an Amplify app.
- cache_config AppCache Config Args 
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- compute_role_ strarn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- custom_headers str
- The custom HTTP headers for an Amplify app.
- custom_rules Sequence[AppCustom Rule Args] 
- The custom rewrite and redirect rules for an Amplify app.
- description str
- The description of the Amplify app.
- enable_branch_ boolauto_ deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- environment_variables Sequence[AppEnvironment Variable Args] 
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- iam_service_ strrole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- name str
- The name of the Amplify app.
- oauth_token str
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- platform
AppPlatform 
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- repository str
- The Git repository for the Amplify app.
- 
Sequence[TagArgs] 
- The tag for an Amplify app.
- accessToken String
- The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. - Use - AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use- OauthToken.- You must specify either - AccessTokenor- OauthTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- autoBranch Property MapCreation Config 
- Sets the configuration for your automatic branch creation.
- basicAuth Property MapConfig 
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
- buildSpec String
- The build specification (build spec) for an Amplify app.
- cacheConfig Property Map
- The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the defaultAMPLIFY_MANAGEDsetting.
- computeRole StringArn 
- The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
- customHeaders String
- The custom HTTP headers for an Amplify app.
- customRules List<Property Map>
- The custom rewrite and redirect rules for an Amplify app.
- description String
- The description of the Amplify app.
- enableBranch BooleanAuto Deletion 
- Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- environmentVariables List<Property Map>
- The environment variables for the Amplify app. - For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide . 
- iamService StringRole 
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
- name String
- The name of the Amplify app.
- oauthToken String
- The 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 using SSH cloning. The OAuth token is not stored. - Use - OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use- AccessToken.- You must specify either - OauthTokenor- AccessTokenwhen you create a new app.- Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . 
- platform "WEB" | "WEB_DYNAMIC" | "WEB_COMPUTE"
- The platform for the Amplify app. For a static app, set the platform type to - WEB. For a dynamic server-side rendered (SSR) app, set the platform type to- WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to- WEB_DYNAMIC.- If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to - WEB_COMPUTEand set the artifacts- baseDirectoryto- .nextin the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .
- repository String
- The Git repository for the Amplify app.
- List<Property Map>
- The tag for an Amplify app.
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
- AppId string
- Unique Id for the Amplify App.
- AppName string
- Name for the Amplify App.
- Arn string
- ARN for the Amplify App.
- DefaultDomain string
- Default domain for the Amplify App.
- Id string
- The provider-assigned unique ID for this managed resource.
- AppId string
- Unique Id for the Amplify App.
- AppName string
- Name for the Amplify App.
- Arn string
- ARN for the Amplify App.
- DefaultDomain string
- Default domain for the Amplify App.
- Id string
- The provider-assigned unique ID for this managed resource.
- appId String
- Unique Id for the Amplify App.
- appName String
- Name for the Amplify App.
- arn String
- ARN for the Amplify App.
- defaultDomain String
- Default domain for the Amplify App.
- id String
- The provider-assigned unique ID for this managed resource.
- appId string
- Unique Id for the Amplify App.
- appName string
- Name for the Amplify App.
- arn string
- ARN for the Amplify App.
- defaultDomain string
- Default domain for the Amplify App.
- id string
- The provider-assigned unique ID for this managed resource.
- app_id str
- Unique Id for the Amplify App.
- app_name str
- Name for the Amplify App.
- arn str
- ARN for the Amplify App.
- default_domain str
- Default domain for the Amplify App.
- id str
- The provider-assigned unique ID for this managed resource.
- appId String
- Unique Id for the Amplify App.
- appName String
- Name for the Amplify App.
- arn String
- ARN for the Amplify App.
- defaultDomain String
- Default domain for the Amplify App.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AppAutoBranchCreationConfig, AppAutoBranchCreationConfigArgs          
- AutoBranch List<string>Creation Patterns 
- Automated branch creation glob patterns for the Amplify app.
- BasicAuth Pulumi.Config Aws Native. Amplify. Inputs. App Basic Auth Config 
- Sets password protection for your auto created branch.
- BuildSpec string
- The build specification (build spec) for the autocreated branch.
- EnableAuto boolBranch Creation 
- Enables automated branch creation for the Amplify app.
- EnableAuto boolBuild 
- Enables auto building for the auto created branch.
- EnablePerformance boolMode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- EnablePull boolRequest Preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- EnvironmentVariables List<Pulumi.Aws Native. Amplify. Inputs. App Environment Variable> 
- The environment variables for the autocreated branch.
- Framework string
- The framework for the autocreated branch.
- PullRequest stringEnvironment Name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- Stage
Pulumi.Aws Native. Amplify. App Auto Branch Creation Config Stage 
- Stage for the auto created branch.
- AutoBranch []stringCreation Patterns 
- Automated branch creation glob patterns for the Amplify app.
- BasicAuth AppConfig Basic Auth Config 
- Sets password protection for your auto created branch.
- BuildSpec string
- The build specification (build spec) for the autocreated branch.
- EnableAuto boolBranch Creation 
- Enables automated branch creation for the Amplify app.
- EnableAuto boolBuild 
- Enables auto building for the auto created branch.
- EnablePerformance boolMode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- EnablePull boolRequest Preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- EnvironmentVariables []AppEnvironment Variable 
- The environment variables for the autocreated branch.
- Framework string
- The framework for the autocreated branch.
- PullRequest stringEnvironment Name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- Stage
AppAuto Branch Creation Config Stage 
- Stage for the auto created branch.
- autoBranch List<String>Creation Patterns 
- Automated branch creation glob patterns for the Amplify app.
- basicAuth AppConfig Basic Auth Config 
- Sets password protection for your auto created branch.
- buildSpec String
- The build specification (build spec) for the autocreated branch.
- enableAuto BooleanBranch Creation 
- Enables automated branch creation for the Amplify app.
- enableAuto BooleanBuild 
- Enables auto building for the auto created branch.
- enablePerformance BooleanMode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- enablePull BooleanRequest Preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- environmentVariables List<AppEnvironment Variable> 
- The environment variables for the autocreated branch.
- framework String
- The framework for the autocreated branch.
- pullRequest StringEnvironment Name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- stage
AppAuto Branch Creation Config Stage 
- Stage for the auto created branch.
- autoBranch string[]Creation Patterns 
- Automated branch creation glob patterns for the Amplify app.
- basicAuth AppConfig Basic Auth Config 
- Sets password protection for your auto created branch.
- buildSpec string
- The build specification (build spec) for the autocreated branch.
- enableAuto booleanBranch Creation 
- Enables automated branch creation for the Amplify app.
- enableAuto booleanBuild 
- Enables auto building for the auto created branch.
- enablePerformance booleanMode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- enablePull booleanRequest Preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- environmentVariables AppEnvironment Variable[] 
- The environment variables for the autocreated branch.
- framework string
- The framework for the autocreated branch.
- pullRequest stringEnvironment Name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- stage
AppAuto Branch Creation Config Stage 
- Stage for the auto created branch.
- auto_branch_ Sequence[str]creation_ patterns 
- Automated branch creation glob patterns for the Amplify app.
- basic_auth_ Appconfig Basic Auth Config 
- Sets password protection for your auto created branch.
- build_spec str
- The build specification (build spec) for the autocreated branch.
- enable_auto_ boolbranch_ creation 
- Enables automated branch creation for the Amplify app.
- enable_auto_ boolbuild 
- Enables auto building for the auto created branch.
- enable_performance_ boolmode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- enable_pull_ boolrequest_ preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- environment_variables Sequence[AppEnvironment Variable] 
- The environment variables for the autocreated branch.
- framework str
- The framework for the autocreated branch.
- pull_request_ strenvironment_ name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- stage
AppAuto Branch Creation Config Stage 
- Stage for the auto created branch.
- autoBranch List<String>Creation Patterns 
- Automated branch creation glob patterns for the Amplify app.
- basicAuth Property MapConfig 
- Sets password protection for your auto created branch.
- buildSpec String
- The build specification (build spec) for the autocreated branch.
- enableAuto BooleanBranch Creation 
- Enables automated branch creation for the Amplify app.
- enableAuto BooleanBuild 
- Enables auto building for the auto created branch.
- enablePerformance BooleanMode 
- Enables performance mode for the branch. - Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 
- enablePull BooleanRequest Preview 
- Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. - To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the - PullRequestEnvironmentNameproperty.- For more information, see Web Previews in the AWS Amplify Hosting User Guide . 
- environmentVariables List<Property Map>
- The environment variables for the autocreated branch.
- framework String
- The framework for the autocreated branch.
- pullRequest StringEnvironment Name 
- If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named - prod,- test, or- devthat you initialized with the Amplify CLI.- To enable pull request previews, set the - EnablePullRequestPreviewproperty to- true.- If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. - For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . 
- stage "EXPERIMENTAL" | "BETA" | "PULL_REQUEST" | "PRODUCTION" | "DEVELOPMENT"
- Stage for the auto created branch.
AppAutoBranchCreationConfigStage, AppAutoBranchCreationConfigStageArgs            
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- PullRequest 
- PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- AppAuto Branch Creation Config Stage Experimental 
- EXPERIMENTAL
- AppAuto Branch Creation Config Stage Beta 
- BETA
- AppAuto Branch Creation Config Stage Pull Request 
- PULL_REQUEST
- AppAuto Branch Creation Config Stage Production 
- PRODUCTION
- AppAuto Branch Creation Config Stage Development 
- DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- PullRequest 
- PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- PullRequest 
- PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- EXPERIMENTAL
- EXPERIMENTAL
- BETA
- BETA
- PULL_REQUEST
- PULL_REQUEST
- PRODUCTION
- PRODUCTION
- DEVELOPMENT
- DEVELOPMENT
- "EXPERIMENTAL"
- EXPERIMENTAL
- "BETA"
- BETA
- "PULL_REQUEST"
- PULL_REQUEST
- "PRODUCTION"
- PRODUCTION
- "DEVELOPMENT"
- DEVELOPMENT
AppBasicAuthConfig, AppBasicAuthConfigArgs        
- EnableBasic boolAuth 
- Enables basic authorization for the Amplify app's branches.
- Password string
- The password for basic authorization.
- Username string
- The user name for basic authorization.
- EnableBasic boolAuth 
- Enables basic authorization for the Amplify app's branches.
- Password string
- The password for basic authorization.
- Username string
- The user name for basic authorization.
- enableBasic BooleanAuth 
- Enables basic authorization for the Amplify app's branches.
- password String
- The password for basic authorization.
- username String
- The user name for basic authorization.
- enableBasic booleanAuth 
- Enables basic authorization for the Amplify app's branches.
- password string
- The password for basic authorization.
- username string
- The user name for basic authorization.
- enable_basic_ boolauth 
- Enables basic authorization for the Amplify app's branches.
- password str
- The password for basic authorization.
- username str
- The user name for basic authorization.
- enableBasic BooleanAuth 
- Enables basic authorization for the Amplify app's branches.
- password String
- The password for basic authorization.
- username String
- The user name for basic authorization.
AppCacheConfig, AppCacheConfigArgs      
- Type
Pulumi.Aws Native. Amplify. App Cache Config Type 
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
- Type
AppCache Config Type 
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
- type
AppCache Config Type 
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
- type
AppCache Config Type 
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
- type
AppCache Config Type 
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
- type "AMPLIFY_MANAGED" | "AMPLIFY_MANAGED_NO_COOKIES"
- The type of cache configuration to use for an Amplify app. - The - AMPLIFY_MANAGEDcache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.- The - AMPLIFY_MANAGED_NO_COOKIEScache configuration type is the same as- AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
AppCacheConfigType, AppCacheConfigTypeArgs        
- AmplifyManaged 
- AMPLIFY_MANAGED
- AmplifyManaged No Cookies 
- AMPLIFY_MANAGED_NO_COOKIES
- AppCache Config Type Amplify Managed 
- AMPLIFY_MANAGED
- AppCache Config Type Amplify Managed No Cookies 
- AMPLIFY_MANAGED_NO_COOKIES
- AmplifyManaged 
- AMPLIFY_MANAGED
- AmplifyManaged No Cookies 
- AMPLIFY_MANAGED_NO_COOKIES
- AmplifyManaged 
- AMPLIFY_MANAGED
- AmplifyManaged No Cookies 
- AMPLIFY_MANAGED_NO_COOKIES
- AMPLIFY_MANAGED
- AMPLIFY_MANAGED
- AMPLIFY_MANAGED_NO_COOKIES
- AMPLIFY_MANAGED_NO_COOKIES
- "AMPLIFY_MANAGED"
- AMPLIFY_MANAGED
- "AMPLIFY_MANAGED_NO_COOKIES"
- AMPLIFY_MANAGED_NO_COOKIES
AppCustomRule, AppCustomRuleArgs      
- Source string
- The source pattern for a URL rewrite or redirect rule.
- Target string
- The target pattern for a URL rewrite or redirect rule.
- Condition string
- The condition for a URL rewrite or redirect rule, such as a country code.
- Status string
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
- Source string
- The source pattern for a URL rewrite or redirect rule.
- Target string
- The target pattern for a URL rewrite or redirect rule.
- Condition string
- The condition for a URL rewrite or redirect rule, such as a country code.
- Status string
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
- source String
- The source pattern for a URL rewrite or redirect rule.
- target String
- The target pattern for a URL rewrite or redirect rule.
- condition String
- The condition for a URL rewrite or redirect rule, such as a country code.
- status String
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
- source string
- The source pattern for a URL rewrite or redirect rule.
- target string
- The target pattern for a URL rewrite or redirect rule.
- condition string
- The condition for a URL rewrite or redirect rule, such as a country code.
- status string
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
- source str
- The source pattern for a URL rewrite or redirect rule.
- target str
- The target pattern for a URL rewrite or redirect rule.
- condition str
- The condition for a URL rewrite or redirect rule, such as a country code.
- status str
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
- source String
- The source pattern for a URL rewrite or redirect rule.
- target String
- The target pattern for a URL rewrite or redirect rule.
- condition String
- The condition for a URL rewrite or redirect rule, such as a country code.
- status String
- The status code for a URL rewrite or redirect rule.- 200 - Represents a 200 rewrite rule.
- 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
- 302 - Represents a 302 temporary redirect rule.
- 404 - Represents a 404 redirect rule.
- 404-200 - Represents a 404 rewrite rule.
 
AppEnvironmentVariable, AppEnvironmentVariableArgs      
AppPlatform, AppPlatformArgs    
- Web
- WEB
- WebDynamic 
- WEB_DYNAMIC
- WebCompute 
- WEB_COMPUTE
- AppPlatform Web 
- WEB
- AppPlatform Web Dynamic 
- WEB_DYNAMIC
- AppPlatform Web Compute 
- WEB_COMPUTE
- Web
- WEB
- WebDynamic 
- WEB_DYNAMIC
- WebCompute 
- WEB_COMPUTE
- Web
- WEB
- WebDynamic 
- WEB_DYNAMIC
- WebCompute 
- WEB_COMPUTE
- WEB
- WEB
- WEB_DYNAMIC
- WEB_DYNAMIC
- WEB_COMPUTE
- WEB_COMPUTE
- "WEB"
- WEB
- "WEB_DYNAMIC"
- WEB_DYNAMIC
- "WEB_COMPUTE"
- WEB_COMPUTE
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.