pub struct CreateBranchFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateBranch
.
Creates a new branch for an Amplify app.
Implementations§
Source§impl CreateBranchFluentBuilder
impl CreateBranchFluentBuilder
Sourcepub fn as_input(&self) -> &CreateBranchInputBuilder
pub fn as_input(&self) -> &CreateBranchInputBuilder
Access the CreateBranch as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateBranchOutput, SdkError<CreateBranchError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateBranchOutput, SdkError<CreateBranchError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateBranchOutput, CreateBranchError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateBranchOutput, CreateBranchError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_app_id(self, input: Option<String>) -> Self
pub fn set_app_id(self, input: Option<String>) -> Self
The unique ID for an Amplify app.
Sourcepub fn get_app_id(&self) -> &Option<String>
pub fn get_app_id(&self) -> &Option<String>
The unique ID for an Amplify app.
Sourcepub fn branch_name(self, input: impl Into<String>) -> Self
pub fn branch_name(self, input: impl Into<String>) -> Self
The name for the branch.
Sourcepub fn set_branch_name(self, input: Option<String>) -> Self
pub fn set_branch_name(self, input: Option<String>) -> Self
The name for the branch.
Sourcepub fn get_branch_name(&self) -> &Option<String>
pub fn get_branch_name(&self) -> &Option<String>
The name for the branch.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description for the branch.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description for the branch.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description for the branch.
Sourcepub fn set_stage(self, input: Option<Stage>) -> Self
pub fn set_stage(self, input: Option<Stage>) -> Self
Describes the current stage for the branch.
Sourcepub fn set_framework(self, input: Option<String>) -> Self
pub fn set_framework(self, input: Option<String>) -> Self
The framework for the branch.
Sourcepub fn get_framework(&self) -> &Option<String>
pub fn get_framework(&self) -> &Option<String>
The framework for the branch.
Sourcepub fn enable_notification(self, input: bool) -> Self
pub fn enable_notification(self, input: bool) -> Self
Enables notifications for the branch.
Sourcepub fn set_enable_notification(self, input: Option<bool>) -> Self
pub fn set_enable_notification(self, input: Option<bool>) -> Self
Enables notifications for the branch.
Sourcepub fn get_enable_notification(&self) -> &Option<bool>
pub fn get_enable_notification(&self) -> &Option<bool>
Enables notifications for the branch.
Sourcepub fn enable_auto_build(self, input: bool) -> Self
pub fn enable_auto_build(self, input: bool) -> Self
Enables auto building for the branch.
Sourcepub fn set_enable_auto_build(self, input: Option<bool>) -> Self
pub fn set_enable_auto_build(self, input: Option<bool>) -> Self
Enables auto building for the branch.
Sourcepub fn get_enable_auto_build(&self) -> &Option<bool>
pub fn get_enable_auto_build(&self) -> &Option<bool>
Enables auto building for the branch.
Sourcepub fn enable_skew_protection(self, input: bool) -> Self
pub fn enable_skew_protection(self, input: bool) -> Self
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 set_enable_skew_protection(self, input: Option<bool>) -> Self
pub fn set_enable_skew_protection(self, input: Option<bool>) -> Self
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 get_enable_skew_protection(&self) -> &Option<bool>
pub fn get_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,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn environment_variables( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to environmentVariables
.
To override the contents of this collection use set_environment_variables
.
The environment variables for the branch.
Sourcepub fn set_environment_variables(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_environment_variables( self, input: Option<HashMap<String, String>>, ) -> Self
The environment variables for the branch.
Sourcepub fn get_environment_variables(&self) -> &Option<HashMap<String, String>>
pub fn get_environment_variables(&self) -> &Option<HashMap<String, String>>
The environment variables for the branch.
Sourcepub fn basic_auth_credentials(self, input: impl Into<String>) -> Self
pub fn basic_auth_credentials(self, input: impl Into<String>) -> Self
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password
.
Sourcepub fn set_basic_auth_credentials(self, input: Option<String>) -> Self
pub fn set_basic_auth_credentials(self, input: Option<String>) -> Self
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password
.
Sourcepub fn get_basic_auth_credentials(&self) -> &Option<String>
pub fn get_basic_auth_credentials(&self) -> &Option<String>
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, input: bool) -> Self
pub fn enable_basic_auth(self, input: bool) -> Self
Enables basic authorization for the branch.
Sourcepub fn set_enable_basic_auth(self, input: Option<bool>) -> Self
pub fn set_enable_basic_auth(self, input: Option<bool>) -> Self
Enables basic authorization for the branch.
Sourcepub fn get_enable_basic_auth(&self) -> &Option<bool>
pub fn get_enable_basic_auth(&self) -> &Option<bool>
Enables basic authorization for the branch.
Sourcepub fn enable_performance_mode(self, input: bool) -> Self
pub fn enable_performance_mode(self, input: bool) -> Self
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 set_enable_performance_mode(self, input: Option<bool>) -> Self
pub fn set_enable_performance_mode(self, input: Option<bool>) -> Self
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 get_enable_performance_mode(&self) -> &Option<bool>
pub fn get_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.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tag for the branch.
The tag for the branch.
The tag for the branch.
Sourcepub fn build_spec(self, input: impl Into<String>) -> Self
pub fn build_spec(self, input: impl Into<String>) -> Self
The build specification (build spec) for the branch.
Sourcepub fn set_build_spec(self, input: Option<String>) -> Self
pub fn set_build_spec(self, input: Option<String>) -> Self
The build specification (build spec) for the branch.
Sourcepub fn get_build_spec(&self) -> &Option<String>
pub fn get_build_spec(&self) -> &Option<String>
The build specification (build spec) for the branch.
Sourcepub fn ttl(self, input: impl Into<String>) -> Self
pub fn ttl(self, input: impl Into<String>) -> Self
The content Time To Live (TTL) for the website in seconds.
Sourcepub fn set_ttl(self, input: Option<String>) -> Self
pub fn set_ttl(self, input: Option<String>) -> Self
The content Time To Live (TTL) for the website in seconds.
Sourcepub fn get_ttl(&self) -> &Option<String>
pub fn get_ttl(&self) -> &Option<String>
The content Time To Live (TTL) for the website in seconds.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The display name for a branch. This is used as the default domain prefix.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The display name for a branch. This is used as the default domain prefix.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The display name for a branch. This is used as the default domain prefix.
Sourcepub fn enable_pull_request_preview(self, input: bool) -> Self
pub fn enable_pull_request_preview(self, input: bool) -> Self
Enables pull request previews for this branch.
Sourcepub fn set_enable_pull_request_preview(self, input: Option<bool>) -> Self
pub fn set_enable_pull_request_preview(self, input: Option<bool>) -> Self
Enables pull request previews for this branch.
Sourcepub fn get_enable_pull_request_preview(&self) -> &Option<bool>
pub fn get_enable_pull_request_preview(&self) -> &Option<bool>
Enables pull request previews for this branch.
Sourcepub fn pull_request_environment_name(self, input: impl Into<String>) -> Self
pub fn pull_request_environment_name(self, input: impl Into<String>) -> Self
The Amplify environment name for the pull request.
Sourcepub fn set_pull_request_environment_name(self, input: Option<String>) -> Self
pub fn set_pull_request_environment_name(self, input: Option<String>) -> Self
The Amplify environment name for the pull request.
Sourcepub fn get_pull_request_environment_name(&self) -> &Option<String>
pub fn get_pull_request_environment_name(&self) -> &Option<String>
The Amplify environment name for the pull request.
Sourcepub fn backend_environment_arn(self, input: impl Into<String>) -> Self
pub fn backend_environment_arn(self, input: impl Into<String>) -> Self
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 set_backend_environment_arn(self, input: Option<String>) -> Self
pub fn set_backend_environment_arn(self, input: Option<String>) -> Self
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 get_backend_environment_arn(&self) -> &Option<String>
pub fn get_backend_environment_arn(&self) -> &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).
Sourcepub fn backend(self, input: Backend) -> Self
pub fn backend(self, input: Backend) -> Self
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 set_backend(self, input: Option<Backend>) -> Self
pub fn set_backend(self, input: Option<Backend>) -> Self
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 get_backend(&self) -> &Option<Backend>
pub fn get_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, input: impl Into<String>) -> Self
pub fn compute_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_compute_role_arn(self, input: Option<String>) -> Self
pub fn set_compute_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_compute_role_arn(&self) -> &Option<String>
pub fn get_compute_role_arn(&self) -> &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.
Trait Implementations§
Source§impl Clone for CreateBranchFluentBuilder
impl Clone for CreateBranchFluentBuilder
Source§fn clone(&self) -> CreateBranchFluentBuilder
fn clone(&self) -> CreateBranchFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateBranchFluentBuilder
impl !RefUnwindSafe for CreateBranchFluentBuilder
impl Send for CreateBranchFluentBuilder
impl Sync for CreateBranchFluentBuilder
impl Unpin for CreateBranchFluentBuilder
impl !UnwindSafe for CreateBranchFluentBuilder
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);