1. Packages
  2. AWS Native
  3. API Docs
  4. amplify
  5. App

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.amplify.App

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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,
            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)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const appResource = new aws_native.amplify.App("appResource", {
        accessToken: "string",
        autoBranchCreationConfig: {
            autoBranchCreationPatterns: ["string"],
            basicAuthConfig: {
                enableBasicAuth: false,
                password: "string",
                username: "string",
            },
            buildSpec: "string",
            enableAutoBranchCreation: false,
            enableAutoBuild: false,
            enablePerformanceMode: false,
            enablePullRequestPreview: false,
            environmentVariables: [{
                name: "string",
                value: "string",
            }],
            framework: "string",
            pullRequestEnvironmentName: "string",
            stage: aws_native.amplify.AppAutoBranchCreationConfigStage.Experimental,
        },
        basicAuthConfig: {
            enableBasicAuth: false,
            password: "string",
            username: "string",
        },
        buildSpec: "string",
        customHeaders: "string",
        customRules: [{
            source: "string",
            target: "string",
            condition: "string",
            status: "string",
        }],
        description: "string",
        enableBranchAutoDeletion: false,
        environmentVariables: [{
            name: "string",
            value: "string",
        }],
        iamServiceRole: "string",
        name: "string",
        oauthToken: "string",
        platform: aws_native.amplify.AppPlatform.Web,
        repository: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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:

    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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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 .

    AutoBranchCreationConfig Pulumi.AwsNative.Amplify.Inputs.AppAutoBranchCreationConfig
    Sets the configuration for your automatic branch creation.
    BasicAuthConfig Pulumi.AwsNative.Amplify.Inputs.AppBasicAuthConfig
    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.
    CustomHeaders string
    The custom HTTP headers for an Amplify app.
    CustomRules List<Pulumi.AwsNative.Amplify.Inputs.AppCustomRule>
    The custom rewrite and redirect rules for an Amplify app.
    Description string
    The description of the Amplify app.
    EnableBranchAutoDeletion bool
    Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
    EnvironmentVariables List<Pulumi.AwsNative.Amplify.Inputs.AppEnvironmentVariable>

    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 .

    IamServiceRole string
    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 OauthToken for 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 OauthToken or AccessToken when 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.AwsNative.Amplify.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 .
    Repository string
    The Git repository for the Amplify app.
    Tags List<Pulumi.AwsNative.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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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 .

    AutoBranchCreationConfig AppAutoBranchCreationConfigArgs
    Sets the configuration for your automatic branch creation.
    BasicAuthConfig AppBasicAuthConfigArgs
    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.
    CustomHeaders string
    The custom HTTP headers for an Amplify app.
    CustomRules []AppCustomRuleArgs
    The custom rewrite and redirect rules for an Amplify app.
    Description string
    The description of the Amplify app.
    EnableBranchAutoDeletion bool
    Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
    EnvironmentVariables []AppEnvironmentVariableArgs

    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 .

    IamServiceRole string
    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 OauthToken for 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 OauthToken or AccessToken when 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 .
    Repository string
    The Git repository for the Amplify app.
    Tags 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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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 .

    autoBranchCreationConfig AppAutoBranchCreationConfig
    Sets the configuration for your automatic branch creation.
    basicAuthConfig AppBasicAuthConfig
    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.
    customHeaders String
    The custom HTTP headers for an Amplify app.
    customRules List<AppCustomRule>
    The custom rewrite and redirect rules for an Amplify app.
    description String
    The description of the Amplify app.
    enableBranchAutoDeletion Boolean
    Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
    environmentVariables List<AppEnvironmentVariable>

    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 .

    iamServiceRole String
    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 OauthToken for 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 OauthToken or AccessToken when 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 .
    repository String
    The Git repository for the Amplify app.
    tags 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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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 .

    autoBranchCreationConfig AppAutoBranchCreationConfig
    Sets the configuration for your automatic branch creation.
    basicAuthConfig AppBasicAuthConfig
    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.
    customHeaders string
    The custom HTTP headers for an Amplify app.
    customRules AppCustomRule[]
    The custom rewrite and redirect rules for an Amplify app.
    description string
    The description of the Amplify app.
    enableBranchAutoDeletion boolean
    Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
    environmentVariables AppEnvironmentVariable[]

    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 .

    iamServiceRole string
    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 OauthToken for 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 OauthToken or AccessToken when 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 .
    repository string
    The Git repository for the Amplify app.
    tags 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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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_creation_config AppAutoBranchCreationConfigArgs
    Sets the configuration for your automatic branch creation.
    basic_auth_config AppBasicAuthConfigArgs
    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.
    custom_headers str
    The custom HTTP headers for an Amplify app.
    custom_rules Sequence[AppCustomRuleArgs]
    The custom rewrite and redirect rules for an Amplify app.
    description str
    The description of the Amplify app.
    enable_branch_auto_deletion bool
    Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
    environment_variables Sequence[AppEnvironmentVariableArgs]

    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_role str
    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 OauthToken for 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 OauthToken or AccessToken when 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 .
    repository str
    The Git repository for the Amplify app.
    tags 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 AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

    You must specify either AccessToken or OauthToken when 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 .

    autoBranchCreationConfig Property Map
    Sets the configuration for your automatic branch creation.
    basicAuthConfig Property Map
    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.
    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.
    enableBranchAutoDeletion Boolean
    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 .

    iamServiceRole String
    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 OauthToken for 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 OauthToken or AccessToken when 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 .
    repository String
    The Git repository for the Amplify app.
    tags 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

    AutoBranchCreationPatterns List<string>
    Automated branch creation glob patterns for the Amplify app.
    BasicAuthConfig Pulumi.AwsNative.Amplify.Inputs.AppBasicAuthConfig
    Sets password protection for your auto created branch.
    BuildSpec string
    The build specification (build spec) for the autocreated branch.
    EnableAutoBranchCreation bool
    Enables automated branch creation for the Amplify app.
    EnableAutoBuild bool
    Enables auto building for the auto created branch.
    EnablePerformanceMode bool

    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.

    EnablePullRequestPreview bool

    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 PullRequestEnvironmentName property.

    For more information, see Web Previews in the AWS Amplify Hosting User Guide .

    EnvironmentVariables List<Pulumi.AwsNative.Amplify.Inputs.AppEnvironmentVariable>
    The environment variables for the autocreated branch.
    Framework string
    The framework for the autocreated branch.
    PullRequestEnvironmentName string

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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.AwsNative.Amplify.AppAutoBranchCreationConfigStage
    Stage for the auto created branch.
    AutoBranchCreationPatterns []string
    Automated branch creation glob patterns for the Amplify app.
    BasicAuthConfig AppBasicAuthConfig
    Sets password protection for your auto created branch.
    BuildSpec string
    The build specification (build spec) for the autocreated branch.
    EnableAutoBranchCreation bool
    Enables automated branch creation for the Amplify app.
    EnableAutoBuild bool
    Enables auto building for the auto created branch.
    EnablePerformanceMode bool

    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.

    EnablePullRequestPreview bool

    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 PullRequestEnvironmentName property.

    For more information, see Web Previews in the AWS Amplify Hosting User Guide .

    EnvironmentVariables []AppEnvironmentVariable
    The environment variables for the autocreated branch.
    Framework string
    The framework for the autocreated branch.
    PullRequestEnvironmentName string

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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 AppAutoBranchCreationConfigStage
    Stage for the auto created branch.
    autoBranchCreationPatterns List<String>
    Automated branch creation glob patterns for the Amplify app.
    basicAuthConfig AppBasicAuthConfig
    Sets password protection for your auto created branch.
    buildSpec String
    The build specification (build spec) for the autocreated branch.
    enableAutoBranchCreation Boolean
    Enables automated branch creation for the Amplify app.
    enableAutoBuild Boolean
    Enables auto building for the auto created branch.
    enablePerformanceMode Boolean

    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.

    enablePullRequestPreview Boolean

    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 PullRequestEnvironmentName property.

    For more information, see Web Previews in the AWS Amplify Hosting User Guide .

    environmentVariables List<AppEnvironmentVariable>
    The environment variables for the autocreated branch.
    framework String
    The framework for the autocreated branch.
    pullRequestEnvironmentName String

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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 AppAutoBranchCreationConfigStage
    Stage for the auto created branch.
    autoBranchCreationPatterns string[]
    Automated branch creation glob patterns for the Amplify app.
    basicAuthConfig AppBasicAuthConfig
    Sets password protection for your auto created branch.
    buildSpec string
    The build specification (build spec) for the autocreated branch.
    enableAutoBranchCreation boolean
    Enables automated branch creation for the Amplify app.
    enableAutoBuild boolean
    Enables auto building for the auto created branch.
    enablePerformanceMode boolean

    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.

    enablePullRequestPreview boolean

    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 PullRequestEnvironmentName property.

    For more information, see Web Previews in the AWS Amplify Hosting User Guide .

    environmentVariables AppEnvironmentVariable[]
    The environment variables for the autocreated branch.
    framework string
    The framework for the autocreated branch.
    pullRequestEnvironmentName string

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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 AppAutoBranchCreationConfigStage
    Stage for the auto created branch.
    auto_branch_creation_patterns Sequence[str]
    Automated branch creation glob patterns for the Amplify app.
    basic_auth_config AppBasicAuthConfig
    Sets password protection for your auto created branch.
    build_spec str
    The build specification (build spec) for the autocreated branch.
    enable_auto_branch_creation bool
    Enables automated branch creation for the Amplify app.
    enable_auto_build bool
    Enables auto building for the auto created branch.
    enable_performance_mode bool

    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_request_preview bool

    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 PullRequestEnvironmentName property.

    For more information, see Web Previews in the AWS Amplify Hosting User Guide .

    environment_variables Sequence[AppEnvironmentVariable]
    The environment variables for the autocreated branch.
    framework str
    The framework for the autocreated branch.
    pull_request_environment_name str

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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 AppAutoBranchCreationConfigStage
    Stage for the auto created branch.
    autoBranchCreationPatterns List<String>
    Automated branch creation glob patterns for the Amplify app.
    basicAuthConfig Property Map
    Sets password protection for your auto created branch.
    buildSpec String
    The build specification (build spec) for the autocreated branch.
    enableAutoBranchCreation Boolean
    Enables automated branch creation for the Amplify app.
    enableAutoBuild Boolean
    Enables auto building for the auto created branch.
    enablePerformanceMode Boolean

    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.

    enablePullRequestPreview Boolean

    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 PullRequestEnvironmentName property.

    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.
    pullRequestEnvironmentName String

    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 dev that you initialized with the Amplify CLI.

    To enable pull request previews, set the EnablePullRequestPreview property 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
    AppAutoBranchCreationConfigStageExperimental
    EXPERIMENTAL
    AppAutoBranchCreationConfigStageBeta
    BETA
    AppAutoBranchCreationConfigStagePullRequest
    PULL_REQUEST
    AppAutoBranchCreationConfigStageProduction
    PRODUCTION
    AppAutoBranchCreationConfigStageDevelopment
    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

    EnableBasicAuth bool
    Enables basic authorization for the Amplify app's branches.
    Password string
    The password for basic authorization.
    Username string
    The user name for basic authorization.
    EnableBasicAuth bool
    Enables basic authorization for the Amplify app's branches.
    Password string
    The password for basic authorization.
    Username string
    The user name for basic authorization.
    enableBasicAuth Boolean
    Enables basic authorization for the Amplify app's branches.
    password String
    The password for basic authorization.
    username String
    The user name for basic authorization.
    enableBasicAuth boolean
    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_auth bool
    Enables basic authorization for the Amplify app's branches.
    password str
    The password for basic authorization.
    username str
    The user name for basic authorization.
    enableBasicAuth Boolean
    Enables basic authorization for the Amplify app's branches.
    password String
    The password for basic authorization.
    username String
    The user name for basic authorization.

    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

    Name string
    The environment variable name.
    Value string
    The environment variable value.
    Name string
    The environment variable name.
    Value string
    The environment variable value.
    name String
    The environment variable name.
    value String
    The environment variable value.
    name string
    The environment variable name.
    value string
    The environment variable value.
    name str
    The environment variable name.
    value str
    The environment variable value.
    name String
    The environment variable name.
    value String
    The environment variable value.

    AppPlatform, AppPlatformArgs

    Web
    WEB
    WebDynamic
    WEB_DYNAMIC
    WebCompute
    WEB_COMPUTE
    AppPlatformWeb
    WEB
    AppPlatformWebDynamic
    WEB_DYNAMIC
    AppPlatformWebCompute
    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

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi