Class CfnApp

A CloudFormation AWS::OpsWorks::App.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnApp
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.OpsWorks
Assembly: Amazon.CDK.AWS.OpsWorks.dll
Syntax (csharp)
public class CfnApp : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApp
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

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 .

CloudformationResource: AWS::OpsWorks::App

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;

CfnApp cfnApp = new CfnApp(this, "MyCfnApp", 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

CfnApp(Construct, String, ICfnAppProps)

Create a new AWS::OpsWorks::App.
CfnApp(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnApp(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AppSource

A Source object that specifies the app repository.
Attributes

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

The CloudFormation resource type name for this resource class.
CfnProperties
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 EnvironmentVariable objects that specify environment variables to be associated with the app.
Name

The app name.
Shortname

The app's short name.
SslConfiguration

An SslConfiguration object with the SSL configuration.
StackId

The stack ID.
Type

The app type.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnApp(Construct, String, ICfnAppProps)

Create a new AWS::OpsWorks::App.

public CfnApp(Construct scope, string id, ICfnAppProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnAppProps
  • resource properties.

CfnApp(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnApp(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnApp(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnApp(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AppSource

A Source object that specifies the app repository.

public virtual object AppSource { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource

Attributes

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

public virtual object Attributes { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

DataSources

The app's data source.

public virtual object DataSources { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources

Description

A description of the app.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description

Domains

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

public virtual string[] Domains { get; set; }
Property Value

System.String[]

Remarks

For example: 'www.example.com, example.com'

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains

EnableSsl

Whether to enable SSL for the app.

public virtual object EnableSsl { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl

Environment

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

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment

Name

The app name.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name

Shortname

The app's short name.

public virtual string Shortname { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname

SslConfiguration

An SslConfiguration object with the SSL configuration.

public virtual object SslConfiguration { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration

StackId

The stack ID.

public virtual string StackId { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid

Type

The app type.

public virtual 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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct