deployment_instances

Creates, updates, deletes, gets or lists a deployment_instances resource.

Overview

Name	deployment_instances
Type	Resource
Id	aws.codedeploy.deployment_instances

Fields

The following fields are returned by SELECT queries:

batch_get_deployment_instances

Name	Datatype	Description
error_message	string	Information about errors that might have occurred during the API call.
instances_summary	array	Information about the instance.

get_deployment_instance

Name	Datatype	Description
deployment_id	string	The unique ID of a deployment.
instance_id	string	The instance ID.
instance_type	string	Information about which environment an instance belongs to in a blue/green deployment. BLUE: The instance is part of the original environment. GREEN: The instance is part of the replacement environment. (Blue, Green)
last_updated_at	string (date-time)	A timestamp that indicates when the instance information was last updated.
lifecycle_events	array	A list of lifecycle events for this instance.
status	string	The deployment status for this instance: Pending: The deployment is pending for this instance. In Progress: The deployment is in progress for this instance. Succeeded: The deployment has succeeded for this instance. Failed: The deployment has failed for this instance. Skipped: The deployment has been skipped for this instance. Unknown: The deployment status is unknown for this instance. (Pending, InProgress, Succeeded, Failed, Skipped, Unknown, Ready)

list_deployment_instances

Name	Datatype	Description
instances	string	A list of instance IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_deployment_instances	select	region		This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.
get_deployment_instance	select	region		Gets information about an instance as part of a deployment.
list_deployment_instances	select	region		The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda. Lists the instance for a deployment associated with the user or Amazon Web Services account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_deployment_instances

This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.

SELECT
error_message,
instances_summary
FROM aws.codedeploy.deployment_instances
WHERE region = '{{ region }}' -- required
;

get_deployment_instance

Gets information about an instance as part of a deployment.

SELECT
deployment_id,
instance_id,
instance_type,
last_updated_at,
lifecycle_events,
status
FROM aws.codedeploy.deployment_instances
WHERE region = '{{ region }}' -- required
;

list_deployment_instances

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda. Lists the instance for a deployment associated with the user or Amazon Web Services account.

SELECT
instances
FROM aws.codedeploy.deployment_instances
WHERE region = '{{ region }}' -- required
;