software.amazon.awscdk.services.opsworks

Class CfnApp

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opsworks.CfnApp

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.112Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpsWorks::App`.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opsworks.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .name("name")
         .stackId("stackId")
         .type("type")
         // the properties below are optional
         .appSource(SourceProperty.builder()
                 .password("password")
                 .revision("revision")
                 .sshKey("sshKey")
                 .type("type")
                 .url("url")
                 .username("username")
                 .build())
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .dataSources(List.of(DataSourceProperty.builder()
                 .arn("arn")
                 .databaseName("databaseName")
                 .type("type")
                 .build()))
         .description("description")
         .domains(List.of("domains"))
         .enableSsl(false)
         .environment(List.of(EnvironmentVariableProperty.builder()
                 .key("key")
                 .value("value")
                 // the properties below are optional
                 .secure(false)
                 .build()))
         .shortname("shortname")
         .sslConfiguration(SslConfigurationProperty.builder()
                 .certificate("certificate")
                 .chain("chain")
                 .privateKey("privateKey")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApp.Builder A fluent builder for CfnApp.
static interface	CfnApp.DataSourceProperty Describes an app's data source.
static interface	CfnApp.EnvironmentVariableProperty Represents an app's environment variable.
static interface	CfnApp.SourceProperty Contains the information required to retrieve an app or cookbook from a repository.
static interface	CfnApp.SslConfigurationProperty Describes an app's SSL configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApp(software.constructs.Construct scope, String id, CfnAppProps props) Create a new `AWS::OpsWorks::App`.
protected	CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAppSource() A `Source` object that specifies the app repository.
Object	getAttributes() One or more user-defined key/value pairs to be added to the stack attributes.
protected Map<String,Object>	getCfnProperties()
Object	getDataSources() The app's data source.
String	getDescription() A description of the app.
List<String>	getDomains() The app virtual host settings, with multiple domains separated by commas.
Object	getEnableSsl() Whether to enable SSL for the app.
Object	getEnvironment() An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
String	getName() The app name.
String	getShortname() The app's short name.
Object	getSslConfiguration() An `SslConfiguration` object with the SSL configuration.
String	getStackId() The stack ID.
String	getType() The app type.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppSource(CfnApp.SourceProperty value) A `Source` object that specifies the app repository.
void	setAppSource(IResolvable value) A `Source` object that specifies the app repository.
void	setAttributes(IResolvable value) One or more user-defined key/value pairs to be added to the stack attributes.
void	setAttributes(Map<String,String> value) One or more user-defined key/value pairs to be added to the stack attributes.
void	setDataSources(IResolvable value) The app's data source.
void	setDataSources(List<Object> value) The app's data source.
void	setDescription(String value) A description of the app.
void	setDomains(List<String> value) The app virtual host settings, with multiple domains separated by commas.
void	setEnableSsl(Boolean value) Whether to enable SSL for the app.
void	setEnableSsl(IResolvable value) Whether to enable SSL for the app.
void	setEnvironment(IResolvable value) An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
void	setEnvironment(List<Object> value) An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
void	setName(String value) The app name.
void	setShortname(String value) The app's short name.
void	setSslConfiguration(CfnApp.SslConfigurationProperty value) An `SslConfiguration` object with the SSL configuration.
void	setSslConfiguration(IResolvable value) An `SslConfiguration` object with the SSL configuration.
void	setStackId(String value) The stack ID.
void	setType(String value) The app type.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApp

protected CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

CfnApp

protected CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApp

@Stability(value=Stable)
public CfnApp(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnAppProps props)

Create a new `AWS::OpsWorks::App`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The app name.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The app name.

getStackId

@Stability(value=Stable)
 @NotNull
public String getStackId()

The stack ID.

setStackId

@Stability(value=Stable)
public void setStackId(@NotNull
                                                String value)

The stack ID.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

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 .

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

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 .

getAppSource

@Stability(value=Stable)
 @Nullable
public Object getAppSource()

A `Source` object that specifies the app repository.

setAppSource

@Stability(value=Stable)
public void setAppSource(@Nullable
                                                  CfnApp.SourceProperty value)

A `Source` object that specifies the app repository.

setAppSource

@Stability(value=Stable)
public void setAppSource(@Nullable
                                                  IResolvable value)

A `Source` object that specifies the app repository.

getAttributes

@Stability(value=Stable)
 @Nullable
public Object getAttributes()

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

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   IResolvable value)

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

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   Map<String,String> value)

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

getDataSources

@Stability(value=Stable)
 @Nullable
public Object getDataSources()

The app's data source.

setDataSources

@Stability(value=Stable)
public void setDataSources(@Nullable
                                                    IResolvable value)

The app's data source.

setDataSources

@Stability(value=Stable)
public void setDataSources(@Nullable
                                                    List<Object> value)

The app's data source.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the app.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the app.

getDomains

@Stability(value=Stable)
 @Nullable
public List<String> getDomains()

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

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

setDomains

@Stability(value=Stable)
public void setDomains(@Nullable
                                                List<String> value)

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

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

getEnableSsl

@Stability(value=Stable)
 @Nullable
public Object getEnableSsl()

Whether to enable SSL for the app.

setEnableSsl

@Stability(value=Stable)
public void setEnableSsl(@Nullable
                                                  Boolean value)

Whether to enable SSL for the app.

setEnableSsl

@Stability(value=Stable)
public void setEnableSsl(@Nullable
                                                  IResolvable value)

Whether to enable SSL for the app.

getEnvironment

@Stability(value=Stable)
 @Nullable
public Object getEnvironment()

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.

setEnvironment

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    IResolvable value)

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.

setEnvironment

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    List<Object> value)

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.

getShortname

@Stability(value=Stable)
 @Nullable
public String getShortname()

The app's short name.

setShortname

@Stability(value=Stable)
public void setShortname(@Nullable
                                                  String value)

The app's short name.

getSslConfiguration

@Stability(value=Stable)
 @Nullable
public Object getSslConfiguration()

An `SslConfiguration` object with the SSL configuration.

setSslConfiguration

@Stability(value=Stable)
public void setSslConfiguration(@Nullable
                                                         CfnApp.SslConfigurationProperty value)

An `SslConfiguration` object with the SSL configuration.

setSslConfiguration

@Stability(value=Stable)
public void setSslConfiguration(@Nullable
                                                         IResolvable value)

An `SslConfiguration` object with the SSL configuration.