Class: Aws::Amplify::Types::App
- Inherits:
-
Struct
- Object
- Struct
- Aws::Amplify::Types::App
- Defined in:
- gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb
Overview
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
Constant Summary collapse
- SENSITIVE =
[:basic_auth_credentials, :build_spec]
Instance Attribute Summary collapse
-
#app_arn ⇒ String
The Amazon Resource Name (ARN) of the Amplify app.
-
#app_id ⇒ String
The unique ID of the Amplify app.
-
#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.
-
#auto_branch_creation_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for the Amplify app.
-
#basic_auth_credentials ⇒ String
The basic authorization credentials for branches for the Amplify app.
-
#build_spec ⇒ String
Describes the content of the build specification (build spec) for the Amplify app.
-
#create_time ⇒ Time
Creates a date and time for the Amplify app.
-
#custom_headers ⇒ String
Describes the custom HTTP headers for the Amplify app.
-
#custom_rules ⇒ Array<Types::CustomRule>
Describes the custom redirect and rewrite rules for the Amplify app.
-
#default_domain ⇒ String
The default domain for the Amplify app.
-
#description ⇒ String
The description for the Amplify app.
-
#enable_auto_branch_creation ⇒ Boolean
Enables automated branch creation for the Amplify app.
-
#enable_basic_auth ⇒ Boolean
Enables basic authorization for the Amplify app's branches.
-
#enable_branch_auto_build ⇒ Boolean
Enables the auto-building of branches for the Amplify app.
-
#enable_branch_auto_deletion ⇒ Boolean
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
-
#environment_variables ⇒ Hash<String,String>
The environment variables for the Amplify app.
-
#iam_service_role_arn ⇒ String
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
-
#name ⇒ String
The name for the Amplify app.
-
#platform ⇒ String
The platform for the Amplify app.
-
#production_branch ⇒ Types::ProductionBranch
Describes the information about a production branch of the Amplify app.
-
#repository ⇒ String
The Git repository for the Amplify app.
-
#repository_clone_method ⇒ String
This is for internal use. -
#tags ⇒ Hash<String,String>
The tag for the Amplify app.
-
#update_time ⇒ Time
Updates the date and time for the Amplify app.
Instance Attribute Details
#app_arn ⇒ String
The Amazon Resource Name (ARN) of the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#app_id ⇒ String
The unique ID of the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#auto_branch_creation_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#basic_auth_credentials ⇒ String
The basic authorization credentials for branches for the Amplify
app. You must base64-encode the authorization credentials and
provide them in the format user:password
.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#build_spec ⇒ String
Describes the content of the build specification (build spec) for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#create_time ⇒ Time
Creates a date and time for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#custom_headers ⇒ String
Describes the custom HTTP headers for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#custom_rules ⇒ Array<Types::CustomRule>
Describes the custom redirect and rewrite rules for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#default_domain ⇒ String
The default domain for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#description ⇒ String
The description for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#enable_auto_branch_creation ⇒ Boolean
Enables automated branch creation for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#enable_basic_auth ⇒ Boolean
Enables basic authorization for the Amplify app's branches.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#enable_branch_auto_build ⇒ Boolean
Enables the auto-building of branches for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#enable_branch_auto_deletion ⇒ Boolean
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#environment_variables ⇒ Hash<String,String>
The environment variables for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#iam_service_role_arn ⇒ String
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#name ⇒ String
The name for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] 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
.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#production_branch ⇒ Types::ProductionBranch
Describes the information about a production branch of the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#repository ⇒ String
The Git repository for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#repository_clone_method ⇒ String
The Amplify service uses this parameter to specify the
authentication protocol to use to access the Git repository for an
Amplify app. Amplify specifies TOKEN
for a GitHub repository,
SIGV4
for an Amazon Web Services CodeCommit repository, and SSH
for GitLab and Bitbucket repositories.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The tag for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |
#update_time ⇒ Time
Updates the date and time for the Amplify app.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 134 class App < Struct.new( :app_id, :app_arn, :name, :tags, :description, :repository, :platform, :create_time, :update_time, :iam_service_role_arn, :environment_variables, :default_domain, :enable_branch_auto_build, :enable_branch_auto_deletion, :enable_basic_auth, :basic_auth_credentials, :custom_rules, :production_branch, :build_spec, :custom_headers, :enable_auto_branch_creation, :auto_branch_creation_patterns, :auto_branch_creation_config, :repository_clone_method) SENSITIVE = [:basic_auth_credentials, :build_spec] include Aws::Structure end |