Interface UpdateBranchRequest.Builder
-
- All Superinterfaces:
AmplifyRequest.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<UpdateBranchRequest.Builder,UpdateBranchRequest>,SdkBuilder<UpdateBranchRequest.Builder,UpdateBranchRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- UpdateBranchRequest
public static interface UpdateBranchRequest.Builder extends AmplifyRequest.Builder, SdkPojo, CopyableBuilder<UpdateBranchRequest.Builder,UpdateBranchRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UpdateBranchRequest.BuilderappId(String appId)The unique ID for an Amplify app.default UpdateBranchRequest.Builderbackend(Consumer<Backend.Builder> backend)The backend for aBranchof an Amplify app.UpdateBranchRequest.Builderbackend(Backend backend)The backend for aBranchof an Amplify app.UpdateBranchRequest.BuilderbackendEnvironmentArn(String backendEnvironmentArn)The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.UpdateBranchRequest.BuilderbasicAuthCredentials(String basicAuthCredentials)The basic authorization credentials for the branch.UpdateBranchRequest.BuilderbranchName(String branchName)The name of the branch.UpdateBranchRequest.BuilderbuildSpec(String buildSpec)The build specification (build spec) for the branch.UpdateBranchRequest.Builderdescription(String description)The description for the branch.UpdateBranchRequest.BuilderdisplayName(String displayName)The display name for a branch.UpdateBranchRequest.BuilderenableAutoBuild(Boolean enableAutoBuild)Enables auto building for the branch.UpdateBranchRequest.BuilderenableBasicAuth(Boolean enableBasicAuth)Enables basic authorization for the branch.UpdateBranchRequest.BuilderenableNotification(Boolean enableNotification)Enables notifications for the branch.UpdateBranchRequest.BuilderenablePerformanceMode(Boolean enablePerformanceMode)Enables performance mode for the branch.UpdateBranchRequest.BuilderenablePullRequestPreview(Boolean enablePullRequestPreview)Enables pull request previews for this branch.UpdateBranchRequest.BuilderenvironmentVariables(Map<String,String> environmentVariables)The environment variables for the branch.UpdateBranchRequest.Builderframework(String framework)The framework for the branch.UpdateBranchRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)UpdateBranchRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)UpdateBranchRequest.BuilderpullRequestEnvironmentName(String pullRequestEnvironmentName)The Amplify environment name for the pull request.UpdateBranchRequest.Builderstage(String stage)Describes the current stage for the branch.UpdateBranchRequest.Builderstage(Stage stage)Describes the current stage for the branch.UpdateBranchRequest.Builderttl(String ttl)The content Time to Live (TTL) for the website in seconds.-
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.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
appId
UpdateBranchRequest.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.
-
branchName
UpdateBranchRequest.Builder branchName(String branchName)
The name of the branch.
- Parameters:
branchName- The name of the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
UpdateBranchRequest.Builder description(String description)
The description for the branch.
- Parameters:
description- The description for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
framework
UpdateBranchRequest.Builder framework(String framework)
The framework for the branch.
- Parameters:
framework- The framework for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stage
UpdateBranchRequest.Builder stage(String stage)
Describes the current stage for the branch.
-
stage
UpdateBranchRequest.Builder stage(Stage stage)
Describes the current stage for the branch.
-
enableNotification
UpdateBranchRequest.Builder enableNotification(Boolean enableNotification)
Enables notifications for the branch.
- Parameters:
enableNotification- Enables notifications for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableAutoBuild
UpdateBranchRequest.Builder enableAutoBuild(Boolean enableAutoBuild)
Enables auto building for the branch.
- Parameters:
enableAutoBuild- Enables auto building for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentVariables
UpdateBranchRequest.Builder environmentVariables(Map<String,String> environmentVariables)
The environment variables for the branch.
- Parameters:
environmentVariables- The environment variables for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
basicAuthCredentials
UpdateBranchRequest.Builder basicAuthCredentials(String basicAuthCredentials)
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format
user:password.- Parameters:
basicAuthCredentials- The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the formatuser:password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableBasicAuth
UpdateBranchRequest.Builder enableBasicAuth(Boolean enableBasicAuth)
Enables basic authorization for the branch.
- Parameters:
enableBasicAuth- Enables basic authorization for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enablePerformanceMode
UpdateBranchRequest.Builder enablePerformanceMode(Boolean enablePerformanceMode)
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
- Parameters:
enablePerformanceMode- Enables performance mode for the branch.Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
buildSpec
UpdateBranchRequest.Builder buildSpec(String buildSpec)
The build specification (build spec) for the branch.
- Parameters:
buildSpec- The build specification (build spec) for the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ttl
UpdateBranchRequest.Builder ttl(String ttl)
The content Time to Live (TTL) for the website in seconds.
- Parameters:
ttl- The content Time to Live (TTL) for the website in seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
UpdateBranchRequest.Builder displayName(String displayName)
The display name for a branch. This is used as the default domain prefix.
- Parameters:
displayName- The display name for a branch. This is used as the default domain prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enablePullRequestPreview
UpdateBranchRequest.Builder enablePullRequestPreview(Boolean enablePullRequestPreview)
Enables pull request previews for this branch.
- Parameters:
enablePullRequestPreview- Enables pull request previews for this branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pullRequestEnvironmentName
UpdateBranchRequest.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName)
The Amplify environment name for the pull request.
- Parameters:
pullRequestEnvironmentName- The Amplify environment name for the pull request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backendEnvironmentArn
UpdateBranchRequest.Builder backendEnvironmentArn(String backendEnvironmentArn)
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- Parameters:
backendEnvironmentArn- The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backend
UpdateBranchRequest.Builder backend(Backend backend)
The backend for a
Branchof an Amplify app. Use for a backend created from an CloudFormation stack.- Parameters:
backend- The backend for aBranchof an Amplify app. Use for a backend created from an CloudFormation stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backend
default UpdateBranchRequest.Builder backend(Consumer<Backend.Builder> backend)
The backend for a
This is a convenience method that creates an instance of theBranchof an Amplify app. Use for a backend created from an CloudFormation stack.Backend.Builderavoiding the need to create one manually viaBackend.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobackend(Backend).- Parameters:
backend- a consumer that will call methods onBackend.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
backend(Backend)
-
overrideConfiguration
UpdateBranchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
UpdateBranchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-