deployment_targets
Creates, updates, deletes, gets or lists a deployment_targets resource.
Overview
| Name | deployment_targets |
| Type | Resource |
| Id | aws.codedeploy.deployment_targets |
Fields
The following fields are returned by SELECT queries:
- batch_get_deployment_targets
- get_deployment_target
- list_deployment_targets
| Name | Datatype | Description |
|---|---|---|
deployment_targets | array | A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance. Lambda: The target object is a specific version of an Lambda function. Amazon ECS: The target object is an Amazon ECS service. CloudFormation: The target object is an CloudFormation blue/green deployment. |
| Name | Datatype | Description |
|---|---|---|
cloud_formation_target | object | Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update. |
deployment_target_type | string | The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update. (InstanceTarget, LambdaTarget, ECSTarget, CloudFormationTarget) |
ecs_target | object | Information about the target for a deployment that uses the Amazon ECS compute platform. |
instance_target | object | Information about the target for a deployment that uses the EC2/On-premises compute platform. |
lambda_target | object | Information about the target for a deployment that uses the Lambda compute platform. |
| Name | Datatype | Description |
|---|---|---|
target_id | string | The unique IDs of deployment targets. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
batch_get_deployment_targets | select | region | Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25. The type of targets returned depends on the deployment's compute platform or deployment method: EC2/On-premises: Information about Amazon EC2 instance targets. Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets. CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update. | |
get_deployment_target | select | region | Returns information about a deployment target. | |
list_deployment_targets | select | region | Returns an array of target IDs that are associated a deployment. |
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_targets
- get_deployment_target
- list_deployment_targets
Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25. The type of targets returned depends on the deployment's compute platform or deployment method: EC2/On-premises: Information about Amazon EC2 instance targets. Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets. CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
SELECT
deployment_targets
FROM aws.codedeploy.deployment_targets
WHERE region = '{{ region }}' -- required
;
Returns information about a deployment target.
SELECT
cloud_formation_target,
deployment_target_type,
ecs_target,
instance_target,
lambda_target
FROM aws.codedeploy.deployment_targets
WHERE region = '{{ region }}' -- required
;
Returns an array of target IDs that are associated a deployment.
SELECT
target_id
FROM aws.codedeploy.deployment_targets
WHERE region = '{{ region }}' -- required
;