UpdateAppRequest ¶

class UpdateAppRequest(TypedDict, closed=True):
    app_id: "capo_amplify.types.app_id.AppId"
    """<p>The unique ID for an Amplify app. </p>"""
    name: NotRequired["capo_amplify.types.name.Name"]
    """<p>The name for an Amplify app. </p>"""
    description: NotRequired["capo_amplify.types.description.Description"]
    """<p>The description for an Amplify app. </p>"""
    platform: NotRequired["capo_amplify.types.platform.Platform"]
    """<p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.</p> <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to <code>WEB_COMPUTE</code>.</p>"""
    compute_role_arn: NotRequired["capo_amplify.types.compute_role_arn.ComputeRoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"""
    iam_service_role_arn: NotRequired[
        "capo_amplify.types.service_role_arn.ServiceRoleArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>"""
    environment_variables: NotRequired[
        "capo_amplify.types.environment_variables.EnvironmentVariables"
    ]
    """<p>The environment variables for an Amplify app. </p>"""
    enable_branch_auto_build: NotRequired[
        "capo_amplify.types.enable_auto_build.EnableAutoBuild"
    ]
    """<p>Enables branch auto-building for an Amplify app. </p>"""
    enable_branch_auto_deletion: NotRequired[
        "capo_amplify.types.enable_branch_auto_deletion.EnableBranchAutoDeletion"
    ]
    """<p>Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository. </p>"""
    enable_basic_auth: NotRequired[
        "capo_amplify.types.enable_basic_auth.EnableBasicAuth"
    ]
    """<p>Enables basic authorization for an Amplify app. </p>"""
    basic_auth_credentials: NotRequired[
        "capo_amplify.types.basic_auth_credentials.BasicAuthCredentials"
    ]
    """<p>The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>"""
    custom_rules: NotRequired["capo_amplify.types.custom_rules.CustomRules"]
    """<p>The custom redirect and rewrite rules for an Amplify app. </p>"""
    build_spec: NotRequired["capo_amplify.types.build_spec.BuildSpec"]
    """<p>The build specification (build spec) for an Amplify app. </p>"""
    custom_headers: NotRequired["capo_amplify.types.custom_headers.CustomHeaders"]
    """<p>The custom HTTP headers for an Amplify app.</p>"""
    enable_auto_branch_creation: NotRequired[
        "capo_amplify.types.enable_auto_branch_creation.EnableAutoBranchCreation"
    ]
    """<p>Enables automated branch creation for an Amplify app. </p>"""
    auto_branch_creation_patterns: NotRequired[
        "capo_amplify.types.auto_branch_creation_patterns.AutoBranchCreationPatterns"
    ]
    """<p>Describes the automated branch creation glob patterns for an Amplify app. </p>"""
    auto_branch_creation_config: NotRequired[
        "capo_amplify.types.auto_branch_creation_config.AutoBranchCreationConfig"
    ]
    """<p>The automated branch creation configuration for an Amplify app. </p>"""
    repository: NotRequired["capo_amplify.types.repository.Repository"]
    """<p>The name of the Git repository for an Amplify app.</p>"""
    oauth_token: NotRequired["capo_amplify.types.oauth_token.OauthToken"]
    """<p>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.</p> <p>Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit.</p> <p>To authorize access to GitHub as your repository provider, use <code>accessToken</code>.</p> <p>You must specify either <code>oauthToken</code> or <code>accessToken</code> when you update an app.</p> <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>"""
    access_token: NotRequired["capo_amplify.types.access_token.AccessToken"]
    """<p>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.</p> <p>Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>.</p> <p>You must specify either <code>accessToken</code> or <code>oauthToken</code> when you update an app.</p> <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>"""
    job_config: NotRequired["capo_amplify.types.job_config.JobConfig"]
    """<p>Describes the configuration details that apply to the jobs for an Amplify app.</p>"""
    cache_config: NotRequired["capo_amplify.types.cache_config.CacheConfig"]
    """<p>The cache configuration for the Amplify app.</p>"""