Class: Aws::Amplify::Types::UpdateAppRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

The request structure for the update app request.

Constant Summary collapse

SENSITIVE =
[:basic_auth_credentials, :build_spec, :oauth_token, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

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 update an 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 .

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#auto_branch_creation_configTypes::AutoBranchCreationConfig

The automated branch creation configuration for an Amplify app.



2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#auto_branch_creation_patternsArray<String>

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

Returns:

  • (Array<String>)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#basic_auth_credentialsString

The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#build_specString

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

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#custom_headersString

The custom HTTP headers for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#custom_rulesArray<Types::CustomRule>

The custom redirect and rewrite rules for an Amplify app.

Returns:



2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#descriptionString

The description for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#enable_auto_branch_creationBoolean

Enables automated branch creation for an Amplify app.

Returns:

  • (Boolean)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#enable_basic_authBoolean

Enables basic authorization for an Amplify app.

Returns:

  • (Boolean)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#enable_branch_auto_buildBoolean

Enables branch auto-building for an Amplify app.

Returns:

  • (Boolean)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#enable_branch_auto_deletionBoolean

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

Returns:

  • (Boolean)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables for an Amplify app.

Returns:

  • (Hash<String,String>)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#iam_service_role_arnString

The AWS Identity and Access Management (IAM) service role for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#nameString

The name for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#oauth_tokenString

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 update an 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 .

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#platformString

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.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end

#repositoryString

The name of the Git repository for an Amplify app.

Returns:

  • (String)


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2709

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :platform,
  :iam_service_role_arn,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository,
  :oauth_token,
  :access_token)
  SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
  include Aws::Structure
end