Class: Aws::OpsWorks::Types::App

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opsworks/types.rb

Overview

A description of the app.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The app ID.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#app_source ⇒ Types::Source

A ‘Source` object that describes the app repository.

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

The stack attributes.

Returns:

  • (Hash<String,String>) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ String

When the app was created.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#data_sources ⇒ Array<Types::DataSource>

The app’s data sources.

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the app.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#domains ⇒ Array<String>

The app vhost settings with multiple domains separated by commas. For example: ‘’www.example.com, example.com’‘

Returns:

  • (Array<String>) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ssl ⇒ Boolean

Whether to enable SSL for the app.

Returns:

  • (Boolean) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Array<Types::EnvironmentVariable>

An array of ‘EnvironmentVariable` objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see [ Environment Variables].

<note markdown=“1”> There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an “Environment: is too large (maximum is 20 KB)” message.

</note>

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The app name.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#shortname ⇒ String

The app’s short name.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_configuration ⇒ Types::SslConfiguration

An ‘SslConfiguration` object with the SSL configuration.

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The app stack ID.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The app type.

Returns:

  • (String) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-opsworks/types.rb', line 109

class App < Struct.new(
  :app_id,
  :stack_id,
  :shortname,
  :name,
  :description,
  :data_sources,
  :type,
  :app_source,
  :domains,
  :enable_ssl,
  :ssl_configuration,
  :attributes,
  :created_at,
  :environment)
  SENSITIVE = []
  include Aws::Structure
end