#[non_exhaustive]pub struct App {Show 29 fields
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 compute_role_arn: Option<String>,
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>,
pub cache_config: Option<CacheConfig>,
pub webhook_create_time: Option<DateTime>,
pub waf_configuration: Option<WafConfiguration>,
pub job_config: Option<JobConfig>,
}Expand description
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.app_id: StringThe unique ID of the Amplify app.
app_arn: StringThe Amazon Resource Name (ARN) of the Amplify app.
name: StringThe name for the Amplify app.
The tag for the Amplify app.
description: StringThe description for the Amplify app.
repository: StringThe Git repository for the Amplify app.
platform: PlatformThe 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.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
create_time: DateTimeA timestamp of when Amplify created the application.
update_time: DateTimeA timestamp of when Amplify updated the application.
compute_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role for an SSR app. The 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.
iam_service_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM service role for 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: StringThe default domain for the Amplify app.
enable_branch_auto_build: boolEnables 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: boolEnables 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.
cache_config: Option<CacheConfig>The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
webhook_create_time: Option<DateTime>A timestamp of when Amplify created the webhook in your Git repository.
waf_configuration: Option<WafConfiguration>Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
job_config: Option<JobConfig>The configuration details that apply to the jobs for an Amplify app.
Implementations§
Source§impl App
impl App
The tag for the Amplify app.
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
The description for the Amplify app.
Sourcepub fn repository(&self) -> &str
pub fn repository(&self) -> &str
The Git repository for the Amplify app.
Sourcepub fn platform(&self) -> &Platform
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.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
Sourcepub fn create_time(&self) -> &DateTime
pub fn create_time(&self) -> &DateTime
A timestamp of when Amplify created the application.
Sourcepub fn update_time(&self) -> &DateTime
pub fn update_time(&self) -> &DateTime
A timestamp of when Amplify updated the application.
Sourcepub fn compute_role_arn(&self) -> Option<&str>
pub fn compute_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The 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 iam_service_role_arn(&self) -> Option<&str>
pub fn iam_service_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
Sourcepub fn environment_variables(&self) -> &HashMap<String, String>
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.
Sourcepub fn default_domain(&self) -> &str
pub fn default_domain(&self) -> &str
The default domain for the Amplify app.
Sourcepub fn enable_branch_auto_build(&self) -> bool
pub fn enable_branch_auto_build(&self) -> bool
Enables the auto-building of branches for the Amplify app.
Sourcepub fn enable_branch_auto_deletion(&self) -> Option<bool>
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.
Sourcepub fn enable_basic_auth(&self) -> bool
pub fn enable_basic_auth(&self) -> bool
Enables basic authorization for the Amplify app's branches.
Sourcepub fn basic_auth_credentials(&self) -> Option<&str>
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.
Sourcepub fn custom_rules(&self) -> &[CustomRule]
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().
Sourcepub fn production_branch(&self) -> Option<&ProductionBranch>
pub fn production_branch(&self) -> Option<&ProductionBranch>
Describes the information about a production branch of the Amplify app.
Sourcepub fn build_spec(&self) -> Option<&str>
pub fn build_spec(&self) -> Option<&str>
Describes the content of the build specification (build spec) for the Amplify app.
Sourcepub fn custom_headers(&self) -> Option<&str>
pub fn custom_headers(&self) -> Option<&str>
Describes the custom HTTP headers for the Amplify app.
Sourcepub fn enable_auto_branch_creation(&self) -> Option<bool>
pub fn enable_auto_branch_creation(&self) -> Option<bool>
Enables automated branch creation for the Amplify app.
Sourcepub fn auto_branch_creation_patterns(&self) -> &[String]
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().
Sourcepub fn auto_branch_creation_config(&self) -> Option<&AutoBranchCreationConfig>
pub fn auto_branch_creation_config(&self) -> Option<&AutoBranchCreationConfig>
Describes the automated branch creation configuration for the Amplify app.
Sourcepub fn repository_clone_method(&self) -> Option<&RepositoryCloneMethod>
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.
Sourcepub fn cache_config(&self) -> Option<&CacheConfig>
pub fn cache_config(&self) -> Option<&CacheConfig>
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
Sourcepub fn webhook_create_time(&self) -> Option<&DateTime>
pub fn webhook_create_time(&self) -> Option<&DateTime>
A timestamp of when Amplify created the webhook in your Git repository.
Sourcepub fn waf_configuration(&self) -> Option<&WafConfiguration>
pub fn waf_configuration(&self) -> Option<&WafConfiguration>
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
Sourcepub fn job_config(&self) -> Option<&JobConfig>
pub fn job_config(&self) -> Option<&JobConfig>
The configuration details that apply to the jobs for an Amplify app.
Trait Implementations§
impl StructuralPartialEq for App
Auto Trait Implementations§
impl Freeze for App
impl RefUnwindSafe for App
impl Send for App
impl Sync for App
impl Unpin for App
impl UnwindSafe for App
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);