software.amazon.awssdk.services.opsworks.model

Class UpdateAppRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.UpdateAppRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAppRequest.Builder,UpdateAppRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAppRequest
extends OpsWorksRequest
implements ToCopyableBuilder<UpdateAppRequest.Builder,UpdateAppRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAppRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The app ID.
Source	appSource() A Source object that specifies the app repository.
Map<AppAttributesKeys,String>	attributes() One or more user-defined key/value pairs to be added to the stack attributes.
Map<String,String>	attributesAsStrings() One or more user-defined key/value pairs to be added to the stack attributes.
static UpdateAppRequest.Builder	builder()
List<DataSource>	dataSources() The app's data sources.
String	description() A description of the app.
List<String>	domains() The app's virtual host settings, with multiple domains separated by commas.
Boolean	enableSsl() Whether SSL is enabled 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
boolean	hasDataSources() For responses, this returns true if the service returned a value for the DataSources property.
boolean	hasDomains() For responses, this returns true if the service returned a value for the Domains property.
boolean	hasEnvironment() For responses, this returns true if the service returned a value for the Environment property.
int	hashCode()
String	name() The app name.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAppRequest.Builder>	serializableBuilderClass()
SslConfiguration	sslConfiguration() An SslConfiguration object with the SSL configuration.
UpdateAppRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AppType	type() The app type.
String	typeAsString() The app type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

appId

public final String appId()

The app ID.

Returns:

The app ID.

name

public final String name()

The app name.

Returns:

The app name.

description

public final String description()

A description of the app.

Returns:

A description of the app.

hasDataSources

public final boolean hasDataSources()

For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dataSources

public final List<DataSource> dataSources()

The app's data sources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataSources() method.

Returns:

The app's data sources.

type

public final AppType type()

The app type.

If the service returns an enum value that is not available in the current SDK version, type will return AppType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The app type.

See Also:

AppType

typeAsString

public final String typeAsString()

The app type.

If the service returns an enum value that is not available in the current SDK version, type will return AppType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The app type.

See Also:

AppType

appSource

public final Source appSource()

A Source object that specifies the app repository.

Returns:

A Source object that specifies the app repository.

hasDomains

public final boolean hasDomains()

For responses, this returns true if the service returned a value for the Domains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

domains

public final List<String> domains()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDomains() method.

Returns:

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

enableSsl

public final Boolean enableSsl()

Whether SSL is enabled for the app.

Returns:

Whether SSL is enabled for the app.

sslConfiguration

public final SslConfiguration sslConfiguration()

An SslConfiguration object with the SSL configuration.

Returns:

An SslConfiguration object with the SSL configuration.

attributes

public final Map<AppAttributesKeys,String> attributes()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

Returns:

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

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributesAsStrings

public final Map<String,String> attributesAsStrings()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

Returns:

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

hasEnvironment

public final boolean hasEnvironment()

For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

environment

public final 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 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 20 KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironment() method.

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 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 20 KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

toBuilder

public UpdateAppRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAppRequest.Builder,UpdateAppRequest>

Specified by:

toBuilder in class OpsWorksRequest

builder

public static UpdateAppRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo