Struct aws_sdk_amplify::types::Branch

#[non_exhaustive]
pub struct Branch {

    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 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>,
}

The branch for an Amplify app, which maps to a third-party repository branch.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

branch_arn: String

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

branch_name: String

The name for the branch that is part of an Amplify app.

description: String

The description for the branch that is part of an Amplify app.

tags: Option<HashMap<String, String>>

The tag for the branch of an Amplify app.

stage: Stage

The current stage for the branch that is part of an Amplify app.

display_name: String

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

enable_notification: bool

Enables notifications for a branch that is part of an Amplify app.

create_time: DateTime

The creation date and time for a branch that is part of an Amplify app.

update_time: DateTime

The last updated date and time for a branch that is part of an Amplify app.

environment_variables: HashMap<String, String>

The environment variables specific to a branch of an Amplify app.

enable_auto_build: bool

Enables auto-building on push for a branch of an Amplify app.

custom_domains: Vec<String>

The custom domains for a branch of an Amplify app.

framework: String

The framework for a branch of an Amplify app.

active_job_id: String

The ID of the active job for a branch of an Amplify app.

total_number_of_jobs: String

The total number of jobs that are part of an Amplify app.

enable_basic_auth: bool

Enables 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: String

The 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: bool

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

backend: Option<Backend>

Describes the backend properties associated with an Amplify Branch.

Implementations

impl Branch

pub fn branch_arn(&self) -> &str

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

pub fn branch_name(&self) -> &str

The name for the branch that is part of an Amplify app.

pub fn description(&self) -> &str

The description for the branch that is part of an Amplify app.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tag for the branch of an Amplify app.

pub fn stage(&self) -> &Stage

The current stage for the branch that is part of an Amplify app.

pub fn display_name(&self) -> &str

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

pub fn enable_notification(&self) -> bool

Enables notifications for a branch that is part of an Amplify app.

pub fn create_time(&self) -> &DateTime

The creation date and time for a branch that is part of an Amplify app.

pub fn update_time(&self) -> &DateTime

The last updated date and time for a branch that is part of an Amplify app.

pub fn environment_variables(&self) -> &HashMap<String, String>

The environment variables specific to a branch of an Amplify app.

pub fn enable_auto_build(&self) -> bool

Enables auto-building on push for a branch of an Amplify app.

pub fn custom_domains(&self) -> &[String]

The custom domains for a branch of an Amplify app.

pub fn framework(&self) -> &str

The framework for a branch of an Amplify app.

pub fn active_job_id(&self) -> &str

The ID of the active job for a branch of an Amplify app.

pub fn total_number_of_jobs(&self) -> &str

The total number of jobs that are part of an Amplify app.

pub fn enable_basic_auth(&self) -> bool

Enables basic authorization for a branch of an Amplify app.

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.

pub fn thumbnail_url(&self) -> Option<&str>

The thumbnail URL for the branch of an Amplify app.

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.

pub fn build_spec(&self) -> Option<&str>

The build specification (build spec) content for the branch of an Amplify app.

pub fn ttl(&self) -> &str

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

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().

pub fn enable_pull_request_preview(&self) -> bool

Enables pull request previews for the branch.

pub fn pull_request_environment_name(&self) -> Option<&str>

The Amplify environment name for the pull request.

pub fn destination_branch(&self) -> Option<&str>

The destination branch if the branch is a pull request branch.

pub fn source_branch(&self) -> Option<&str>

The source branch if the branch is a pull request branch.

pub fn backend_environment_arn(&self) -> Option<&str>

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

pub fn backend(&self) -> Option<&Backend>

Describes the backend properties associated with an Amplify Branch.

impl Branch

pub fn builder() -> BranchBuilder

Creates a new builder-style object to manufacture Branch.

Trait Implementations

impl Clone for Branch

fn clone(&self) -> Branch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Branch

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

Formats the value using the given formatter.

impl PartialEq for Branch

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Branch