You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Amplify::Types::App

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

Overview

Amplify App represents different branches of a repository for building, deploying, and hosting.

Instance Attribute Summary collapse

Instance Attribute Details

#app_arnString

ARN for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#app_idString

Unique Id for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#auto_branch_creation_configTypes::AutoBranchCreationConfig

Automated branch creation config for the Amplify App.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#auto_branch_creation_patternsArray<String>

Automated branch creation glob patterns for the Amplify App.

Returns:

  • (Array<String>)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#basic_auth_credentialsString

Basic Authorization credentials for branches for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#build_specString

BuildSpec content for Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#create_timeTime

Create date / time for the Amplify App.

Returns:

  • (Time)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#custom_rulesArray<Types::CustomRule>

Custom redirect / rewrite rules for the Amplify App.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#default_domainString

Default domain for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#descriptionString

Description for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#enable_auto_branch_creationBoolean

Enables automated branch creation for the Amplify App.

Returns:

  • (Boolean)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#enable_basic_authBoolean

Enables Basic Authorization for branches for the Amplify App.

Returns:

  • (Boolean)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#enable_branch_auto_buildBoolean

Enables auto-building of branches for the Amplify App.

Returns:

  • (Boolean)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#environment_variablesHash<String,String>

Environment Variables for the Amplify App.

Returns:

  • (Hash<String,String>)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#iam_service_role_arnString

IAM service role ARN for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#nameString

Name for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#platformString

Platform for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#production_branchTypes::ProductionBranch

Structure with Production Branch information.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#repositoryString

Repository for the Amplify App.

Returns:

  • (String)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#tagsHash<String,String>

Tag for Amplify App.

Returns:

  • (Hash<String,String>)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end

#update_timeTime

Update date / time for the Amplify App.

Returns:

  • (Time)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 100

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_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  include Aws::Structure
end