#[non_exhaustive]pub struct Branch {Show 30 fields
pub branch_arn: String,
pub branch_name: String,
pub description: String,
pub tags: Option<HashMap<String, String>>,
pub stage: Stage,
pub display_name: String,
pub enable_notification: bool,
pub create_time: DateTime,
pub update_time: DateTime,
pub environment_variables: HashMap<String, String>,
pub enable_auto_build: bool,
pub enable_skew_protection: Option<bool>,
pub custom_domains: Vec<String>,
pub framework: String,
pub active_job_id: String,
pub total_number_of_jobs: String,
pub enable_basic_auth: bool,
pub enable_performance_mode: Option<bool>,
pub thumbnail_url: Option<String>,
pub basic_auth_credentials: Option<String>,
pub build_spec: Option<String>,
pub ttl: String,
pub associated_resources: Option<Vec<String>>,
pub enable_pull_request_preview: bool,
pub pull_request_environment_name: Option<String>,
pub destination_branch: Option<String>,
pub source_branch: Option<String>,
pub backend_environment_arn: Option<String>,
pub backend: Option<Backend>,
pub compute_role_arn: Option<String>,
}Expand description
The branch for an Amplify app, which maps to a third-party repository branch.
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.branch_arn: StringThe Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branch_name: StringThe name for the branch that is part of an Amplify app.
description: StringThe description for the branch that is part of an Amplify app.
The tag for the branch of an Amplify app.
stage: StageThe current stage for the branch that is part of an Amplify app.
display_name: StringThe display name for the branch. This is used as the default domain prefix.
enable_notification: boolEnables notifications for a branch that is part of an Amplify app.
create_time: DateTimeA timestamp of when Amplify created the branch.
update_time: DateTimeA timestamp for the last updated time for a branch.
environment_variables: HashMap<String, String>The environment variables specific to a branch of an Amplify app.
enable_auto_build: boolEnables auto-building on push for a branch of an Amplify app.
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.
custom_domains: Vec<String>The custom domains for a branch of an Amplify app.
framework: StringThe framework for a branch of an Amplify app.
active_job_id: StringThe ID of the active job for a branch of an Amplify app.
total_number_of_jobs: StringThe total number of jobs that are part of an Amplify app.
enable_basic_auth: boolEnables basic authorization for a branch of an Amplify app.
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.
thumbnail_url: Option<String>The thumbnail URL for the branch of an Amplify app.
basic_auth_credentials: Option<String>The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
build_spec: Option<String>The build specification (build spec) content for the branch of an Amplify app.
ttl: StringThe content Time to Live (TTL) for the website in seconds.
associated_resources: Option<Vec<String>>A list of custom resources that are linked to this branch.
enable_pull_request_preview: boolEnables pull request previews for the branch.
pull_request_environment_name: Option<String>The Amplify environment name for the pull request.
destination_branch: Option<String>The destination branch if the branch is a pull request branch.
source_branch: Option<String>The source branch if the branch is a pull request branch.
backend_environment_arn: Option<String>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend: Option<Backend>Describes the backend associated with an Amplify Branch.
This property 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 for a branch of an SSR app. The 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 Branch
impl Branch
Sourcepub fn branch_arn(&self) -> &str
pub fn branch_arn(&self) -> &str
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
Sourcepub fn branch_name(&self) -> &str
pub fn branch_name(&self) -> &str
The name for the branch that is part of an Amplify app.
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
The description for the branch that is part of an Amplify app.
The tag for the branch of an Amplify app.
Sourcepub fn display_name(&self) -> &str
pub fn display_name(&self) -> &str
The display name for the branch. This is used as the default domain prefix.
Sourcepub fn enable_notification(&self) -> bool
pub fn enable_notification(&self) -> bool
Enables notifications for a branch that is part of an Amplify app.
Sourcepub fn create_time(&self) -> &DateTime
pub fn create_time(&self) -> &DateTime
A timestamp of when Amplify created the branch.
Sourcepub fn update_time(&self) -> &DateTime
pub fn update_time(&self) -> &DateTime
A timestamp for the last updated time for a branch.
Sourcepub fn environment_variables(&self) -> &HashMap<String, String>
pub fn environment_variables(&self) -> &HashMap<String, String>
The environment variables specific to a branch of an Amplify app.
Sourcepub fn enable_auto_build(&self) -> bool
pub fn enable_auto_build(&self) -> bool
Enables auto-building on push for a branch of an Amplify app.
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 custom_domains(&self) -> &[String]
pub fn custom_domains(&self) -> &[String]
The custom domains for a branch of an Amplify app.
Sourcepub fn active_job_id(&self) -> &str
pub fn active_job_id(&self) -> &str
The ID of the active job for a branch of an Amplify app.
Sourcepub fn total_number_of_jobs(&self) -> &str
pub fn total_number_of_jobs(&self) -> &str
The total number of jobs that are part of an Amplify app.
Sourcepub fn enable_basic_auth(&self) -> bool
pub fn enable_basic_auth(&self) -> bool
Enables basic authorization for a branch of an Amplify app.
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.
Sourcepub fn thumbnail_url(&self) -> Option<&str>
pub fn thumbnail_url(&self) -> Option<&str>
The thumbnail URL for the branch of an Amplify app.
Sourcepub fn basic_auth_credentials(&self) -> Option<&str>
pub fn basic_auth_credentials(&self) -> Option<&str>
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
Sourcepub fn build_spec(&self) -> Option<&str>
pub fn build_spec(&self) -> Option<&str>
The build specification (build spec) content for the branch of an Amplify app.
Sourcepub fn associated_resources(&self) -> &[String]
pub fn associated_resources(&self) -> &[String]
A list of custom resources that are linked to this branch.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .associated_resources.is_none().
Sourcepub fn enable_pull_request_preview(&self) -> bool
pub fn enable_pull_request_preview(&self) -> bool
Enables pull request previews for the 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 destination_branch(&self) -> Option<&str>
pub fn destination_branch(&self) -> Option<&str>
The destination branch if the branch is a pull request branch.
Sourcepub fn source_branch(&self) -> Option<&str>
pub fn source_branch(&self) -> Option<&str>
The source branch if the branch is a pull request branch.
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 an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
Sourcepub fn backend(&self) -> Option<&Backend>
pub fn backend(&self) -> Option<&Backend>
Describes the backend associated with an Amplify Branch.
This property 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 for a branch of an SSR app. The 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.
Trait Implementations§
impl StructuralPartialEq for Branch
Auto Trait Implementations§
impl Freeze for Branch
impl RefUnwindSafe for Branch
impl Send for Branch
impl Sync for Branch
impl Unpin for Branch
impl UnwindSafe for Branch
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);