Struct aws_sdk_amplify::client::fluent_builders::CreateBranch

pub struct CreateBranch<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateBranch.

Creates a new branch for an Amplify app.

Implementations

impl<C, M, R> CreateBranch<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateBranchOutput, SdkError<CreateBranchError>> where
    R::Policy: SmithyRetryPolicy<CreateBranchInputOperationOutputAlias, CreateBranchOutput, CreateBranchError, CreateBranchInputOperationRetryAlias>, 

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.

pub fn app_id(self, input: impl Into<String>) -> Self

The unique ID for an Amplify app.

pub fn set_app_id(self, input: Option<String>) -> Self

The unique ID for an Amplify app.

pub fn branch_name(self, input: impl Into<String>) -> Self

The name for the branch.

pub fn set_branch_name(self, input: Option<String>) -> Self

The name for the branch.

pub fn description(self, input: impl Into<String>) -> Self

The description for the branch.

pub fn set_description(self, input: Option<String>) -> Self

The description for the branch.

pub fn stage(self, input: Stage) -> Self

Describes the current stage for the branch.

pub fn set_stage(self, input: Option<Stage>) -> Self

Describes the current stage for the branch.

pub fn framework(self, input: impl Into<String>) -> Self

The framework for the branch.

pub fn set_framework(self, input: Option<String>) -> Self

The framework for the branch.

pub fn enable_notification(self, input: bool) -> Self

Enables notifications for the branch.

pub fn set_enable_notification(self, input: Option<bool>) -> Self

Enables notifications for the branch.

pub fn enable_auto_build(self, input: bool) -> Self

Enables auto building for the branch.

pub fn set_enable_auto_build(self, input: Option<bool>) -> Self

Enables auto building for the branch.

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.

pub fn set_environment_variables(
    self,
    input: Option<HashMap<String, String>>
) -> Self

The environment variables for the branch.

pub fn basic_auth_credentials(self, input: impl Into<String>) -> Self

The basic authorization credentials for the branch.

pub fn set_basic_auth_credentials(self, input: Option<String>) -> Self

The basic authorization credentials for the branch.

pub fn enable_basic_auth(self, input: bool) -> Self

Enables basic authorization for the branch.

pub fn set_enable_basic_auth(self, input: Option<bool>) -> Self

Enables basic authorization for the branch.

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.

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.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tag for the branch.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tag for the branch.

pub fn build_spec(self, input: impl Into<String>) -> Self

The build specification (build spec) for the branch.

pub fn set_build_spec(self, input: Option<String>) -> Self

The build specification (build spec) for the branch.

pub fn ttl(self, input: impl Into<String>) -> Self

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

pub fn set_ttl(self, input: Option<String>) -> Self

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

pub fn display_name(self, input: impl Into<String>) -> Self

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

pub fn set_display_name(self, input: Option<String>) -> Self

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

pub fn enable_pull_request_preview(self, input: bool) -> Self

Enables pull request previews for this branch.

pub fn set_enable_pull_request_preview(self, input: Option<bool>) -> Self

Enables pull request previews for this branch.

pub fn pull_request_environment_name(self, input: impl Into<String>) -> Self

The Amplify environment name for the pull request.

pub fn set_pull_request_environment_name(self, input: Option<String>) -> Self

The Amplify environment name for the pull request.

pub fn backend_environment_arn(self, input: impl Into<String>) -> Self

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

pub fn set_backend_environment_arn(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateBranch<C, M, R>

fn clone(&self) -> CreateBranch<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateBranch<C, M, R>

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

Formats the value using the given formatter.