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

Inherits:
Struct
  • Object
show all
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]

Instance Attribute Summary collapse

Instance Attribute Details

#app_arnString

The Amazon Resource Name (ARN) of the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#app_idString

The unique ID of the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#auto_branch_creation_configTypes::AutoBranchCreationConfig

Describes the automated branch creation configuration for the Amplify app.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#auto_branch_creation_patternsArray<String>

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

Returns:

  • (Array<String>)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#basic_auth_credentialsString

The basic authorization credentials for branches for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#build_specString

Describes the content of the build specification (build spec) for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#create_timeTime

Creates a date and time for the Amplify app.

Returns:

  • (Time)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#custom_rulesArray<Types::CustomRule>

Describes the custom redirect and rewrite rules for the Amplify app.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#default_domainString

The default domain for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#descriptionString

The description for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_auto_branch_creationBoolean

Enables automated branch creation for the Amplify app.

Returns:

  • (Boolean)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_basic_authBoolean

Enables basic authorization for the Amplify app's branches.

Returns:

  • (Boolean)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_branch_auto_buildBoolean

Enables the auto-building of branches for the Amplify app.

Returns:

  • (Boolean)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  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)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables for the Amplify app.

Returns:

  • (Hash<String,String>)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#iam_service_role_arnString

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#nameString

The name for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#platformString

The platform for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#production_branchTypes::ProductionBranch

Describes the information about a production branch of the Amplify app.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#repositoryString

The repository for the Amplify app.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#tagsHash<String,String>

The tag for the Amplify app.

Returns:

  • (Hash<String,String>)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#update_timeTime

Updates the date and time for the Amplify app.

Returns:

  • (Time)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 113

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,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end