Interface CreateDeploymentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, OpsWorksRequest.Builder, SdkBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDeploymentRequest

@Mutable
@NotThreadSafe
public static interface CreateDeploymentRequest.Builder
extends OpsWorksRequest.Builder, SdkPojo, CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Method Summary

Modifier and Type	Method	Description
CreateDeploymentRequest.Builder	appId(String appId)	The app ID.
default CreateDeploymentRequest.Builder	command(Consumer<DeploymentCommand.Builder> command)	A DeploymentCommand object that specifies the deployment command and any associated arguments.
CreateDeploymentRequest.Builder	command(DeploymentCommand command)	A DeploymentCommand object that specifies the deployment command and any associated arguments.
CreateDeploymentRequest.Builder	comment(String comment)	A user-defined comment.
CreateDeploymentRequest.Builder	customJson(String customJson)	A string that contains user-defined, custom JSON.
CreateDeploymentRequest.Builder	instanceIds(String... instanceIds)	The instance IDs for the deployment targets.
CreateDeploymentRequest.Builder	instanceIds(Collection<String> instanceIds)	The instance IDs for the deployment targets.
CreateDeploymentRequest.Builder	layerIds(String... layerIds)	The layer IDs for the deployment targets.
CreateDeploymentRequest.Builder	layerIds(Collection<String> layerIds)	The layer IDs for the deployment targets.
CreateDeploymentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDeploymentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDeploymentRequest.Builder	stackId(String stackId)	The stack ID.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.opsworks.model.OpsWorksRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

stackId

CreateDeploymentRequest.Builder stackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

Returns:

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

appId

CreateDeploymentRequest.Builder appId(String appId)

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

Parameters:

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

Returns:

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

instanceIds

CreateDeploymentRequest.Builder instanceIds(Collection<String> instanceIds)

The instance IDs for the deployment targets.

Parameters:

instanceIds - The instance IDs for the deployment targets.

Returns:

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

instanceIds

CreateDeploymentRequest.Builder instanceIds(String... instanceIds)

The instance IDs for the deployment targets.

Parameters:

instanceIds - The instance IDs for the deployment targets.

Returns:

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

layerIds

CreateDeploymentRequest.Builder layerIds(Collection<String> layerIds)

The layer IDs for the deployment targets.

Parameters:

layerIds - The layer IDs for the deployment targets.

Returns:

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

layerIds

CreateDeploymentRequest.Builder layerIds(String... layerIds)

The layer IDs for the deployment targets.

Parameters:

layerIds - The layer IDs for the deployment targets.

Returns:

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

command

CreateDeploymentRequest.Builder command(DeploymentCommand command)

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

Parameters:

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

Returns:

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

command

default CreateDeploymentRequest.Builder command(Consumer<DeploymentCommand.Builder> command)

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

This is a convenience method that creates an instance of the DeploymentCommand.Builder avoiding the need to create one manually via DeploymentCommand.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to command(DeploymentCommand).

Parameters:

command - a consumer that will call methods on DeploymentCommand.Builder

Returns:

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

See Also:

• command(DeploymentCommand)

comment

CreateDeploymentRequest.Builder comment(String comment)

A user-defined comment.

Parameters:

comment - A user-defined comment.

Returns:

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

customJson

CreateDeploymentRequest.Builder customJson(String customJson)

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

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

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

Parameters:

customJson - A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

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

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

Returns:

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

overrideConfiguration

CreateDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDeploymentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.