AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::OpsWorks::Types::UpdateAppRequest

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

Overview

Note:

When making an API call, you may pass UpdateAppRequest data as a hash:

{
  app_id: "String", # required
  name: "String",
  description: "String",
  data_sources: [
    {
      type: "String",
      arn: "String",
      database_name: "String",
    },
  ],
  type: "aws-flow-ruby", # accepts aws-flow-ruby, java, rails, php, nodejs, static, other
  app_source: {
    type: "git", # accepts git, svn, archive, s3
    url: "String",
    username: "String",
    password: "String",
    ssh_key: "String",
    revision: "String",
  },
  domains: ["String"],
  enable_ssl: false,
  ssl_configuration: {
    certificate: "String", # required
    private_key: "String", # required
    chain: "String",
  },
  attributes: {
    "DocumentRoot" => "String",
  },
  environment: [
    {
      key: "String", # required
      value: "String", # required
      secure: false,
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The app ID.

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#app_sourceTypes::Source

A Source object that specifies the app repository.

Returns:



6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#attributesHash<String,String>

One or more user-defined key/value pairs to be added to the stack attributes.

Returns:

  • (Hash<String,String>)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#data_sourcesArray<Types::DataSource>

The app's data sources.

Returns:



6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#descriptionString

A description of the app.

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#domainsArray<String>

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

Returns:

  • (Array<String>)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#enable_sslBoolean

Whether SSL is enabled for the app.

Returns:

  • (Boolean)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#environmentArray<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.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Returns:



6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#nameString

The app name.

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#ssl_configurationTypes::SslConfiguration

An SslConfiguration object with the SSL configuration.



6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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

#typeString

The app type.

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6313

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