ws.osiris.awsdeploy.cloudformation

Class DeployResult

ws.osiris.awsdeploy.cloudformation.DeployResult

public class DeployResult

Information about an API that has been deployed.

Constructor Summary

Constructors

Constructor and Description
DeployResult(boolean stackCreated, java.lang.String apiId, java.lang.String lambdaVersionArn, java.lang.String keepAliveLambdaArn) Information about an API that has been deployed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() The ID of the API that was updated or created;
java.lang.String	getKeepAliveLambdaArn() The ARN of the lambda function that sends keep-alive messages;
java.lang.String	getLambdaVersionArn() The ARN of the lambda function version.
boolean	getStackCreated() true if a new stack was created,

Constructor Detail

DeployResult

public DeployResult(boolean stackCreated,
                    @NotNull
                    java.lang.String apiId,
                    @NotNull
                    java.lang.String lambdaVersionArn,
                    @Nullable
                    java.lang.String keepAliveLambdaArn)

Information about an API that has been deployed.

Parameters:

stackCreated - true if a new stack was created, false if an existing stack was updated.

apiId - The ID of the API that was updated or created; the URL is https://$apiId.execute-api.$region.amazonaws.com/

lambdaVersionArn - The ARN of the lambda function version.

keepAliveLambdaArn - The ARN of the lambda function that sends keep-alive messages; null if keep-alive is disabled.

Method Detail

getStackCreated

public boolean getStackCreated()

true if a new stack was created,

false if an existing stack was updated.

getApiId

@NotNull
public java.lang.String getApiId()

The ID of the API that was updated or created;

the URL is https://$apiId.execute-api.$region.amazonaws.com/

getLambdaVersionArn

@NotNull
public java.lang.String getLambdaVersionArn()

The ARN of the lambda function version.

getKeepAliveLambdaArn

@Nullable
public java.lang.String getKeepAliveLambdaArn()

The ARN of the lambda function that sends keep-alive messages;

null if keep-alive is disabled.