software.amazon.awscdk.services.opsworks

Interface CfnAppProps

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:56.217Z")
public interface CfnAppProps

Properties for defining a `CfnApp`.

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.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .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	Interface and Description
static class	CfnAppProps.Builder A builder for CfnAppProps
static class	CfnAppProps.Jsii$Proxy An implementation for CfnAppProps

Method Summary

Modifier and Type	Method and Description
static CfnAppProps.Builder	builder()
default java.lang.Object	getAppSource() A `Source` object that specifies the app repository.
default java.lang.Object	getAttributes() One or more user-defined key/value pairs to be added to the stack attributes.
default java.lang.Object	getDataSources() The app's data source.
default java.lang.String	getDescription() A description of the app.
default java.util.List<java.lang.String>	getDomains() The app virtual host settings, with multiple domains separated by commas.
default java.lang.Object	getEnableSsl() Whether to enable SSL for the app.
default java.lang.Object	getEnvironment() An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
java.lang.String	getName() The app name.
default java.lang.String	getShortname() The app's short name.
default java.lang.Object	getSslConfiguration() An `SslConfiguration` object with the SSL configuration.
java.lang.String	getStackId() The stack ID.
java.lang.String	getType() The app type.

Method Detail

getName

java.lang.String getName()

The app name.

getStackId

java.lang.String getStackId()

The stack ID.

getType

java.lang.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 .

getAppSource

default java.lang.Object getAppSource()

A `Source` object that specifies the app repository.

getAttributes

default java.lang.Object getAttributes()

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

getDataSources

default java.lang.Object getDataSources()

The app's data source.

getDescription

default java.lang.String getDescription()

A description of the app.

getDomains

default java.util.List<java.lang.String> getDomains()

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

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

getEnableSsl

default java.lang.Object getEnableSsl()

Whether to enable SSL for the app.

getEnvironment

default java.lang.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.

getShortname

default java.lang.String getShortname()

The app's short name.

getSslConfiguration

default java.lang.Object getSslConfiguration()

An `SslConfiguration` object with the SSL configuration.

builder

static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps