Struct aws_sdk_amplify::types::builders::AppBuilder

#[non_exhaustive]
pub struct AppBuilder { /* private fields */ }

A builder for App.

Implementations

impl AppBuilder

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

The unique ID of the Amplify app.

This field is required.

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

The unique ID of the Amplify app.

pub fn get_app_id(&self) -> &Option<String>

The unique ID of the Amplify app.

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

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

This field is required.

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

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

pub fn get_app_arn(&self) -> &Option<String>

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

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

The name for the Amplify app.

This field is required.

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

The name for the Amplify app.

pub fn get_name(&self) -> &Option<String>

The name for the Amplify app.

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 Amplify app.

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

The tag for the Amplify app.

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

The tag for the Amplify app.

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

The description for the Amplify app.

This field is required.

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

The description for the Amplify app.

pub fn get_description(&self) -> &Option<String>

The description for the Amplify app.

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

The Git repository for the Amplify app.

This field is required.

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

The Git repository for the Amplify app.

pub fn get_repository(&self) -> &Option<String>

The Git repository for the Amplify app.

pub fn platform(self, input: Platform) -> Self

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.

This field is required.

pub fn set_platform(self, input: Option<Platform>) -> Self

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 get_platform(&self) -> &Option<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, input: DateTime) -> Self

Creates a date and time for the Amplify app.

This field is required.

pub fn set_create_time(self, input: Option<DateTime>) -> Self

Creates a date and time for the Amplify app.

pub fn get_create_time(&self) -> &Option<DateTime>

Creates a date and time for the Amplify app.

pub fn update_time(self, input: DateTime) -> Self

Updates the date and time for the Amplify app.

This field is required.

pub fn set_update_time(self, input: Option<DateTime>) -> Self

Updates the date and time for the Amplify app.

pub fn get_update_time(&self) -> &Option<DateTime>

Updates the date and time for the Amplify app.

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

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

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

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

pub fn get_iam_service_role_arn(&self) -> &Option<String>

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

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

Adds a key-value pair to environment_variables.

To override the contents of this collection use set_environment_variables.

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 set_environment_variables( self, input: Option<HashMap<String, String>> ) -> Self

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 get_environment_variables(&self) -> &Option<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, input: impl Into<String>) -> Self

The default domain for the Amplify app.

This field is required.

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

The default domain for the Amplify app.

pub fn get_default_domain(&self) -> &Option<String>

The default domain for the Amplify app.

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

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

This field is required.

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

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

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

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

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

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

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

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

pub fn get_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, input: bool) -> Self

Enables basic authorization for the Amplify app's branches.

This field is required.

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

Enables basic authorization for the Amplify app's branches.

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

Enables basic authorization for the Amplify app's branches.

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

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 set_basic_auth_credentials(self, input: Option<String>) -> Self

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 get_basic_auth_credentials(&self) -> &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.

pub fn custom_rules(self, input: CustomRule) -> Self

Appends an item to custom_rules.

To override the contents of this collection use set_custom_rules.

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

pub fn set_custom_rules(self, input: Option<Vec<CustomRule>>) -> Self

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

pub fn get_custom_rules(&self) -> &Option<Vec<CustomRule>>

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

pub fn production_branch(self, input: ProductionBranch) -> Self

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

pub fn set_production_branch(self, input: Option<ProductionBranch>) -> Self

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

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

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

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

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

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

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

pub fn get_build_spec(&self) -> &Option<String>

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

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

Describes the custom HTTP headers for the Amplify app.

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

Describes the custom HTTP headers for the Amplify app.

pub fn get_custom_headers(&self) -> &Option<String>

Describes the custom HTTP headers for the Amplify app.

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

Enables automated branch creation for the Amplify app.

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

Enables automated branch creation for the Amplify app.

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

Enables automated branch creation for the Amplify app.

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

Appends an item to auto_branch_creation_patterns.

To override the contents of this collection use set_auto_branch_creation_patterns.

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

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

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

pub fn get_auto_branch_creation_patterns(&self) -> &Option<Vec<String>>

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

pub fn auto_branch_creation_config( self, input: AutoBranchCreationConfig ) -> Self

Describes the automated branch creation configuration for the Amplify app.

pub fn set_auto_branch_creation_config( self, input: Option<AutoBranchCreationConfig> ) -> Self

Describes the automated branch creation configuration for the Amplify app.

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

Describes the automated branch creation configuration for the Amplify app.

pub fn repository_clone_method(self, input: RepositoryCloneMethod) -> Self

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.

pub fn set_repository_clone_method( self, input: Option<RepositoryCloneMethod> ) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<App, BuildError>

Consumes the builder and constructs a App. This method will fail if any of the following fields are not set:

• app_id
• app_arn
• name
• description
• repository
• platform
• create_time
• update_time
• environment_variables
• default_domain
• enable_branch_auto_build
• enable_basic_auth

Trait Implementations

impl Clone for AppBuilder

fn clone(&self) -> AppBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppBuilder

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

Formats the value using the given formatter.

impl Default for AppBuilder

fn default() -> AppBuilder

Returns the “default value” for a type.

impl PartialEq for AppBuilder

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