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
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, WEB_DYNAMIC
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",
}
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.
-
#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 an Amplify app.
-
#repository ⇒ String
The name of the 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 .
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_id ⇒ String
The unique ID for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_config ⇒ Types::AutoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_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
.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_spec ⇒ String
The build specification (build spec) for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_headers ⇒ String
The custom HTTP headers for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_rules ⇒ Array<Types::CustomRule>
The custom redirect and rewrite rules for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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 |
#description ⇒ String
The description for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_creation ⇒ Boolean
Enables automated branch creation for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_auth ⇒ Boolean
Enables basic authorization for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_build ⇒ Boolean
Enables branch auto-building for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_deletion ⇒ Boolean
Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_variables ⇒ Hash<String,String>
The environment variables for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_arn ⇒ String
The AWS Identity and Access Management (IAM) service role for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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 |
#name ⇒ String
The name for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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_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 .
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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 |
#platform ⇒ String
The platform for an Amplify app.
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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 |
#repository ⇒ String
The name of the repository for an Amplify app
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2945 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 |