Struct CreateBranchRequest 

pub struct CreateBranchRequest {

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

The request structure for the create branch request.

Fields

app_id: String

The unique ID for an Amplify app.

backend_environment_arn: Option<String>

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

basic_auth_credentials: Option<String>

The basic authorization credentials for the branch.

branch_name: String

The name for the branch.

build_spec: Option<String>

The build specification (build spec) for the branch.

description: Option<String>

The description for the branch.

display_name: Option<String>

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

enable_auto_build: Option<bool>

Enables auto building for the branch.

enable_basic_auth: Option<bool>

Enables basic authorization for the branch.

enable_notification: Option<bool>

Enables notifications 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.

enable_pull_request_preview: Option<bool>

Enables pull request previews for this branch.

environment_variables: Option<HashMap<String, String>>

The environment variables for the branch.

framework: Option<String>

The framework for the branch.

pull_request_environment_name: Option<String>

The Amplify environment name for the pull request.

stage: Option<String>

Describes the current stage for the branch.

tags: Option<HashMap<String, String>>

The tag for the branch.

ttl: Option<String>

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

Trait Implementations

impl Clone for CreateBranchRequest

fn clone(&self) -> CreateBranchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBranchRequest

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

Formats the value using the given formatter.

impl Default for CreateBranchRequest

fn default() -> CreateBranchRequest

Returns the “default value” for a type.

impl PartialEq for CreateBranchRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CreateBranchRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateBranchRequest