Struct aws_sdk_amplify::operation::update_branch::UpdateBranchInput

#[non_exhaustive]
pub struct UpdateBranchInput {

    pub app_id: Option<String>,
    pub branch_name: Option<String>,
    pub description: Option<String>,
    pub framework: Option<String>,
    pub stage: Option<Stage>,
    pub enable_notification: Option<bool>,
    pub enable_auto_build: Option<bool>,
    pub environment_variables: Option<HashMap<String, String>>,
    pub basic_auth_credentials: Option<String>,
    pub enable_basic_auth: Option<bool>,
    pub enable_performance_mode: Option<bool>,
    pub build_spec: Option<String>,
    pub ttl: Option<String>,
    pub display_name: Option<String>,
    pub enable_pull_request_preview: Option<bool>,
    pub pull_request_environment_name: Option<String>,
    pub backend_environment_arn: Option<String>,
    pub backend: Option<Backend>,
}

The request structure for the update branch request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

app_id: Option<String>

The unique ID for an Amplify app.

branch_name: Option<String>

The name of the branch.

description: Option<String>

The description for the branch.

framework: Option<String>

The framework for the branch.

stage: Option<Stage>

Describes the current stage for the branch.

enable_notification: Option<bool>

Enables notifications for the branch.

enable_auto_build: Option<bool>

Enables auto building for the branch.

environment_variables: Option<HashMap<String, String>>

The environment variables for the branch.

basic_auth_credentials: Option<String>

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

enable_basic_auth: Option<bool>

Enables basic authorization for the branch.

enable_performance_mode: Option<bool>

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.

build_spec: Option<String>

The build specification (build spec) for the branch.

ttl: Option<String>

The content Time to Live (TTL) for the website in seconds.

display_name: Option<String>

The display name for a branch. This is used as the default domain prefix.

enable_pull_request_preview: Option<bool>

Enables pull request previews for this branch.

pull_request_environment_name: Option<String>

The Amplify environment name for the pull request.

backend_environment_arn: Option<String>

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

backend: Option<Backend>

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Implementations

impl UpdateBranchInput

pub fn app_id(&self) -> Option<&str>

The unique ID for an Amplify app.

pub fn branch_name(&self) -> Option<&str>

The name of the branch.

pub fn description(&self) -> Option<&str>

The description for the branch.

pub fn framework(&self) -> Option<&str>

The framework for the branch.

pub fn stage(&self) -> Option<&Stage>

Describes the current stage for the branch.

pub fn enable_notification(&self) -> Option<bool>

Enables notifications for the branch.

pub fn enable_auto_build(&self) -> Option<bool>

Enables auto building for the branch.

pub fn environment_variables(&self) -> Option<&HashMap<String, String>>

The environment variables for the branch.

pub fn basic_auth_credentials(&self) -> Option<&str>

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

pub fn enable_basic_auth(&self) -> Option<bool>

Enables basic authorization for the branch.

pub fn enable_performance_mode(&self) -> Option<bool>

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.

pub fn build_spec(&self) -> Option<&str>

The build specification (build spec) for the branch.

pub fn ttl(&self) -> Option<&str>

The content Time to Live (TTL) for the website in seconds.

pub fn display_name(&self) -> Option<&str>

The display name for a branch. This is used as the default domain prefix.

pub fn enable_pull_request_preview(&self) -> Option<bool>

Enables pull request previews for this branch.

pub fn pull_request_environment_name(&self) -> Option<&str>

The Amplify environment name for the pull request.

pub fn backend_environment_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

pub fn backend(&self) -> Option<&Backend>

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

impl UpdateBranchInput

pub fn builder() -> UpdateBranchInputBuilder

Creates a new builder-style object to manufacture UpdateBranchInput.

Trait Implementations

impl Clone for UpdateBranchInput

fn clone(&self) -> UpdateBranchInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateBranchInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateBranchInput

fn eq(&self, other: &UpdateBranchInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateBranchInput