1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateApp`](crate::operation::update_app::builders::UpdateAppFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`app_id(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_app_id): <p> The unique ID for an Amplify app. </p>
    ///   - [`name(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_name): <p> The name for an Amplify app. </p>
    ///   - [`description(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_description): <p> The description for an Amplify app. </p>
    ///   - [`platform(Platform)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::platform) / [`set_platform(Option<Platform>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_platform): <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
    ///   - [`iam_service_role_arn(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::iam_service_role_arn) / [`set_iam_service_role_arn(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_iam_service_role_arn): <p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
    ///   - [`environment_variables(impl Into<String>, impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::environment_variables) / [`set_environment_variables(Option<HashMap<String, String>>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_environment_variables): <p> The environment variables for an Amplify app. </p>
    ///   - [`enable_branch_auto_build(bool)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::enable_branch_auto_build) / [`set_enable_branch_auto_build(Option<bool>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_enable_branch_auto_build): <p> Enables branch auto-building for an Amplify app. </p>
    ///   - [`enable_branch_auto_deletion(bool)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::enable_branch_auto_deletion) / [`set_enable_branch_auto_deletion(Option<bool>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_enable_branch_auto_deletion): <p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>
    ///   - [`enable_basic_auth(bool)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::enable_basic_auth) / [`set_enable_basic_auth(Option<bool>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_enable_basic_auth): <p> Enables basic authorization for an Amplify app. </p>
    ///   - [`basic_auth_credentials(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::basic_auth_credentials) / [`set_basic_auth_credentials(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_basic_auth_credentials): <p> The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
    ///   - [`custom_rules(CustomRule)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::custom_rules) / [`set_custom_rules(Option<Vec<CustomRule>>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_custom_rules): <p> The custom redirect and rewrite rules for an Amplify app. </p>
    ///   - [`build_spec(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::build_spec) / [`set_build_spec(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_build_spec): <p> The build specification (build spec) for an Amplify app. </p>
    ///   - [`custom_headers(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::custom_headers) / [`set_custom_headers(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_custom_headers): <p>The custom HTTP headers for an Amplify app.</p>
    ///   - [`enable_auto_branch_creation(bool)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::enable_auto_branch_creation) / [`set_enable_auto_branch_creation(Option<bool>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_enable_auto_branch_creation): <p> Enables automated branch creation for an Amplify app. </p>
    ///   - [`auto_branch_creation_patterns(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::auto_branch_creation_patterns) / [`set_auto_branch_creation_patterns(Option<Vec<String>>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_auto_branch_creation_patterns): <p> Describes the automated branch creation glob patterns for an Amplify app. </p>
    ///   - [`auto_branch_creation_config(AutoBranchCreationConfig)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::auto_branch_creation_config) / [`set_auto_branch_creation_config(Option<AutoBranchCreationConfig>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_auto_branch_creation_config): <p> The automated branch creation configuration for an Amplify app. </p>
    ///   - [`repository(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_repository): <p> The name of the repository for an Amplify app </p>
    ///   - [`oauth_token(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::oauth_token) / [`set_oauth_token(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_oauth_token): <p>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.</p>  <p>Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit.</p>  <p>To authorize access to GitHub as your repository provider, use <code>accessToken</code>.</p>  <p>You must specify either <code>oauthToken</code> or <code>accessToken</code> when you update an app.</p>  <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>
    ///   - [`access_token(impl Into<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::update_app::builders::UpdateAppFluentBuilder::set_access_token): <p>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.</p>  <p>Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>.</p>  <p>You must specify either <code>accessToken</code> or <code>oauthToken</code> when you update an app.</p>  <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>
    /// - On success, responds with [`UpdateAppOutput`](crate::operation::update_app::UpdateAppOutput) with field(s):
    ///   - [`app(Option<App>)`](crate::operation::update_app::UpdateAppOutput::app): <p> Represents the updated Amplify app. </p>
    /// - On failure, responds with [`SdkError<UpdateAppError>`](crate::operation::update_app::UpdateAppError)
    pub fn update_app(&self) -> crate::operation::update_app::builders::UpdateAppFluentBuilder {
        crate::operation::update_app::builders::UpdateAppFluentBuilder::new(self.handle.clone())
    }
}