App (AWS Java SDK :: Services :: Amplify 2.17.263 API)

java.lang.Object
- software.amazon.awssdk.services.amplify.model.App

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<App.Builder,App>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface App.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`App.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appArn()` The Amazon Resource Name (ARN) of the Amplify app.
`String`	`appId()` The unique ID of the Amplify app.
`AutoBranchCreationConfig`	`autoBranchCreationConfig()` Describes the automated branch creation configuration for the Amplify app.
`List<String>`	`autoBranchCreationPatterns()` Describes the automated branch creation glob patterns for the Amplify app.
`String`	`basicAuthCredentials()` The basic authorization credentials for branches for the Amplify app.
`static App.Builder`	`builder()`
`String`	`buildSpec()` Describes the content of the build specification (build spec) for the Amplify app.
`Instant`	`createTime()` Creates a date and time for the Amplify app.
`String`	`customHeaders()` Describes the custom HTTP headers for the Amplify app.
`List<CustomRule>`	`customRules()` Describes the custom redirect and rewrite rules for the Amplify app.
`String`	`defaultDomain()` The default domain for the Amplify app.
`String`	`description()` The description for the Amplify app.
`Boolean`	`enableAutoBranchCreation()` Enables automated branch creation for the Amplify app.
`Boolean`	`enableBasicAuth()` Enables basic authorization for the Amplify app's branches.
`Boolean`	`enableBranchAutoBuild()` Enables the auto-building of branches for the Amplify app.
`Boolean`	`enableBranchAutoDeletion()` Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
`Map<String,String>`	`environmentVariables()` The environment variables for the Amplify app.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAutoBranchCreationPatterns()` For responses, this returns true if the service returned a value for the AutoBranchCreationPatterns property.
`boolean`	`hasCustomRules()` For responses, this returns true if the service returned a value for the CustomRules property.
`boolean`	`hasEnvironmentVariables()` For responses, this returns true if the service returned a value for the EnvironmentVariables property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`iamServiceRoleArn()` The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
`String`	`name()` The name for the Amplify app.
`Platform`	`platform()` The platform for the Amplify app.
`String`	`platformAsString()` The platform for the Amplify app.
`ProductionBranch`	`productionBranch()` Describes the information about a production branch of the Amplify app.
`String`	`repository()` The Git repository for the Amplify app.
`RepositoryCloneMethod`	`repositoryCloneMethod()`
`String`	`repositoryCloneMethodAsString()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends App.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tag for the Amplify app.
`App.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updateTime()` Updates the date and time for the Amplify app.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
    
    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.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The platform for the Amplify app.
    
    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.
    
    See Also:
    
    Platform
  - createTime
```
public final Instant createTime()
```
    Creates a date and time for the Amplify app.
    
    Returns:
    
    Creates a date and time for the Amplify app.
  - updateTime
```
public final Instant updateTime()
```
    Updates the date and time for the Amplify app.
    
    Returns:
    
    Updates the date and time for the Amplify app.
  - iamServiceRoleArn
```
public final String iamServiceRoleArn()
```
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
    
    Returns:
    
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of 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.
    
    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.
  - 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:
    
    RepositoryCloneMethod
  - 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:
    
    RepositoryCloneMethod
  - toBuilder
```
public App.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<App.Builder,App>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class App

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

appId

appArn

name

hasTags

tags

description

repository

platform

platformAsString

createTime

updateTime

iamServiceRoleArn

hasEnvironmentVariables

environmentVariables

defaultDomain

enableBranchAutoBuild

enableBranchAutoDeletion

enableBasicAuth

basicAuthCredentials

hasCustomRules

customRules

productionBranch

buildSpec

customHeaders

enableAutoBranchCreation

hasAutoBranchCreationPatterns

autoBranchCreationPatterns

autoBranchCreationConfig

repositoryCloneMethod

repositoryCloneMethodAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields