Struct aws_sdk_amplify::types::App

#[non_exhaustive]
pub struct App {

    pub app_id: String,
    pub app_arn: String,
    pub name: String,
    pub tags: Option<HashMap<String, String>>,
    pub description: String,
    pub repository: String,
    pub platform: Platform,
    pub create_time: DateTime,
    pub update_time: DateTime,
    pub iam_service_role_arn: Option<String>,
    pub environment_variables: HashMap<String, String>,
    pub default_domain: String,
    pub enable_branch_auto_build: bool,
    pub enable_branch_auto_deletion: Option<bool>,
    pub enable_basic_auth: bool,
    pub basic_auth_credentials: Option<String>,
    pub custom_rules: Option<Vec<CustomRule>>,
    pub production_branch: Option<ProductionBranch>,
    pub build_spec: Option<String>,
    pub custom_headers: Option<String>,
    pub enable_auto_branch_creation: Option<bool>,
    pub auto_branch_creation_patterns: Option<Vec<String>>,
    pub auto_branch_creation_config: Option<AutoBranchCreationConfig>,
    pub repository_clone_method: Option<RepositoryCloneMethod>,
}

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

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.

app_id: String

The unique ID of the Amplify app.

app_arn: String

The Amazon Resource Name (ARN) of the Amplify app.

name: String

The name for the Amplify app.

tags: Option<HashMap<String, String>>

The tag for the Amplify app.

description: String

The description for the Amplify app.

repository: String

The Git repository for the Amplify app.

platform: Platform

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

create_time: DateTime

Creates a date and time for the Amplify app.

update_time: DateTime

Updates the date and time for the Amplify app.

iam_service_role_arn: Option<String>

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

environment_variables: HashMap<String, String>

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

default_domain: String

The default domain for the Amplify app.

enable_branch_auto_build: bool

Enables the auto-building of branches for the Amplify app.

enable_branch_auto_deletion: Option<bool>

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

enable_basic_auth: bool

Enables basic authorization for the Amplify app's branches.

basic_auth_credentials: Option<String>

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

custom_rules: Option<Vec<CustomRule>>

Describes the custom redirect and rewrite rules for the Amplify app.

production_branch: Option<ProductionBranch>

Describes the information about a production branch of the Amplify app.

build_spec: Option<String>

Describes the content of the build specification (build spec) for the Amplify app.

custom_headers: Option<String>

Describes the custom HTTP headers for the Amplify app.

enable_auto_branch_creation: Option<bool>

Enables automated branch creation for the Amplify app.

auto_branch_creation_patterns: Option<Vec<String>>

Describes the automated branch creation glob patterns for the Amplify app.

auto_branch_creation_config: Option<AutoBranchCreationConfig>

Describes the automated branch creation configuration for the Amplify app.

repository_clone_method: Option<RepositoryCloneMethod>

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

Implementations

impl App

pub fn app_id(&self) -> &str

The unique ID of the Amplify app.

pub fn app_arn(&self) -> &str

The Amazon Resource Name (ARN) of the Amplify app.

pub fn name(&self) -> &str

The name for the Amplify app.

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

The tag for the Amplify app.

pub fn description(&self) -> &str

The description for the Amplify app.

pub fn repository(&self) -> &str

The Git repository for the Amplify app.

pub fn platform(&self) -> &Platform

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

pub fn create_time(&self) -> &DateTime

Creates a date and time for the Amplify app.

pub fn update_time(&self) -> &DateTime

Updates the date and time for the Amplify app.

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

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

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

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

pub fn default_domain(&self) -> &str

The default domain for the Amplify app.

pub fn enable_branch_auto_build(&self) -> bool

Enables the auto-building of branches for the Amplify app.

pub fn enable_branch_auto_deletion(&self) -> Option<bool>

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

pub fn enable_basic_auth(&self) -> bool

Enables basic authorization for the Amplify app's branches.

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

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

pub fn custom_rules(&self) -> &[CustomRule]

Describes the custom redirect and rewrite rules for the Amplify app.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_rules.is_none().

pub fn production_branch(&self) -> Option<&ProductionBranch>

Describes the information about a production branch of the Amplify app.

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

Describes the content of the build specification (build spec) for the Amplify app.

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

Describes the custom HTTP headers for the Amplify app.

pub fn enable_auto_branch_creation(&self) -> Option<bool>

Enables automated branch creation for the Amplify app.

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

Describes the automated branch creation glob patterns for the Amplify app.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auto_branch_creation_patterns.is_none().

pub fn auto_branch_creation_config(&self) -> Option<&AutoBranchCreationConfig>

Describes the automated branch creation configuration for the Amplify app.

pub fn repository_clone_method(&self) -> Option<&RepositoryCloneMethod>

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

impl App

pub fn builder() -> AppBuilder

Creates a new builder-style object to manufacture App.

Trait Implementations

impl Clone for App

fn clone(&self) -> App

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for App

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

Formats the value using the given formatter.

impl PartialEq for App

fn eq(&self, other: &App) -> 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 App