Class App
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<App.Builder,
App>
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appArn()
The Amazon Resource Name (ARN) of the Amplify app.final String
appId()
The unique ID of the Amplify app.final AutoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.Describes the automated branch creation glob patterns for the Amplify app.final String
The basic authorization credentials for branches for the Amplify app.static App.Builder
builder()
final String
Describes the content of the build specification (build spec) for the Amplify app.final Instant
Creates a date and time for the Amplify app.final String
Describes the custom HTTP headers for the Amplify app.final List
<CustomRule> Describes the custom redirect and rewrite rules for the Amplify app.final String
The default domain for the Amplify app.final String
The description for the Amplify app.final Boolean
Enables automated branch creation for the Amplify app.final Boolean
Enables basic authorization for the Amplify app's branches.final Boolean
Enables the auto-building of branches for the Amplify app.final Boolean
Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.The environment variables for the Amplify app.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AutoBranchCreationPatterns property.final boolean
For responses, this returns true if the service returned a value for the CustomRules property.final boolean
For responses, this returns true if the service returned a value for the EnvironmentVariables property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.final String
name()
The name for the Amplify app.final Platform
platform()
The platform for the Amplify app.final String
The platform for the Amplify app.final ProductionBranch
Describes the information about a production branch of the Amplify app.final String
The Git repository for the Amplify app.final RepositoryCloneMethod
final String
static Class
<? extends App.Builder> tags()
The tag for the Amplify app.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
Updates the date and time for the Amplify app.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appId
The unique ID of the Amplify app.
- Returns:
- The unique ID of the Amplify app.
-
appArn
The Amazon Resource Name (ARN) of the Amplify app.
- Returns:
- The Amazon Resource Name (ARN) of the Amplify app.
-
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 theisEmpty()
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
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
The description for the Amplify app.
- Returns:
- The description for the Amplify app.
-
repository
The Git repository for the Amplify app.
- Returns:
- The Git repository for the Amplify app.
-
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 toWEB_COMPUTE
. For an app requiring Amplify Hosting's original SSR support only, set the platform type toWEB_DYNAMIC
.If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- 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 toWEB_COMPUTE
. For an app requiring Amplify Hosting's original SSR support only, set the platform type toWEB_DYNAMIC
. - See Also:
-
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 toWEB_COMPUTE
. For an app requiring Amplify Hosting's original SSR support only, set the platform type toWEB_DYNAMIC
.If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- 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 toWEB_COMPUTE
. For an app requiring Amplify Hosting's original SSR support only, set the platform type toWEB_DYNAMIC
. - See Also:
-
createTime
Creates a date and time for the Amplify app.
- Returns:
- Creates a date and time for the Amplify app.
-
updateTime
Updates the date and time for the Amplify app.
- Returns:
- Updates the date and time for the Amplify app.
-
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 theisEmpty()
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
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
The default domain for the Amplify app.
- Returns:
- The default domain for the Amplify app.
-
enableBranchAutoBuild
Enables the auto-building of branches for the Amplify app.
- Returns:
- Enables the auto-building of branches for the Amplify app.
-
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
Enables basic authorization for the Amplify app's branches.
- Returns:
- Enables basic authorization for the Amplify app's branches.
-
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 theisEmpty()
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
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
Describes the information about a production branch of the Amplify app.
- Returns:
- Describes the information about a production branch of the Amplify app.
-
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
Describes the custom HTTP headers for the Amplify app.
- Returns:
- Describes the custom HTTP headers for the Amplify app.
-
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 theisEmpty()
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
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
Describes the automated branch creation configuration for the Amplify app.
- Returns:
- Describes the automated branch creation configuration for the Amplify app.
-
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, andSSH
for GitLab and Bitbucket repositories.If the service returns an enum value that is not available in the current SDK version,
repositoryCloneMethod
will returnRepositoryCloneMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrepositoryCloneMethodAsString()
.- 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, andSSH
for GitLab and Bitbucket repositories.- See Also:
-
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, andSSH
for GitLab and Bitbucket repositories.If the service returns an enum value that is not available in the current SDK version,
repositoryCloneMethod
will returnRepositoryCloneMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrepositoryCloneMethodAsString()
.- 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, andSSH
for GitLab and Bitbucket repositories.- See Also:
-
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 interfaceToCopyableBuilder<App.Builder,
App> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-