Package software.amazon.awssdk.services.amplify.model

Interface CreateAppRequest.Builder

    • Method Detail

      • name

        CreateAppRequest.Builder name​(String name)

        The name of the Amplify app.

        Parameters:
        name - The name of the Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateAppRequest.Builder description​(String description)

        The description of the Amplify app.

        Parameters:
        description - The description of the Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • repository

        CreateAppRequest.Builder repository​(String repository)

        The Git repository for the Amplify app.

        Parameters:
        repository - The Git repository for the Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • platform

        CreateAppRequest.Builder platform​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Platform, Platform

      • platform

        CreateAppRequest.Builder platform​(Platform 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Platform, Platform

      • iamServiceRoleArn

        CreateAppRequest.Builder iamServiceRoleArn​(String iamServiceRoleArn)

        The AWS Identity and Access Management (IAM) service role for an Amplify app.

        Parameters:
        iamServiceRoleArn - The AWS Identity and Access Management (IAM) service role for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • oauthToken

        CreateAppRequest.Builder oauthToken​(String oauthToken)

        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 .

        Parameters:
        oauthToken - 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 .

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessToken

        CreateAppRequest.Builder accessToken​(String accessToken)

        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 .

        Parameters:
        accessToken - 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 .

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentVariables

        CreateAppRequest.Builder environmentVariables​(Map<String,​String> environmentVariables)

        The environment variables map for an 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.

        Parameters:
        environmentVariables - The environment variables map for an 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableBranchAutoBuild

        CreateAppRequest.Builder enableBranchAutoBuild​(Boolean enableBranchAutoBuild)

        Enables the auto building of branches for an Amplify app.

        Parameters:
        enableBranchAutoBuild - Enables the auto building of branches for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableBranchAutoDeletion

        CreateAppRequest.Builder enableBranchAutoDeletion​(Boolean enableBranchAutoDeletion)

        Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.

        Parameters:
        enableBranchAutoDeletion - Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableBasicAuth

        CreateAppRequest.Builder enableBasicAuth​(Boolean enableBasicAuth)

        Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

        Parameters:
        enableBasicAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • basicAuthCredentials

        CreateAppRequest.Builder basicAuthCredentials​(String basicAuthCredentials)

        The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

        Parameters:
        basicAuthCredentials - The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customRules

        CreateAppRequest.Builder customRules​(Collection<CustomRule> customRules)

        The custom rewrite and redirect rules for an Amplify app.

        Parameters:
        customRules - The custom rewrite and redirect rules for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customRules

        CreateAppRequest.Builder customRules​(CustomRule... customRules)

        The custom rewrite and redirect rules for an Amplify app.

        Parameters:
        customRules - The custom rewrite and redirect rules for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateAppRequest.Builder tags​(Map<String,​String> tags)

        The tag for an Amplify app.

        Parameters:
        tags - The tag for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildSpec

        CreateAppRequest.Builder buildSpec​(String buildSpec)

        The build specification (build spec) for an Amplify app.

        Parameters:
        buildSpec - The build specification (build spec) for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customHeaders

        CreateAppRequest.Builder customHeaders​(String customHeaders)

        The custom HTTP headers for an Amplify app.

        Parameters:
        customHeaders - The custom HTTP headers for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableAutoBranchCreation

        CreateAppRequest.Builder enableAutoBranchCreation​(Boolean enableAutoBranchCreation)

        Enables automated branch creation for an Amplify app.

        Parameters:
        enableAutoBranchCreation - Enables automated branch creation for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoBranchCreationPatterns

        CreateAppRequest.Builder autoBranchCreationPatterns​(Collection<String> autoBranchCreationPatterns)

        The automated branch creation glob patterns for an Amplify app.

        Parameters:
        autoBranchCreationPatterns - The automated branch creation glob patterns for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoBranchCreationPatterns

        CreateAppRequest.Builder autoBranchCreationPatterns​(String... autoBranchCreationPatterns)

        The automated branch creation glob patterns for an Amplify app.

        Parameters:
        autoBranchCreationPatterns - The automated branch creation glob patterns for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoBranchCreationConfig

        CreateAppRequest.Builder autoBranchCreationConfig​(AutoBranchCreationConfig autoBranchCreationConfig)

        The automated branch creation configuration for an Amplify app.

        Parameters:
        autoBranchCreationConfig - The automated branch creation configuration for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.