#[non_exhaustive]pub struct CreateBranchInput {Show 21 fields
pub app_id: Option<String>,
pub branch_name: Option<String>,
pub description: Option<String>,
pub stage: Option<Stage>,
pub framework: Option<String>,
pub enable_notification: Option<bool>,
pub enable_auto_build: Option<bool>,
pub enable_skew_protection: 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 tags: Option<HashMap<String, String>>,
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>,
pub compute_role_arn: Option<String>,
}Expand description
The request structure for the create branch request.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 for the branch.
description: Option<String>The description for the branch.
stage: Option<Stage>Describes the current stage for the branch.
framework: Option<String>The framework for the branch.
enable_notification: Option<bool>Enables notifications for the branch.
enable_auto_build: Option<bool>Enables auto building for the branch.
enable_skew_protection: Option<bool>Specifies whether the skew protection feature is enabled for the branch.
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.
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.
The tag for the branch.
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.
compute_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
Implementations§
Source§impl CreateBranchInput
impl CreateBranchInput
Sourcepub fn branch_name(&self) -> Option<&str>
pub fn branch_name(&self) -> Option<&str>
The name for the branch.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description for the branch.
Sourcepub fn enable_notification(&self) -> Option<bool>
pub fn enable_notification(&self) -> Option<bool>
Enables notifications for the branch.
Sourcepub fn enable_auto_build(&self) -> Option<bool>
pub fn enable_auto_build(&self) -> Option<bool>
Enables auto building for the branch.
Sourcepub fn enable_skew_protection(&self) -> Option<bool>
pub fn enable_skew_protection(&self) -> Option<bool>
Specifies whether the skew protection feature is enabled for the branch.
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.
Sourcepub fn environment_variables(&self) -> Option<&HashMap<String, String>>
pub fn environment_variables(&self) -> Option<&HashMap<String, String>>
The environment variables for the branch.
Sourcepub fn basic_auth_credentials(&self) -> Option<&str>
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.
Sourcepub fn enable_basic_auth(&self) -> Option<bool>
pub fn enable_basic_auth(&self) -> Option<bool>
Enables basic authorization for the branch.
Sourcepub fn enable_performance_mode(&self) -> Option<bool>
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.
The tag for the branch.
Sourcepub fn build_spec(&self) -> Option<&str>
pub fn build_spec(&self) -> Option<&str>
The build specification (build spec) for the branch.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
The display name for a branch. This is used as the default domain prefix.
Sourcepub fn enable_pull_request_preview(&self) -> Option<bool>
pub fn enable_pull_request_preview(&self) -> Option<bool>
Enables pull request previews for this branch.
Sourcepub fn pull_request_environment_name(&self) -> Option<&str>
pub fn pull_request_environment_name(&self) -> Option<&str>
The Amplify environment name for the pull request.
Sourcepub fn backend_environment_arn(&self) -> Option<&str>
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).
Sourcepub fn backend(&self) -> Option<&Backend>
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.
Sourcepub fn compute_role_arn(&self) -> Option<&str>
pub fn compute_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
Source§impl CreateBranchInput
impl CreateBranchInput
Sourcepub fn builder() -> CreateBranchInputBuilder
pub fn builder() -> CreateBranchInputBuilder
Creates a new builder-style object to manufacture CreateBranchInput.
Trait Implementations§
Source§impl Clone for CreateBranchInput
impl Clone for CreateBranchInput
Source§fn clone(&self) -> CreateBranchInput
fn clone(&self) -> CreateBranchInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateBranchInput
impl Debug for CreateBranchInput
Source§impl PartialEq for CreateBranchInput
impl PartialEq for CreateBranchInput
impl StructuralPartialEq for CreateBranchInput
Auto Trait Implementations§
impl Freeze for CreateBranchInput
impl RefUnwindSafe for CreateBranchInput
impl Send for CreateBranchInput
impl Sync for CreateBranchInput
impl Unpin for CreateBranchInput
impl UnwindSafe for CreateBranchInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);