Class App

java.lang.Object
software.amazon.awssdk.services.amplify.model.App
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<App.Builder,App>
@Generated("software.amazon.awssdk:codegen") public final class App extends Object implements SdkPojo, Serializable, ToCopyableBuilder<App.Builder,App>

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

See Also:

  • Method Details

    • appId

      public final String appId()

      The unique ID of the Amplify app.

      Returns:
      The unique ID of the Amplify app.

    • appArn

      public final String appArn()

      The Amazon Resource Name (ARN) of the Amplify app.

      Returns:
      The Amazon Resource Name (ARN) of the Amplify app.

    • name

      public final String name()

      The name for the Amplify app.

      Returns:
      The name for the 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 the 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 the Amplify app.

    • description

      public final String description()

      The description for the Amplify app.

      Returns:
      The description for 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 14 or later, you must use the platform type WEB_COMPUTE.

      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 14 or later, you must use the platform type WEB_COMPUTE.

      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 14 or later, you must use the platform type WEB_COMPUTE.

      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 14 or later, you must use the platform type WEB_COMPUTE.

      See Also:

    • createTime

      public final Instant createTime()

      A timestamp of when Amplify created the application.

      Returns:
      A timestamp of when Amplify created the application.

    • updateTime

      public final Instant updateTime()

      A timestamp of when Amplify updated the application.

      Returns:
      A timestamp of when Amplify updated the application.

    • computeRoleArn

      public final String computeRoleArn()

      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 Adding an SSR Compute role in the Amplify User Guide.

      Returns:
      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 Adding an SSR Compute role in the Amplify User Guide.

    • iamServiceRoleArn

      public final String iamServiceRoleArn()

      The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

      Returns:
      The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

    • 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 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.

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

    • defaultDomain

      public final String defaultDomain()

      The default domain for the Amplify app.

      Returns:
      The default domain for the Amplify app.

    • enableBranchAutoBuild

      public final Boolean enableBranchAutoBuild()

      Enables the auto-building of branches for the Amplify app.

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

    • enableBranchAutoDeletion

      public final Boolean enableBranchAutoDeletion()

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

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

    • enableBasicAuth

      public final Boolean enableBasicAuth()

      Enables basic authorization for the Amplify app's branches.

      Returns:
      Enables basic authorization for the Amplify app's branches.

    • basicAuthCredentials

      public final String basicAuthCredentials()

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

      Returns:
      The basic authorization credentials for branches for the 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()

      Describes the custom redirect and rewrite rules for the 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:
      Describes the custom redirect and rewrite rules for the Amplify app.

    • productionBranch

      public final ProductionBranch productionBranch()

      Describes the information about a production branch of the Amplify app.

      Returns:
      Describes the information about a production branch of the Amplify app.

    • buildSpec

      public final String buildSpec()

      Describes the content of the build specification (build spec) for the Amplify app.

      Returns:
      Describes the content of the build specification (build spec) for the Amplify app.

    • customHeaders

      public final String customHeaders()

      Describes the custom HTTP headers for the Amplify app.

      Returns:
      Describes the custom HTTP headers for the Amplify app.

    • enableAutoBranchCreation

      public final Boolean enableAutoBranchCreation()

      Enables automated branch creation for the Amplify app.

      Returns:
      Enables automated branch creation for the 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()

      Describes the automated branch creation glob patterns for the 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:
      Describes the automated branch creation glob patterns for the Amplify app.

    • autoBranchCreationConfig

      public final AutoBranchCreationConfig autoBranchCreationConfig()

      Describes the automated branch creation configuration for the Amplify app.

      Returns:
      Describes the automated branch creation configuration for the Amplify app.

    • repositoryCloneMethod

      public final RepositoryCloneMethod repositoryCloneMethod()

      This is for internal use.

      The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

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

      Returns:

      This is for internal use.

      The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

      See Also:

    • repositoryCloneMethodAsString

      public final String repositoryCloneMethodAsString()

      This is for internal use.

      The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

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

      Returns:

      This is for internal use.

      The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

      See Also:

    • cacheConfig

      public final CacheConfig cacheConfig()

      The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

      Returns:
      The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

    • webhookCreateTime

      public final Instant webhookCreateTime()

      A timestamp of when Amplify created the webhook in your Git repository.

      Returns:
      A timestamp of when Amplify created the webhook in your Git repository.

    • wafConfiguration

      public final WafConfiguration wafConfiguration()

      Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

      Returns:
      Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

    • jobConfig

      public final JobConfig jobConfig()

      The configuration details that apply to the jobs for an Amplify app.

      Returns:
      The configuration details that apply to the jobs for an Amplify app.

    • toBuilder

      public App.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<App.Builder,App>
      Returns:
      a builder for type T

    • builder

      public static App.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.