Package com.amazonaws.services.opsworks.model

Class UpdateAppRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.UpdateAppRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateAppRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
UpdateAppRequest()

Method Summary

Modifier and Type	Method	Description
UpdateAppRequest	addAttributesEntry(String key, String value)
UpdateAppRequest	clearAttributesEntries()	Removes all the entries added into Attributes.
UpdateAppRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAppId()	The app ID.
Source	getAppSource()	A Source object that specifies the app repository.
Map<String,String>	getAttributes()	One or more user-defined key/value pairs to be added to the stack attributes.
List<DataSource>	getDataSources()	The app's data sources.
String	getDescription()	A description of the app.
List<String>	getDomains()	The app's virtual host settings, with multiple domains separated by commas.
Boolean	getEnableSsl()	Whether SSL is enabled for the app.
List<EnvironmentVariable>	getEnvironment()	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
String	getName()	The app name.
SslConfiguration	getSslConfiguration()	An SslConfiguration object with the SSL configuration.
String	getType()	The app type.
int	hashCode()
Boolean	isEnableSsl()	Whether SSL is enabled for the app.
void	setAppId(String appId)	The app ID.
void	setAppSource(Source appSource)	A Source object that specifies the app repository.
void	setAttributes(Map<String,String> attributes)	One or more user-defined key/value pairs to be added to the stack attributes.
void	setDataSources(Collection<DataSource> dataSources)	The app's data sources.
void	setDescription(String description)	A description of the app.
void	setDomains(Collection<String> domains)	The app's virtual host settings, with multiple domains separated by commas.
void	setEnableSsl(Boolean enableSsl)	Whether SSL is enabled for the app.
void	setEnvironment(Collection<EnvironmentVariable> environment)	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
void	setName(String name)	The app name.
void	setSslConfiguration(SslConfiguration sslConfiguration)	An SslConfiguration object with the SSL configuration.
void	setType(AppType type)	The app type.
void	setType(String type)	The app type.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
UpdateAppRequest	withAppId(String appId)	The app ID.
UpdateAppRequest	withAppSource(Source appSource)	A Source object that specifies the app repository.
UpdateAppRequest	withAttributes(Map<String,String> attributes)	One or more user-defined key/value pairs to be added to the stack attributes.
UpdateAppRequest	withDataSources(DataSource... dataSources)	The app's data sources.
UpdateAppRequest	withDataSources(Collection<DataSource> dataSources)	The app's data sources.
UpdateAppRequest	withDescription(String description)	A description of the app.
UpdateAppRequest	withDomains(String... domains)	The app's virtual host settings, with multiple domains separated by commas.
UpdateAppRequest	withDomains(Collection<String> domains)	The app's virtual host settings, with multiple domains separated by commas.
UpdateAppRequest	withEnableSsl(Boolean enableSsl)	Whether SSL is enabled for the app.
UpdateAppRequest	withEnvironment(EnvironmentVariable... environment)	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
UpdateAppRequest	withEnvironment(Collection<EnvironmentVariable> environment)	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
UpdateAppRequest	withName(String name)	The app name.
UpdateAppRequest	withSslConfiguration(SslConfiguration sslConfiguration)	An SslConfiguration object with the SSL configuration.
UpdateAppRequest	withType(AppType type)	The app type.
UpdateAppRequest	withType(String type)	The app type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateAppRequest

public UpdateAppRequest()

Method Detail

setAppId

public void setAppId(String appId)

The app ID.

Parameters:

appId - The app ID.

getAppId

public String getAppId()

The app ID.

Returns:

The app ID.

withAppId

public UpdateAppRequest withAppId(String appId)

The app ID.

Parameters:

appId - The app ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The app name.

Parameters:

name - The app name.

getName

public String getName()

The app name.

Returns:

The app name.

withName

public UpdateAppRequest withName(String name)

The app name.

Parameters:

name - The app name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description of the app.

Parameters:

description - A description of the app.

getDescription

public String getDescription()

A description of the app.

Returns:

A description of the app.

withDescription

public UpdateAppRequest withDescription(String description)

A description of the app.

Parameters:

description - A description of the app.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDataSources

public List<DataSource> getDataSources()

The app's data sources.

Returns:

The app's data sources.

setDataSources

public void setDataSources(Collection<DataSource> dataSources)

The app's data sources.

Parameters:

dataSources - The app's data sources.

withDataSources

public UpdateAppRequest withDataSources(DataSource... dataSources)

The app's data sources.

NOTE: This method appends the values to the existing list (if any). Use setDataSources(java.util.Collection) or withDataSources(java.util.Collection) if you want to override the existing values.

Parameters:

dataSources - The app's data sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

withDataSources

public UpdateAppRequest withDataSources(Collection<DataSource> dataSources)

The app's data sources.

Parameters:

dataSources - The app's data sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The app type.

Parameters:

type - The app type.

See Also:

AppType

getType

public String getType()

The app type.

Returns:

The app type.

See Also:

AppType

withType

public UpdateAppRequest withType(String type)

The app type.

Parameters:

type - The app type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppType

setType

public void setType(AppType type)

The app type.

Parameters:

type - The app type.

See Also:

AppType

withType

public UpdateAppRequest withType(AppType type)

The app type.

Parameters:

type - The app type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppType

setAppSource

public void setAppSource(Source appSource)

A Source object that specifies the app repository.

Parameters:

appSource - A Source object that specifies the app repository.

getAppSource

public Source getAppSource()

A Source object that specifies the app repository.

Returns:

A Source object that specifies the app repository.

withAppSource

public UpdateAppRequest withAppSource(Source appSource)

A Source object that specifies the app repository.

Parameters:

appSource - A Source object that specifies the app repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDomains

public List<String> getDomains()

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

Returns:

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

setDomains

public void setDomains(Collection<String> domains)

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

Parameters:

domains - The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

withDomains

public UpdateAppRequest withDomains(String... domains)

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

NOTE: This method appends the values to the existing list (if any). Use setDomains(java.util.Collection) or withDomains(java.util.Collection) if you want to override the existing values.

Parameters:

domains - The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

Returns:

Returns a reference to this object so that method calls can be chained together.

withDomains

public UpdateAppRequest withDomains(Collection<String> domains)

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

Parameters:

domains - The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnableSsl

public void setEnableSsl(Boolean enableSsl)

Whether SSL is enabled for the app.

Parameters:

enableSsl - Whether SSL is enabled for the app.

getEnableSsl

public Boolean getEnableSsl()

Whether SSL is enabled for the app.

Returns:

Whether SSL is enabled for the app.

withEnableSsl

public UpdateAppRequest withEnableSsl(Boolean enableSsl)

Whether SSL is enabled for the app.

Parameters:

enableSsl - Whether SSL is enabled for the app.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableSsl

public Boolean isEnableSsl()

Whether SSL is enabled for the app.

Returns:

Whether SSL is enabled for the app.

setSslConfiguration

public void setSslConfiguration(SslConfiguration sslConfiguration)

An SslConfiguration object with the SSL configuration.

Parameters:

sslConfiguration - An SslConfiguration object with the SSL configuration.

getSslConfiguration

public SslConfiguration getSslConfiguration()

An SslConfiguration object with the SSL configuration.

Returns:

An SslConfiguration object with the SSL configuration.

withSslConfiguration

public UpdateAppRequest withSslConfiguration(SslConfiguration sslConfiguration)

An SslConfiguration object with the SSL configuration.

Parameters:

sslConfiguration - An SslConfiguration object with the SSL configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public Map<String,String> getAttributes()

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

Returns:

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

setAttributes

public void setAttributes(Map<String,String> attributes)

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

Parameters:

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

withAttributes

public UpdateAppRequest withAttributes(Map<String,String> attributes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public UpdateAppRequest addAttributesEntry(String key,
                                           String value)

clearAttributesEntries

public UpdateAppRequest clearAttributesEntries()

Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.

getEnvironment

public List<EnvironmentVariable> 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 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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

setEnvironment

public void setEnvironment(Collection<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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Parameters:

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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

withEnvironment

public UpdateAppRequest withEnvironment(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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

NOTE: This method appends the values to the existing list (if any). Use setEnvironment(java.util.Collection) or withEnvironment(java.util.Collection) if you want to override the existing values.

Parameters:

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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEnvironment

public UpdateAppRequest withEnvironment(Collection<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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Parameters:

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 variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). 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 10KB)."

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateAppRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()