Struct CreateAppFluentBuilder 

pub struct CreateAppFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateApp.

Creates a new Amplify app.

Implementations

impl CreateAppFluentBuilder

pub fn as_input(&self) -> &CreateAppInputBuilder

Access the CreateApp as a reference.

pub async fn send( self, ) -> Result<CreateAppOutput, SdkError<CreateAppError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateAppOutput, CreateAppError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The name of the Amplify app.

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

The name of the Amplify app.

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

The name of the Amplify app.

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

The description of the Amplify app.

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

The description of the Amplify app.

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

The description of the Amplify app.

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

The Git repository for the Amplify app.

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.

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

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.

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

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.

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

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

The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR 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.

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

The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR 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.

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

The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR 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.

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

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

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

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

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

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

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

Adds a key-value pair to environmentVariables.

To override the contents of this collection use set_environment_variables.

The environment variables map for an 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 map for an 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 map for an 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 enable_branch_auto_build(self, input: bool) -> Self

Enables the auto building of branches for an Amplify app.

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

Enables the auto building of branches for an Amplify app.

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

Enables the auto building of branches for an Amplify app.

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

Automatically disconnects 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 disconnects 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 disconnects 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 an Amplify app. This will apply to all branches that are part of this app.

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

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

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

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

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

The credentials for basic authorization for an 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 credentials for basic authorization for an 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 credentials for basic authorization for an 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 customRules.

To override the contents of this collection use set_custom_rules.

The custom rewrite and redirect rules for an Amplify app.

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

The custom rewrite and redirect rules for an Amplify app.

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

The custom rewrite and redirect rules for an 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 an Amplify app.

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

The tag for an Amplify app.

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

The tag for an Amplify app.

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

The build specification (build spec) for an Amplify app.

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

The build specification (build spec) for an Amplify app.

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

The build specification (build spec) for an Amplify app.

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

The custom HTTP headers for an Amplify app.

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

The custom HTTP headers for an Amplify app.

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

The custom HTTP headers for an Amplify app.

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

Enables automated branch creation for an Amplify app.

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

Enables automated branch creation for an Amplify app.

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

Enables automated branch creation for an Amplify app.

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

Appends an item to autoBranchCreationPatterns.

To override the contents of this collection use set_auto_branch_creation_patterns.

The automated branch creation glob patterns for an Amplify app.

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

The automated branch creation glob patterns for an Amplify app.

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

The automated branch creation glob patterns for an Amplify app.

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

The automated branch creation configuration for an Amplify app.

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

The automated branch creation configuration for an Amplify app.

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

The automated branch creation configuration for an Amplify app.

pub fn job_config(self, input: JobConfig) -> Self

Describes the configuration details that apply to the jobs for an Amplify app.

pub fn set_job_config(self, input: Option<JobConfig>) -> Self

Describes the configuration details that apply to the jobs for an Amplify app.

pub fn get_job_config(&self) -> &Option<JobConfig>

Describes the configuration details that apply to the jobs for an Amplify app.

pub fn cache_config(self, input: CacheConfig) -> Self

The cache configuration for the Amplify app.

pub fn set_cache_config(self, input: Option<CacheConfig>) -> Self

The cache configuration for the Amplify app.

pub fn get_cache_config(&self) -> &Option<CacheConfig>

The cache configuration for the Amplify app.

Trait Implementations

impl Clone for CreateAppFluentBuilder

fn clone(&self) -> CreateAppFluentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAppFluentBuilder

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

Formats the value using the given formatter.