Class CreateAppRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.amplify.model.AmplifyRequest
software.amazon.awssdk.services.amplify.model.CreateAppRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAppRequest extends AmplifyRequest implements ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

The request structure used to create apps in Amplify.

  • Method Details

    • name

      public final String name()

      The name of the Amplify app.

      Returns:
      The name of the Amplify app.

    • description

      public final String description()

      The description of the Amplify app.

      Returns:
      The description of the Amplify app.

    • repository

      public final String repository()

      The Git repository for the Amplify app.

      Returns:
      The Git repository for the Amplify app.

    • platform

      public final 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.

      If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in 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.

      If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

      Returns:
      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_COMPUTE and set the artifacts baseDirectory to .next in 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.

      See Also:

    • platformAsString

      public final String platformAsString()

      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_COMPUTE and set the artifacts baseDirectory to .next in 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.

      If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

      Returns:
      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_COMPUTE and set the artifacts baseDirectory to .next in 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.

      See Also:

    • iamServiceRoleArn

      public final String iamServiceRoleArn()

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

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

    • oauthToken

      public final 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 .

      Returns:
      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 .

    • accessToken

      public final 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 .

      Returns:
      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 .

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentVariables

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentVariables() method.

      Returns:
      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.

    • enableBranchAutoBuild

      public final Boolean enableBranchAutoBuild()

      Enables the auto building of branches for an Amplify app.

      Returns:
      Enables the auto building of branches for an Amplify app.

    • enableBranchAutoDeletion

      public final Boolean enableBranchAutoDeletion()

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

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

    • enableBasicAuth

      public final Boolean enableBasicAuth()

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

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

    • basicAuthCredentials

      public final 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.

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

    • hasCustomRules

      public final boolean hasCustomRules()
      For responses, this returns true if the service returned a value for the CustomRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • customRules

      public final List<CustomRule> customRules()

      The custom rewrite and redirect rules for an Amplify app.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomRules() method.

      Returns:
      The custom rewrite and redirect rules for an Amplify app.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tag for an Amplify app.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tag for an Amplify app.

    • buildSpec

      public final String buildSpec()

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

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

    • customHeaders

      public final String customHeaders()

      The custom HTTP headers for an Amplify app.

      Returns:
      The custom HTTP headers for an Amplify app.

    • enableAutoBranchCreation

      public final Boolean enableAutoBranchCreation()

      Enables automated branch creation for an Amplify app.

      Returns:
      Enables automated branch creation for an Amplify app.

    • hasAutoBranchCreationPatterns

      public final boolean hasAutoBranchCreationPatterns()
      For responses, this returns true if the service returned a value for the AutoBranchCreationPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • autoBranchCreationPatterns

      public final List<String> autoBranchCreationPatterns()

      The automated branch creation glob patterns for an Amplify app.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoBranchCreationPatterns() method.

      Returns:
      The automated branch creation glob patterns for an Amplify app.

    • autoBranchCreationConfig

      public final AutoBranchCreationConfig autoBranchCreationConfig()

      The automated branch creation configuration for an Amplify app.

      Returns:
      The automated branch creation configuration for an Amplify app.

    • cacheConfig

      public final CacheConfig cacheConfig()

      The cache configuration for the Amplify app.

      Returns:
      The cache configuration for the Amplify app.

    • toBuilder

      public CreateAppRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
      Specified by:
      toBuilder in class AmplifyRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAppRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAppRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.