Class: Aws::Amplify::Types::UpdateAppRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Amplify::Types::UpdateAppRequest
- 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
-
#access_token ⇒ String
The personal access token for a GitHub repository for an Amplify app.
-
#app_id ⇒ String
The unique ID for an Amplify app.
-
#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
-
#auto_branch_creation_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for an Amplify app.
-
#basic_auth_credentials ⇒ String
The basic authorization credentials for an Amplify app.
-
#build_spec ⇒ String
The build specification (build spec) for an Amplify app.
-
#cache_config ⇒ Types::CacheConfig
The cache configuration for the Amplify app.
-
#custom_headers ⇒ String
The custom HTTP headers for an Amplify app.
-
#custom_rules ⇒ Array<Types::CustomRule>
The custom redirect and rewrite rules for an Amplify app.
-
#description ⇒ String
The description for an Amplify app.
-
#enable_auto_branch_creation ⇒ Boolean
Enables automated branch creation for an Amplify app.
-
#enable_basic_auth ⇒ Boolean
Enables basic authorization for an Amplify app.
-
#enable_branch_auto_build ⇒ Boolean
Enables branch auto-building for an Amplify app.
-
#enable_branch_auto_deletion ⇒ Boolean
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
-
#environment_variables ⇒ Hash<String,String>
The environment variables for an Amplify app.
-
#iam_service_role_arn ⇒ String
The AWS Identity and Access Management (IAM) service role for an Amplify app.
-
#name ⇒ String
The name for an Amplify app.
-
#oauth_token ⇒ String
The OAuth token for a third-party source control system for an Amplify app.
-
#platform ⇒ String
The platform for the Amplify app.
-
#repository ⇒ String
The name of the Git repository for an Amplify app.
Instance Attribute Details
#access_token ⇒ 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
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 .
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#app_id ⇒ String
The unique ID for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#auto_branch_creation_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#basic_auth_credentials ⇒ String
The basic authorization credentials for an Amplify app. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#build_spec ⇒ String
The build specification (build spec) for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#cache_config ⇒ Types::CacheConfig
The cache configuration for the Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#custom_headers ⇒ String
The custom HTTP headers for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#custom_rules ⇒ Array<Types::CustomRule>
The custom redirect and rewrite rules for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#description ⇒ String
The description for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#enable_auto_branch_creation ⇒ Boolean
Enables automated branch creation for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#enable_basic_auth ⇒ Boolean
Enables basic authorization for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#enable_branch_auto_build ⇒ Boolean
Enables branch auto-building for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#enable_branch_auto_deletion ⇒ Boolean
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#environment_variables ⇒ Hash<String,String>
The environment variables for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#iam_service_role_arn ⇒ String
The AWS Identity and Access Management (IAM) service role for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#name ⇒ String
The name for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#oauth_token ⇒ 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
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 .
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#platform ⇒ String
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
.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |
#repository ⇒ String
The name of the Git repository for an Amplify app.
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2794 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, :cache_config) SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token] include Aws::Structure end |