software.amazon.awssdk.services.amplify.model

Interface UpdateAppRequest.Builder

All Superinterfaces:

AmplifyRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAppRequest.Builder,UpdateAppRequest>, SdkBuilder<UpdateAppRequest.Builder,UpdateAppRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAppRequest

public static interface UpdateAppRequest.Builder
extends AmplifyRequest.Builder, SdkPojo, CopyableBuilder<UpdateAppRequest.Builder,UpdateAppRequest>

Method Summary

Modifier and Type	Method and Description
UpdateAppRequest.Builder	accessToken(String accessToken) The personal access token for a GitHub repository for an Amplify app.
UpdateAppRequest.Builder	appId(String appId) The unique ID for an Amplify app.
UpdateAppRequest.Builder	autoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.
default UpdateAppRequest.Builder	autoBranchCreationConfig(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.
UpdateAppRequest.Builder	autoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns) Describes the automated branch creation glob patterns for an Amplify app.
UpdateAppRequest.Builder	autoBranchCreationPatterns(String... autoBranchCreationPatterns) Describes the automated branch creation glob patterns for an Amplify app.
UpdateAppRequest.Builder	basicAuthCredentials(String basicAuthCredentials) The basic authorization credentials for an Amplify app.
UpdateAppRequest.Builder	buildSpec(String buildSpec) The build specification (build spec) for an Amplify app.
UpdateAppRequest.Builder	customHeaders(String customHeaders) The custom HTTP headers for an Amplify app.
UpdateAppRequest.Builder	customRules(Collection<CustomRule> customRules) The custom redirect and rewrite rules for an Amplify app.
UpdateAppRequest.Builder	customRules(Consumer<CustomRule.Builder>... customRules) The custom redirect and rewrite rules for an Amplify app.
UpdateAppRequest.Builder	customRules(CustomRule... customRules) The custom redirect and rewrite rules for an Amplify app.
UpdateAppRequest.Builder	description(String description) The description for an Amplify app.
UpdateAppRequest.Builder	enableAutoBranchCreation(Boolean enableAutoBranchCreation) Enables automated branch creation for an Amplify app.
UpdateAppRequest.Builder	enableBasicAuth(Boolean enableBasicAuth) Enables basic authorization for an Amplify app.
UpdateAppRequest.Builder	enableBranchAutoBuild(Boolean enableBranchAutoBuild) Enables branch auto-building for an Amplify app.
UpdateAppRequest.Builder	enableBranchAutoDeletion(Boolean enableBranchAutoDeletion) Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
UpdateAppRequest.Builder	environmentVariables(Map<String,String> environmentVariables) The environment variables for an Amplify app.
UpdateAppRequest.Builder	iamServiceRoleArn(String iamServiceRoleArn) The AWS Identity and Access Management (IAM) service role for an Amplify app.
UpdateAppRequest.Builder	name(String name) The name for an Amplify app.
UpdateAppRequest.Builder	oauthToken(String oauthToken) The OAuth token for a third-party source control system for an Amplify app.
UpdateAppRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateAppRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateAppRequest.Builder	platform(Platform platform) The platform for the Amplify app.
UpdateAppRequest.Builder	platform(String platform) The platform for the Amplify app.
UpdateAppRequest.Builder	repository(String repository) The name of the repository for an Amplify app

Methods inherited from interface software.amazon.awssdk.services.amplify.model.AmplifyRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

appId

UpdateAppRequest.Builder appId(String appId)

The unique ID for an Amplify app.

Parameters:

appId - The unique ID for an Amplify app.

Returns:

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

name

UpdateAppRequest.Builder name(String name)

The name for an Amplify app.

Parameters:

name - The name for an Amplify app.

Returns:

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

description

UpdateAppRequest.Builder description(String description)

The description for an Amplify app.

Parameters:

description - The description for an Amplify app.

Returns:

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

platform

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

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

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

environmentVariables

UpdateAppRequest.Builder environmentVariables(Map<String,String> environmentVariables)

The environment variables for an Amplify app.

Parameters:

environmentVariables - The environment variables for an Amplify app.

Returns:

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

enableBranchAutoBuild

UpdateAppRequest.Builder enableBranchAutoBuild(Boolean enableBranchAutoBuild)

Enables branch auto-building for an Amplify app.

Parameters:

enableBranchAutoBuild - Enables branch auto-building for an Amplify app.

Returns:

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

enableBranchAutoDeletion

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

UpdateAppRequest.Builder enableBasicAuth(Boolean enableBasicAuth)

Enables basic authorization for an Amplify app.

Parameters:

enableBasicAuth - Enables basic authorization for an Amplify app.

Returns:

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

basicAuthCredentials

UpdateAppRequest.Builder basicAuthCredentials(String basicAuthCredentials)

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

Parameters:

basicAuthCredentials - The basic authorization credentials 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

UpdateAppRequest.Builder customRules(Collection<CustomRule> customRules)

The custom redirect and rewrite rules for an Amplify app.

Parameters:

customRules - The custom redirect and rewrite rules for an Amplify app.

Returns:

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

customRules

UpdateAppRequest.Builder customRules(CustomRule... customRules)

The custom redirect and rewrite rules for an Amplify app.

Parameters:

customRules - The custom redirect and rewrite rules for an Amplify app.

Returns:

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

customRules

UpdateAppRequest.Builder customRules(Consumer<CustomRule.Builder>... customRules)

The custom redirect and rewrite rules for an Amplify app.

This is a convenience method that creates an instance of the CustomRule.Builder avoiding the need to create one manually via CustomRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #customRules(List).

Parameters:

customRules - a consumer that will call methods on CustomRule.Builder

Returns:

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

See Also:

#customRules(java.util.Collection)

buildSpec

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

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

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

UpdateAppRequest.Builder autoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns)

Describes the automated branch creation glob patterns for an Amplify app.

Parameters:

autoBranchCreationPatterns - Describes 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

UpdateAppRequest.Builder autoBranchCreationPatterns(String... autoBranchCreationPatterns)

Describes the automated branch creation glob patterns for an Amplify app.

Parameters:

autoBranchCreationPatterns - Describes 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

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

autoBranchCreationConfig

default UpdateAppRequest.Builder autoBranchCreationConfig(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig)

The automated branch creation configuration for an Amplify app.

This is a convenience method that creates an instance of the AutoBranchCreationConfig.Builder avoiding the need to create one manually via AutoBranchCreationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoBranchCreationConfig(AutoBranchCreationConfig).

Parameters:

autoBranchCreationConfig - a consumer that will call methods on AutoBranchCreationConfig.Builder

Returns:

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

See Also:

autoBranchCreationConfig(AutoBranchCreationConfig)

repository

UpdateAppRequest.Builder repository(String repository)

The name of the repository for an Amplify app

Parameters:

repository - The name of the repository for an Amplify app

Returns:

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

oauthToken

UpdateAppRequest.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 update an 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 update an 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

UpdateAppRequest.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 update an 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 update an 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.

overrideConfiguration

UpdateAppRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateAppRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder