CreateAppRequest (AWS SDK for Java

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.CreateAppRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateAppRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAppRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 CreateAppRequest.Builder`	`builder()`
`List<DataSource>`	`dataSources()` The app's data source.
`String`	`description()` A description of the app.
`List<String>`	`domains()` The app virtual host 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)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDataSources()` Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDomains()` Returns true if the Domains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnvironment()` Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`name()` The app name.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAppRequest.Builder>`	`serializableBuilderClass()`
`String`	`shortname()` The app's short name.
`SslConfiguration`	`sslConfiguration()` An `SslConfiguration` object with the SSL configuration.
`String`	`stackId()` The stack ID.
`CreateAppRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - stackId
```
public final String stackId()
```
    The stack ID.
    
    Returns:
    
    The stack ID.
  - shortname
```
public final String shortname()
```
    The app's short name.
    
    Returns:
    
    The app's short name.
  - 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()
```
    Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dataSources
```
public final List<DataSource> dataSources()
```
    The app's data source.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDataSources() to see if a value was sent in this field.
    
    Returns:
    
    The app's data source.
  - type
```
public final AppType type()
```
    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.
    
    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. 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.
    
    See Also:
    
    AppType
  - typeAsString
```
public final String typeAsString()
```
    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.
    
    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. 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.
    
    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()
```
    Returns true if the Domains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - domains
```
public final List<String> domains()
```
    The app 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.
    
    You can use hasDomains() to see if a value was sent in this field.
    
    Returns:
    
    The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
  - enableSsl
```
public final Boolean enableSsl()
```
    Whether to enable SSL for the app.
    
    Returns:
    
    Whether to enable SSL 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.
    
    You can use hasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    One or more user-defined key/value pairs to be added to the stack attributes.
  - hasAttributes
```
public final boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    One or more user-defined key/value pairs to be added to the stack attributes.
  - hasEnvironment
```
public final boolean hasEnvironment()
```
    Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEnvironment() to see if a value was sent in this field.
    
    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 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.
  - toBuilder
```
public CreateAppRequest.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<CreateAppRequest.Builder,CreateAppRequest>
    
    Specified by:
    
    toBuilder in class OpsWorksRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateAppRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAppRequest.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.60

Class CreateAppRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

stackId

shortname

name

description

hasDataSources

dataSources

type

typeAsString

appSource

hasDomains

domains

enableSsl

sslConfiguration

attributes

hasAttributes

attributesAsStrings

hasEnvironment

environment

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields