App ¶

class App(TypedDict, closed=True):
    app_id: "capo_amplify.types.app_id.AppId"
    """<p>The unique ID of the Amplify app. </p>"""
    app_arn: "capo_amplify.types.app_arn.AppArn"
    """<p>The Amazon Resource Name (ARN) of the Amplify app. </p>"""
    name: "capo_amplify.types.name.Name"
    """<p>The name for the Amplify app. </p>"""
    tags: NotRequired["capo_amplify.types.tag_map.TagMap"]
    """<p>The tag for the Amplify app. </p>"""
    description: "capo_amplify.types.description.Description"
    """<p>The description for the Amplify app. </p>"""
    repository: "capo_amplify.types.repository.Repository"
    """<p>The Git repository for the Amplify app. </p>"""
    platform: "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 14 or later, you must use the platform type <code>WEB_COMPUTE</code>.</p>"""
    create_time: "capo_amplify.types.create_time.CreateTime"
    """<p>A timestamp of when Amplify created the application.</p>"""
    update_time: "capo_amplify.types.update_time.UpdateTime"
    """<p>A timestamp of when Amplify updated the application.</p>"""
    compute_role_arn: NotRequired["capo_amplify.types.compute_role_arn.ComputeRoleArn"]
    """<p>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 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: (
        "capo_amplify.types.environment_variables.EnvironmentVariables"
    )
    """<p>The environment variables for the Amplify app. </p> <p>For a list of the environment variables that are accessible to Amplify by default, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify Environment variables</a> in the <i>Amplify Hosting User Guide</i>.</p>"""
    default_domain: "capo_amplify.types.default_domain.DefaultDomain"
    """<p>The default domain for the Amplify app. </p>"""
    enable_branch_auto_build: (
        "capo_amplify.types.enable_branch_auto_build.EnableBranchAutoBuild"
    )
    """<p>Enables the auto-building of branches for the Amplify app. </p>"""
    enable_branch_auto_deletion: NotRequired[
        "capo_amplify.types.enable_branch_auto_deletion.EnableBranchAutoDeletion"
    ]
    """<p>Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.</p>"""
    enable_basic_auth: "capo_amplify.types.enable_basic_auth.EnableBasicAuth"
    """<p>Enables basic authorization for the Amplify app's branches. </p>"""
    basic_auth_credentials: NotRequired[
        "capo_amplify.types.basic_auth_credentials.BasicAuthCredentials"
    ]
    """<p>The basic authorization credentials for branches for the 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>Describes the custom redirect and rewrite rules for the Amplify app. </p>"""
    production_branch: NotRequired[
        "capo_amplify.types.production_branch.ProductionBranch"
    ]
    """<p>Describes the information about a production branch of the Amplify app. </p>"""
    build_spec: NotRequired["capo_amplify.types.build_spec.BuildSpec"]
    """<p>Describes the content of the build specification (build spec) for the Amplify app. </p>"""
    custom_headers: NotRequired["capo_amplify.types.custom_headers.CustomHeaders"]
    """<p>Describes the custom HTTP headers for the Amplify app.</p>"""
    enable_auto_branch_creation: NotRequired[
        "capo_amplify.types.enable_auto_branch_creation.EnableAutoBranchCreation"
    ]
    """<p>Enables automated branch creation for the 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 the Amplify app. </p>"""
    auto_branch_creation_config: NotRequired[
        "capo_amplify.types.auto_branch_creation_config.AutoBranchCreationConfig"
    ]
    """<p>Describes the automated branch creation configuration for the Amplify app. </p>"""
    repository_clone_method: NotRequired[
        "capo_amplify.types.repository_clone_method.RepositoryCloneMethod"
    ]
    """<note> <p>This is for internal use.</p> </note> <p>The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies <code>TOKEN</code> for a GitHub repository, <code>SIGV4</code> for an Amazon Web Services CodeCommit repository, and <code>SSH</code> for GitLab and Bitbucket repositories.</p>"""
    cache_config: NotRequired["capo_amplify.types.cache_config.CacheConfig"]
    """<p>The cache configuration for the Amplify app. If you don't specify the cache configuration <code>type</code>, Amplify uses the default <code>AMPLIFY_MANAGED</code> setting.</p>"""
    webhook_create_time: NotRequired[
        "capo_amplify.types.webhook_create_time.webhookCreateTime"
    ]
    """<p>A timestamp of when Amplify created the webhook in your Git repository.</p>"""
    waf_configuration: NotRequired[
        "capo_amplify.types.waf_configuration.WafConfiguration"
    ]
    """<p>Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.</p>"""
    job_config: NotRequired["capo_amplify.types.job_config.JobConfig"]
    """<p>The configuration details that apply to the jobs for an Amplify app.</p>"""