software.amazon.awssdk.services.opsworks.model

Class CreateDeploymentRequest

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

All Implemented Interfaces:

ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeploymentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The app ID.
static CreateDeploymentRequest.Builder	builder()
DeploymentCommand	command() A DeploymentCommand object that specifies the deployment command and any associated arguments.
String	comment() A user-defined comment.
String	customJson() A string that contains user-defined, custom JSON.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<String>	instanceIds() The instance IDs for the deployment targets.
List<String>	layerIds() The layer IDs for the deployment targets.
static Class<? extends CreateDeploymentRequest.Builder>	serializableBuilderClass()
String	stackId() The stack ID.
CreateDeploymentRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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 String stackId()

The stack ID.

Returns:

The stack ID.

appId

public String appId()

The app ID. This parameter is required for app deployments, but not for other deployment commands.

Returns:

The app ID. This parameter is required for app deployments, but not for other deployment commands.

instanceIds

public List<String> instanceIds()

The instance IDs for the deployment targets.

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

Returns:

The instance IDs for the deployment targets.

layerIds

public List<String> layerIds()

The layer IDs for the deployment targets.

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

Returns:

The layer IDs for the deployment targets.

command

public DeploymentCommand command()

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Returns:

A DeploymentCommand object that specifies the deployment command and any associated arguments.

comment

public String comment()

A user-defined comment.

Returns:

A user-defined comment.

customJson

public String customJson()

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Returns:

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

toBuilder

public CreateDeploymentRequest.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<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Specified by:

toBuilder in class OpsWorksRequest

Returns:

a builder for type T

builder

public static CreateDeploymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDeploymentRequest.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

getValueForField

public <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