Package software.amazon.awssdk.services.opsworks.model

Class App

java.lang.Object

software.amazon.awssdk.services.opsworks.model.App

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<App.Builder,App>

@Generated("software.amazon.awssdk:codegen")
public class App
extends Object
implements StructuredPojo, ToCopyableBuilder<App.Builder,App>

A description of the app.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	App.Builder

Method Summary

Modifier and Type	Method	Description
String	appId()	The app ID.
Source	appSource()	A Source object that describes the app repository.
Map<String,String>	attributes()	The stack attributes.
static App.Builder	builder()
String	createdAt()	When the app was created.
List<DataSource>	dataSources()	The app's data sources.
String	description()	A description of the app.
List<String>	domains()	The app vhost settings with multiple domains separated by commas.
Boolean	enableSsl()	Whether to enable SSL for the app.
List<EnvironmentVariable>	environment()	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The app name.
static Class<? extends App.Builder>	serializableBuilderClass()
String	shortname()	The app's short name.
SslConfiguration	sslConfiguration()	An SslConfiguration object with the SSL configuration.
String	stackId()	The app stack ID.
App.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The app type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

appId

public String appId()

The app ID.

Returns:

The app ID.

stackId

public String stackId()

The app stack ID.

Returns:

The app stack ID.

shortname

public String shortname()

The app's short name.

Returns:

The app's short name.

name

public String name()

The app name.

Returns:

The app name.

description

public String description()

A description of the app.

Returns:

A description of the app.

dataSources

public List<DataSource> dataSources()

The app's data sources.

Returns:

The app's data sources.

type

public String type()

The app type.

Returns:

The app type.

See Also:

AppType

appSource

public Source appSource()

A Source object that describes the app repository.

Returns:

A Source object that describes the app repository.

domains

public List<String> domains()

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

Returns:

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

enableSsl

public Boolean enableSsl()

Whether to enable SSL for the app.

Returns:

Whether to enable SSL for the app.

sslConfiguration

public SslConfiguration sslConfiguration()

An SslConfiguration object with the SSL configuration.

Returns:

An SslConfiguration object with the SSL configuration.

attributes

public Map<String,String> attributes()

The stack attributes.

Returns:

The stack attributes.

createdAt

public String createdAt()

When the app was created.

Returns:

When the app was created.

environment

public List<EnvironmentVariable> 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 instances. 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 variable names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message.

Returns:

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 instances. 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 variable names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message.

toBuilder

public App.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<App.Builder,App>

Returns:

a builder for type T

builder

public static App.Builder builder()

serializableBuilderClass

public static Class<? extends App.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.