Class Deployment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Deployment.Builder,
Deployment>
Describes a deployment of a stack or app.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appId()
The app ID.static Deployment.Builder
builder()
final DeploymentCommand
command()
Used to specify a stack or deployment command.final String
comment()
A user-defined comment.final String
Date when the deployment completed.final String
Date when the deployment was created.final String
A string that contains user-defined custom JSON.final String
The deployment ID.final Integer
duration()
The deployment duration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceIds property.final String
The user's IAM ARN.The IDs of the target instances.static Class
<? extends Deployment.Builder> final String
stackId()
The stack ID.final String
status()
The deployment status:Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deploymentId
The deployment ID.
- Returns:
- The deployment ID.
-
stackId
The stack ID.
- Returns:
- The stack ID.
-
appId
The app ID.
- Returns:
- The app ID.
-
createdAt
Date when the deployment was created.
- Returns:
- Date when the deployment was created.
-
completedAt
Date when the deployment completed.
- Returns:
- Date when the deployment completed.
-
duration
The deployment duration.
- Returns:
- The deployment duration.
-
iamUserArn
The user's IAM ARN.
- Returns:
- The user's IAM ARN.
-
comment
A user-defined comment.
- Returns:
- A user-defined comment.
-
command
Used to specify a stack or deployment command.
- Returns:
- Used to specify a stack or deployment command.
-
status
The deployment status:
-
running
-
successful
-
failed
- Returns:
- The deployment status:
-
running
-
successful
-
failed
-
-
-
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:
- 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.
-
hasInstanceIds
public final boolean hasInstanceIds()For responses, this returns true if the service returned a value for the InstanceIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
instanceIds
The IDs of the target instances.
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
hasInstanceIds()
method.- Returns:
- The IDs of the target instances.
-
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 interfaceToCopyableBuilder<Deployment.Builder,
Deployment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-