class Aws::Amplify::Types::UpdateAppRequest

The request structure for the update app request.

@note When making an API call, you may pass UpdateAppRequest

data as a hash:

    {
      app_id: "AppId", # required
      name: "Name",
      description: "Description",
      platform: "WEB", # accepts WEB
      iam_service_role_arn: "ServiceRoleArn",
      environment_variables: {
        "EnvKey" => "EnvValue",
      },
      enable_branch_auto_build: false,
      enable_branch_auto_deletion: false,
      enable_basic_auth: false,
      basic_auth_credentials: "BasicAuthCredentials",
      custom_rules: [
        {
          source: "Source", # required
          target: "Target", # required
          status: "Status",
          condition: "Condition",
        },
      ],
      build_spec: "BuildSpec",
      custom_headers: "CustomHeaders",
      enable_auto_branch_creation: false,
      auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
      auto_branch_creation_config: {
        stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
        framework: "Framework",
        enable_auto_build: false,
        environment_variables: {
          "EnvKey" => "EnvValue",
        },
        basic_auth_credentials: "BasicAuthCredentials",
        enable_basic_auth: false,
        enable_performance_mode: false,
        build_spec: "BuildSpec",
        enable_pull_request_preview: false,
        pull_request_environment_name: "PullRequestEnvironmentName",
      },
      repository: "Repository",
      oauth_token: "OauthToken",
      access_token: "AccessToken",
    }

@!attribute [rw] app_id

The unique ID for an Amplify app.
@return [String]

@!attribute [rw] name

The name for an Amplify app.
@return [String]

@!attribute [rw] description

The description for an Amplify app.
@return [String]

@!attribute [rw] platform

The platform for an Amplify app.
@return [String]

@!attribute [rw] iam_service_role_arn

The AWS Identity and Access Management (IAM) service role for an
Amplify app.
@return [String]

@!attribute [rw] environment_variables

The environment variables for an Amplify app.
@return [Hash<String,String>]

@!attribute [rw] enable_branch_auto_build

Enables branch auto-building for an Amplify app.
@return [Boolean]

@!attribute [rw] enable_branch_auto_deletion

Automatically disconnects a branch in the Amplify Console when you
delete a branch from your Git repository.
@return [Boolean]

@!attribute [rw] enable_basic_auth

Enables basic authorization for an Amplify app.
@return [Boolean]

@!attribute [rw] basic_auth_credentials

The basic authorization credentials for an Amplify app.
@return [String]

@!attribute [rw] custom_rules

The custom redirect and rewrite rules for an Amplify app.
@return [Array<Types::CustomRule>]

@!attribute [rw] build_spec

The build specification (build spec) for an Amplify app.
@return [String]

@!attribute [rw] custom_headers

The custom HTTP headers for an Amplify app.
@return [String]

@!attribute [rw] enable_auto_branch_creation

Enables automated branch creation for an Amplify app.
@return [Boolean]

@!attribute [rw] auto_branch_creation_patterns

Describes the automated branch creation glob patterns for an Amplify
app.
@return [Array<String>]

@!attribute [rw] auto_branch_creation_config

The automated branch creation configuration for an Amplify app.
@return [Types::AutoBranchCreationConfig]

@!attribute [rw] repository

The name of the repository for an Amplify app
@return [String]

@!attribute [rw] oauth_token

The OAuth token for a third-party source control system for an
Amplify app. The token is used to create a webhook and a read-only
deploy key. The OAuth token is not stored.
@return [String]

@!attribute [rw] access_token

The personal access token for a third-party source control system
for an Amplify app. The token is used to create webhook and a
read-only deploy key. The token is not stored.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppRequest AWS API Documentation

Constants

SENSITIVE