Interface Deployment.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Deployment.Builder,
,Deployment> SdkBuilder<Deployment.Builder,
,Deployment> SdkPojo
- Enclosing class:
Deployment
-
Method Summary
Modifier and TypeMethodDescriptionThe app ID.default Deployment.Builder
command
(Consumer<DeploymentCommand.Builder> command) Used to specify a stack or deployment command.command
(DeploymentCommand command) Used to specify a stack or deployment command.A user-defined comment.completedAt
(String completedAt) Date when the deployment completed.Date when the deployment was created.customJson
(String customJson) A string that contains user-defined custom JSON.deploymentId
(String deploymentId) The deployment ID.The deployment duration.iamUserArn
(String iamUserArn) The user's IAM ARN.instanceIds
(String... instanceIds) The IDs of the target instances.instanceIds
(Collection<String> instanceIds) The IDs of the target instances.The stack ID.The deployment status:Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
deploymentId
The deployment ID.
- Parameters:
deploymentId
- The deployment ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The app ID.
- Parameters:
appId
- The app ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
Date when the deployment was created.
- Parameters:
createdAt
- Date when the deployment was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completedAt
Date when the deployment completed.
- Parameters:
completedAt
- Date when the deployment completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
duration
The deployment duration.
- Parameters:
duration
- The deployment duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamUserArn
The user's IAM ARN.
- Parameters:
iamUserArn
- The user's IAM ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
command
Used to specify a stack or deployment command.
- Parameters:
command
- Used to specify a stack or deployment command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
Used to specify a stack or deployment command.
This is a convenience method that creates an instance of theDeploymentCommand.Builder
avoiding the need to create one manually viaDeploymentCommand.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocommand(DeploymentCommand)
.- Parameters:
command
- a consumer that will call methods onDeploymentCommand.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The deployment status:
-
running
-
successful
-
failed
- Parameters:
status
- The deployment status:-
running
-
successful
-
failed
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
customJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. 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.
- Parameters:
customJson
- A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. 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:
- Returns a reference to this object so that method calls can be chained together.
-
instanceIds
The IDs of the target instances.
- Parameters:
instanceIds
- The IDs of the target instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceIds
The IDs of the target instances.
- Parameters:
instanceIds
- The IDs of the target instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-