opsworks_create_app: Creates an app for a specified stack

Description Usage Arguments Value Request syntax

View source: R/opsworks_operations.R

Description

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Usage

1
2
3
opsworks_create_app(StackId, Shortname, Name, Description, DataSources,
  Type, AppSource, Domains, EnableSsl, SslConfiguration, Attributes,
  Environment)

Arguments

StackId

[required] The stack ID.

Shortname

The app's short name.

Name

[required] The app name.

Description

A description of the app.

DataSources

The app's data source.

Type

[required] 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.

AppSource

A Source object that specifies the app repository.

Domains

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

EnableSsl

Whether to enable SSL for the app.

SslConfiguration

An SslConfiguration object with the SSL configuration.

Attributes

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

Environment

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.

Value

A list with the following syntax:

1
2
3
list(
  AppId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
svc$create_app(
  StackId = "string",
  Shortname = "string",
  Name = "string",
  Description = "string",
  DataSources = list(
    list(
      Type = "string",
      Arn = "string",
      DatabaseName = "string"
    )
  ),
  Type = "aws-flow-ruby"|"java"|"rails"|"php"|"nodejs"|"static"|"other",
  AppSource = list(
    Type = "git"|"svn"|"archive"|"s3",
    Url = "string",
    Username = "string",
    Password = "string",
    SshKey = "string",
    Revision = "string"
  ),
  Domains = list(
    "string"
  ),
  EnableSsl = TRUE|FALSE,
  SslConfiguration = list(
    Certificate = "string",
    PrivateKey = "string",
    Chain = "string"
  ),
  Attributes = list(
    "string"
  ),
  Environment = list(
    list(
      Key = "string",
      Value = "string",
      Secure = TRUE|FALSE
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.