Class CfnAppProps
Properties for defining a CfnApp
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpsWorks
Assembly: Amazon.CDK.AWS.OpsWorks.dll
Syntax (csharp)
public class CfnAppProps : Object, ICfnAppProps
Syntax (vb)
Public Class CfnAppProps
Inherits Object
Implements ICfnAppProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpsWorks;
var cfnAppProps = new CfnAppProps {
Name = "name",
StackId = "stackId",
Type = "type",
// the properties below are optional
AppSource = new SourceProperty {
Password = "password",
Revision = "revision",
SshKey = "sshKey",
Type = "type",
Url = "url",
Username = "username"
},
Attributes = new Dictionary<string, string> {
{ "attributesKey", "attributes" }
},
DataSources = new [] { new DataSourceProperty {
Arn = "arn",
DatabaseName = "databaseName",
Type = "type"
} },
Description = "description",
Domains = new [] { "domains" },
EnableSsl = false,
Environment = new [] { new EnvironmentVariableProperty {
Key = "key",
Value = "value",
// the properties below are optional
Secure = false
} },
Shortname = "shortname",
SslConfiguration = new SslConfigurationProperty {
Certificate = "certificate",
Chain = "chain",
PrivateKey = "privateKey"
}
};
Synopsis
Constructors
CfnAppProps() |
Properties
AppSource | A |
Attributes | One or more user-defined key/value pairs to be added to the stack attributes. |
DataSources | The app's data source. |
Description | A description of the app. |
Domains | The app virtual host settings, with multiple domains separated by commas. |
EnableSsl | Whether to enable SSL for the app. |
Environment | An array of |
Name | The app name. |
Shortname | The app's short name. |
SslConfiguration | An |
StackId | The stack ID. |
Type | The app type. |
Constructors
CfnAppProps()
public CfnAppProps()
Properties
AppSource
A Source
object that specifies the app repository.
public object AppSource { get; set; }
Property Value
System.Object
Remarks
Attributes
One or more user-defined key/value pairs to be added to the stack attributes.
public object Attributes { get; set; }
Property Value
System.Object
Remarks
DataSources
The app's data source.
public object DataSources { get; set; }
Property Value
System.Object
Remarks
Description
A description of the app.
public string Description { get; set; }
Property Value
System.String
Remarks
Domains
The app virtual host settings, with multiple domains separated by commas.
public string[] Domains { get; set; }
Property Value
System.String[]
Remarks
For example: 'www.example.com, example.com'
EnableSsl
Whether to enable SSL for the app.
public object EnableSsl { get; set; }
Property Value
System.Object
Remarks
Environment
An array of EnvironmentVariable
objects that specify environment variables to be associated with the app.
public object Environment { get; set; }
Property Value
System.Object
Remarks
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.
Name
The app name.
public string Name { get; set; }
Property Value
System.String
Remarks
Shortname
The app's short name.
public string Shortname { get; set; }
Property Value
System.String
Remarks
SslConfiguration
An SslConfiguration
object with the SSL configuration.
public object SslConfiguration { get; set; }
Property Value
System.Object
Remarks
StackId
The stack ID.
public string StackId { get; set; }
Property Value
System.String
Remarks
Type
The app type.
public string Type { get; set; }
Property Value
System.String
Remarks
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
.