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

Class: Aws::OpsWorks::Types::CreateAppRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAppRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  stack_id: "String", # required
  shortname: "String",
  name: "String", # required
  description: "String",
  data_sources: [
    {
      type: "String",
      arn: "String",
      database_name: "String",
    },
  ],
  type: "aws-flow-ruby", # required, 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,
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_source ⇒ Types::Source

A Source object that specifies the app repository.

Returns:

  • (Types::Source) —

    A Source object that specifies the app repository.

#attributes ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

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

#data_sources ⇒ Array<Types::DataSource>

The app\'s data source.

Returns:

#description ⇒ String

A description of the app.

Returns:

  • (String) —

    A description of the app.

#domains ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The app virtual host settings, with multiple domains separated by commas.

#enable_ssl ⇒ Boolean

Whether to enable SSL for the app.

Returns:

  • (Boolean) —

    Whether to enable SSL for the app.

#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 instance. 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 20KB).\"

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

Returns:

  • (Array<Types::EnvironmentVariable>) —

    An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

#name ⇒ String

The app name.

Returns:

  • (String) —

    The app name.

#shortname ⇒ String

The app\'s short name.

Returns:

  • (String) —

    The app\'s short name.

#ssl_configuration ⇒ Types::SslConfiguration

An SslConfiguration object with the SSL configuration.

Returns:

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) —

    The stack ID.

#type ⇒ String

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn\'t one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

Possible values:

  • aws-flow-ruby
  • java
  • rails
  • php
  • nodejs
  • static
  • other

Returns:

  • (String) —

    The app type.