libZSservicesZSamazonka-codedeployZSamazonka-codedeploy
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeDeploy.Lens

Contents

Description

 
Synopsis

Operations

RemoveTagsFromOnPremisesInstances

removeTagsFromOnPremisesInstances_tags :: Lens' RemoveTagsFromOnPremisesInstances [Tag] Source #

The tag key-value pairs to remove from the on-premises instances.

removeTagsFromOnPremisesInstances_instanceNames :: Lens' RemoveTagsFromOnPremisesInstances [Text] Source #

The names of the on-premises instances from which to remove tags.

BatchGetDeploymentGroups

batchGetDeploymentGroups_applicationName :: Lens' BatchGetDeploymentGroups Text Source #

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

batchGetDeploymentGroupsResponse_errorMessage :: Lens' BatchGetDeploymentGroupsResponse (Maybe Text) Source #

Information about errors that might have occurred during the API call.

DeleteDeploymentGroup

deleteDeploymentGroup_applicationName :: Lens' DeleteDeploymentGroup Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

deleteDeploymentGroup_deploymentGroupName :: Lens' DeleteDeploymentGroup Text Source #

The name of a deployment group for the specified application.

deleteDeploymentGroupResponse_hooksNotCleanedUp :: Lens' DeleteDeploymentGroupResponse (Maybe [AutoScalingGroup]) Source #

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.

UpdateDeploymentGroup

updateDeploymentGroup_serviceRoleArn :: Lens' UpdateDeploymentGroup (Maybe Text) Source #

A replacement ARN for the service role, if you want to change it.

updateDeploymentGroup_ec2TagSet :: Lens' UpdateDeploymentGroup (Maybe EC2TagSet) Source #

Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.

updateDeploymentGroup_deploymentConfigName :: Lens' UpdateDeploymentGroup (Maybe Text) Source #

The replacement deployment configuration name to use, if you want to change it.

updateDeploymentGroup_onPremisesTagSet :: Lens' UpdateDeploymentGroup (Maybe OnPremisesTagSet) Source #

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

updateDeploymentGroup_newDeploymentGroupName :: Lens' UpdateDeploymentGroup (Maybe Text) Source #

The new name of the deployment group, if you want to change it.

updateDeploymentGroup_ec2TagFilters :: Lens' UpdateDeploymentGroup (Maybe [EC2TagFilter]) Source #

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

updateDeploymentGroup_ecsServices :: Lens' UpdateDeploymentGroup (Maybe [ECSService]) Source #

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

updateDeploymentGroup_loadBalancerInfo :: Lens' UpdateDeploymentGroup (Maybe LoadBalancerInfo) Source #

Information about the load balancer used in a deployment.

updateDeploymentGroup_outdatedInstancesStrategy :: Lens' UpdateDeploymentGroup (Maybe OutdatedInstancesStrategy) Source #

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

updateDeploymentGroup_onPremisesInstanceTagFilters :: Lens' UpdateDeploymentGroup (Maybe [TagFilter]) Source #

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

updateDeploymentGroup_alarmConfiguration :: Lens' UpdateDeploymentGroup (Maybe AlarmConfiguration) Source #

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

updateDeploymentGroup_triggerConfigurations :: Lens' UpdateDeploymentGroup (Maybe [TriggerConfig]) Source #

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

updateDeploymentGroup_autoScalingGroups :: Lens' UpdateDeploymentGroup (Maybe [Text]) Source #

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

updateDeploymentGroup_deploymentStyle :: Lens' UpdateDeploymentGroup (Maybe DeploymentStyle) Source #

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

updateDeploymentGroup_autoRollbackConfiguration :: Lens' UpdateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

updateDeploymentGroup_applicationName :: Lens' UpdateDeploymentGroup Text Source #

The application name that corresponds to the deployment group to update.

updateDeploymentGroupResponse_hooksNotCleanedUp :: Lens' UpdateDeploymentGroupResponse (Maybe [AutoScalingGroup]) Source #

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.

ListOnPremisesInstances

listOnPremisesInstances_tagFilters :: Lens' ListOnPremisesInstances (Maybe [TagFilter]) Source #

The on-premises instance tags that are used to restrict the on-premises instance names returned.

listOnPremisesInstances_nextToken :: Lens' ListOnPremisesInstances (Maybe Text) Source #

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

listOnPremisesInstances_registrationStatus :: Lens' ListOnPremisesInstances (Maybe RegistrationStatus) Source #

The registration status of the on-premises instances:

  • Deregistered: Include deregistered on-premises instances in the resulting list.
  • Registered: Include registered on-premises instances in the resulting list.

listOnPremisesInstancesResponse_nextToken :: Lens' ListOnPremisesInstancesResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

CreateDeploymentConfig

createDeploymentConfig_computePlatform :: Lens' CreateDeploymentConfig (Maybe ComputePlatform) Source #

The destination platform type for the deployment (Lambda, Server, or ECS).

createDeploymentConfig_minimumHealthyHosts :: Lens' CreateDeploymentConfig (Maybe MinimumHealthyHosts) Source #

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

createDeploymentConfig_trafficRoutingConfig :: Lens' CreateDeploymentConfig (Maybe TrafficRoutingConfig) Source #

The configuration that specifies how the deployment traffic is routed.

createDeploymentConfig_deploymentConfigName :: Lens' CreateDeploymentConfig Text Source #

The name of the deployment configuration to create.

GetApplicationRevision

getApplicationRevision_applicationName :: Lens' GetApplicationRevision Text Source #

The name of the application that corresponds to the revision.

getApplicationRevision_revision :: Lens' GetApplicationRevision RevisionLocation Source #

Information about the application revision to get, including type and location.

getApplicationRevisionResponse_applicationName :: Lens' GetApplicationRevisionResponse (Maybe Text) Source #

The name of the application that corresponds to the revision.

getApplicationRevisionResponse_revision :: Lens' GetApplicationRevisionResponse (Maybe RevisionLocation) Source #

Additional information about the revision, including type and location.

GetDeployment

getDeployment_deploymentId :: Lens' GetDeployment Text Source #

The unique ID of a deployment associated with the IAM user or AWS account.

DeleteDeploymentConfig

deleteDeploymentConfig_deploymentConfigName :: Lens' DeleteDeploymentConfig Text Source #

The name of a deployment configuration associated with the IAM user or AWS account.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter.

GetDeploymentConfig

getDeploymentConfig_deploymentConfigName :: Lens' GetDeploymentConfig Text Source #

The name of a deployment configuration associated with the IAM user or AWS account.

CreateDeployment

createDeployment_deploymentConfigName :: Lens' CreateDeployment (Maybe Text) Source #

The name of a deployment configuration associated with the IAM user or AWS account.

If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.

createDeployment_fileExistsBehavior :: Lens' CreateDeployment (Maybe FileExistsBehavior) Source #

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

The fileExistsBehavior parameter takes any of the following values:

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

createDeployment_targetInstances :: Lens' CreateDeployment (Maybe TargetInstances) Source #

Information about the instances that belong to the replacement environment in a blue/green deployment.

createDeployment_revision :: Lens' CreateDeployment (Maybe RevisionLocation) Source #

The type and location of the revision to deploy.

createDeployment_autoRollbackConfiguration :: Lens' CreateDeployment (Maybe AutoRollbackConfiguration) Source #

Configuration information for an automatic rollback that is added when a deployment is created.

createDeployment_updateOutdatedInstancesOnly :: Lens' CreateDeployment (Maybe Bool) Source #

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

createDeployment_ignoreApplicationStopFailures :: Lens' CreateDeployment (Maybe Bool) Source #

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

createDeployment_applicationName :: Lens' CreateDeployment Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

BatchGetApplicationRevisions

batchGetApplicationRevisions_applicationName :: Lens' BatchGetApplicationRevisions Text Source #

The name of an AWS CodeDeploy application about which to get revision information.

batchGetApplicationRevisions_revisions :: Lens' BatchGetApplicationRevisions [RevisionLocation] Source #

An array of RevisionLocation objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation objects you can specify is 25.

batchGetApplicationRevisionsResponse_applicationName :: Lens' BatchGetApplicationRevisionsResponse (Maybe Text) Source #

The name of the application that corresponds to the revisions.

batchGetApplicationRevisionsResponse_revisions :: Lens' BatchGetApplicationRevisionsResponse (Maybe [RevisionInfo]) Source #

Additional information about the revisions, including the type and location.

batchGetApplicationRevisionsResponse_errorMessage :: Lens' BatchGetApplicationRevisionsResponse (Maybe Text) Source #

Information about errors that might have occurred during the API call.

BatchGetDeployments

batchGetDeployments_deploymentIds :: Lens' BatchGetDeployments [Text] Source #

A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.

GetOnPremisesInstance

getOnPremisesInstance_instanceName :: Lens' GetOnPremisesInstance Text Source #

The name of the on-premises instance about which to get information.

RegisterApplicationRevision

registerApplicationRevision_applicationName :: Lens' RegisterApplicationRevision Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

registerApplicationRevision_revision :: Lens' RegisterApplicationRevision RevisionLocation Source #

Information about the application revision to register, including type and location.

ContinueDeployment

continueDeployment_deploymentId :: Lens' ContinueDeployment (Maybe Text) Source #

The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.

continueDeployment_deploymentWaitType :: Lens' ContinueDeployment (Maybe DeploymentWaitType) Source #

The status of the deployment's waiting period. READY_WAIT indicates that the deployment is ready to start shifting traffic. TERMINATION_WAIT indicates that the traffic is shifted, but the original target is not terminated.

BatchGetApplications

batchGetApplications_applicationNames :: Lens' BatchGetApplications [Text] Source #

A list of application names separated by spaces. The maximum number of application names you can specify is 100.

DeleteApplication

deleteApplication_applicationName :: Lens' DeleteApplication Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

UpdateApplication

updateApplication_applicationName :: Lens' UpdateApplication (Maybe Text) Source #

The current name of the application you want to change.

DeleteGitHubAccountToken

deleteGitHubAccountToken_tokenName :: Lens' DeleteGitHubAccountToken (Maybe Text) Source #

The name of the GitHub account connection to delete.

deleteGitHubAccountTokenResponse_tokenName :: Lens' DeleteGitHubAccountTokenResponse (Maybe Text) Source #

The name of the GitHub account connection that was deleted.

DeregisterOnPremisesInstance

deregisterOnPremisesInstance_instanceName :: Lens' DeregisterOnPremisesInstance Text Source #

The name of the on-premises instance to deregister.

PutLifecycleEventHookExecutionStatus

putLifecycleEventHookExecutionStatus_status :: Lens' PutLifecycleEventHookExecutionStatus (Maybe LifecycleEventStatus) Source #

The result of a Lambda function that validates a deployment lifecycle event. Succeeded and Failed are the only valid values for status.

putLifecycleEventHookExecutionStatus_deploymentId :: Lens' PutLifecycleEventHookExecutionStatus (Maybe Text) Source #

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

putLifecycleEventHookExecutionStatus_lifecycleEventHookExecutionId :: Lens' PutLifecycleEventHookExecutionStatus (Maybe Text) Source #

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

putLifecycleEventHookExecutionStatusResponse_lifecycleEventHookExecutionId :: Lens' PutLifecycleEventHookExecutionStatusResponse (Maybe Text) Source #

The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.

GetDeploymentTarget

getDeploymentTarget_targetId :: Lens' GetDeploymentTarget (Maybe Text) Source #

The unique ID of a deployment target.

getDeploymentTargetResponse_deploymentTarget :: Lens' GetDeploymentTargetResponse (Maybe DeploymentTarget) Source #

A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (instanceTarget, lambdaTarget, or ecsTarget).

CreateApplication

createApplication_computePlatform :: Lens' CreateApplication (Maybe ComputePlatform) Source #

The destination platform type for the deployment (Lambda, Server, or ECS).

createApplication_tags :: Lens' CreateApplication (Maybe [Tag]) Source #

The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

createApplication_applicationName :: Lens' CreateApplication Text Source #

The name of the application. This name must be unique with the applicable IAM user or AWS account.

BatchGetDeploymentTargets

batchGetDeploymentTargets_targetIds :: Lens' BatchGetDeploymentTargets (Maybe [Text]) Source #

The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.

  • For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget.
  • For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
  • For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
  • For deployments that are deployed with AWS CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.

batchGetDeploymentTargetsResponse_deploymentTargets :: Lens' BatchGetDeploymentTargetsResponse (Maybe [DeploymentTarget]) Source #

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 EC2 or on-premises instance.
  • AWS Lambda: The target object is a specific version of an AWS Lambda function.
  • Amazon ECS: The target object is an Amazon ECS service.
  • CloudFormation: The target object is an AWS CloudFormation blue/green deployment.

StopDeployment

stopDeployment_autoRollbackEnabled :: Lens' StopDeployment (Maybe Bool) Source #

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

stopDeployment_deploymentId :: Lens' StopDeployment Text Source #

The unique ID of a deployment.

stopDeploymentResponse_status :: Lens' StopDeploymentResponse (Maybe StopStatus) Source #

The status of the stop deployment operation:

  • Pending: The stop operation is pending.
  • Succeeded: The stop operation was successful.

ListGitHubAccountTokenNames

listGitHubAccountTokenNames_nextToken :: Lens' ListGitHubAccountTokenNames (Maybe Text) Source #

An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.

listGitHubAccountTokenNamesResponse_nextToken :: Lens' ListGitHubAccountTokenNamesResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list.

GetApplication

getApplication_applicationName :: Lens' GetApplication Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

ListDeploymentGroups

listDeploymentGroups_nextToken :: Lens' ListDeploymentGroups (Maybe Text) Source #

An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.

listDeploymentGroups_applicationName :: Lens' ListDeploymentGroups Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

listDeploymentGroupsResponse_nextToken :: Lens' ListDeploymentGroupsResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.

BatchGetOnPremisesInstances

batchGetOnPremisesInstances_instanceNames :: Lens' BatchGetOnPremisesInstances [Text] Source #

The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

RegisterOnPremisesInstance

registerOnPremisesInstance_iamUserArn :: Lens' RegisterOnPremisesInstance (Maybe Text) Source #

The ARN of the IAM user to associate with the on-premises instance.

registerOnPremisesInstance_iamSessionArn :: Lens' RegisterOnPremisesInstance (Maybe Text) Source #

The ARN of the IAM session to associate with the on-premises instance.

registerOnPremisesInstance_instanceName :: Lens' RegisterOnPremisesInstance Text Source #

The name of the on-premises instance to register.

CreateDeploymentGroup

createDeploymentGroup_ec2TagSet :: Lens' CreateDeploymentGroup (Maybe EC2TagSet) Source #

Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

createDeploymentGroup_deploymentConfigName :: Lens' CreateDeploymentGroup (Maybe Text) Source #

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

createDeploymentGroup_onPremisesTagSet :: Lens' CreateDeploymentGroup (Maybe OnPremisesTagSet) Source #

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

createDeploymentGroup_ec2TagFilters :: Lens' CreateDeploymentGroup (Maybe [EC2TagFilter]) Source #

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

createDeploymentGroup_ecsServices :: Lens' CreateDeploymentGroup (Maybe [ECSService]) Source #

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

createDeploymentGroup_loadBalancerInfo :: Lens' CreateDeploymentGroup (Maybe LoadBalancerInfo) Source #

Information about the load balancer used in a deployment.

createDeploymentGroup_outdatedInstancesStrategy :: Lens' CreateDeploymentGroup (Maybe OutdatedInstancesStrategy) Source #

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

createDeploymentGroup_onPremisesInstanceTagFilters :: Lens' CreateDeploymentGroup (Maybe [TagFilter]) Source #

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

createDeploymentGroup_alarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration) Source #

Information to add about Amazon CloudWatch alarms when the deployment group is created.

createDeploymentGroup_triggerConfigurations :: Lens' CreateDeploymentGroup (Maybe [TriggerConfig]) Source #

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.

createDeploymentGroup_autoScalingGroups :: Lens' CreateDeploymentGroup (Maybe [Text]) Source #

A list of associated Amazon EC2 Auto Scaling groups.

createDeploymentGroup_deploymentStyle :: Lens' CreateDeploymentGroup (Maybe DeploymentStyle) Source #

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

createDeploymentGroup_autoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #

Configuration information for an automatic rollback that is added when a deployment group is created.

createDeploymentGroup_tags :: Lens' CreateDeploymentGroup (Maybe [Tag]) Source #

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

createDeploymentGroup_applicationName :: Lens' CreateDeploymentGroup Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

createDeploymentGroup_deploymentGroupName :: Lens' CreateDeploymentGroup Text Source #

The name of a new deployment group for the specified application.

createDeploymentGroup_serviceRoleArn :: Lens' CreateDeploymentGroup Text Source #

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

ListDeploymentConfigs

listDeploymentConfigs_nextToken :: Lens' ListDeploymentConfigs (Maybe Text) Source #

An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.

listDeploymentConfigsResponse_nextToken :: Lens' ListDeploymentConfigsResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.

listDeploymentConfigsResponse_deploymentConfigsList :: Lens' ListDeploymentConfigsResponse (Maybe [Text]) Source #

A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.

GetDeploymentGroup

getDeploymentGroup_applicationName :: Lens' GetDeploymentGroup Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

getDeploymentGroup_deploymentGroupName :: Lens' GetDeploymentGroup Text Source #

The name of a deployment group for the specified application.

ListDeployments

listDeployments_createTimeRange :: Lens' ListDeployments (Maybe TimeRange) Source #

A time range (start and end) for returning a subset of the list of deployments.

listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

listDeployments_includeOnlyStatuses :: Lens' ListDeployments (Maybe [DeploymentStatus]) Source #

A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.
  • Queued: Include queued deployments in the resulting list.
  • In Progress: Include in-progress deployments in the resulting list.
  • Succeeded: Include successful deployments in the resulting list.
  • Failed: Include failed deployments in the resulting list.
  • Stopped: Include stopped deployments in the resulting list.

listDeployments_applicationName :: Lens' ListDeployments (Maybe Text) Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

listDeployments_externalId :: Lens' ListDeployments (Maybe Text) Source #

The unique ID of an external resource for returning deployments linked to the external resource.

listDeployments_deploymentGroupName :: Lens' ListDeployments (Maybe Text) Source #

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of a resource, such as a CodeDeploy application or deployment group.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.

ListApplicationRevisions

listApplicationRevisions_s3KeyPrefix :: Lens' ListApplicationRevisions (Maybe Text) Source #

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

listApplicationRevisions_deployed :: Lens' ListApplicationRevisions (Maybe ListStateFilterAction) Source #

Whether to list revisions based on whether the revision is the target revision of a deployment group:

  • include: List revisions that are target revisions of a deployment group.
  • exclude: Do not list revisions that are target revisions of a deployment group.
  • ignore: List all revisions.

listApplicationRevisions_sortOrder :: Lens' ListApplicationRevisions (Maybe SortOrder) Source #

The order in which to sort the list results:

  • ascending: ascending order.
  • descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

listApplicationRevisions_nextToken :: Lens' ListApplicationRevisions (Maybe Text) Source #

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

listApplicationRevisions_s3Bucket :: Lens' ListApplicationRevisions (Maybe Text) Source #

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

listApplicationRevisions_sortBy :: Lens' ListApplicationRevisions (Maybe ApplicationRevisionSortBy) Source #

The column name to use to sort the list results:

  • registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.
  • firstUsedTime: Sort by the time the revisions were first used in a deployment.
  • lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

listApplicationRevisions_applicationName :: Lens' ListApplicationRevisions Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

listApplicationRevisionsResponse_nextToken :: Lens' ListApplicationRevisionsResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.

ListApplications

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of keys of Tag objects. The Tag objects identified by the keys are disassociated from the resource specified by the ResourceArn input parameter.

DeleteResourcesByExternalId

deleteResourcesByExternalId_externalId :: Lens' DeleteResourcesByExternalId (Maybe Text) Source #

The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.

AddTagsToOnPremisesInstances

addTagsToOnPremisesInstances_tags :: Lens' AddTagsToOnPremisesInstances [Tag] Source #

The tag key-value pairs to add to the on-premises instances.

Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.

addTagsToOnPremisesInstances_instanceNames :: Lens' AddTagsToOnPremisesInstances [Text] Source #

The names of the on-premises instances to which to add tags.

ListDeploymentTargets

listDeploymentTargets_targetFilters :: Lens' ListDeploymentTargets (Maybe (HashMap TargetFilterName [Text])) Source #

A key used to filter the returned targets. The two valid values are:

  • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.
  • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.

listDeploymentTargets_nextToken :: Lens' ListDeploymentTargets (Maybe Text) Source #

A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

listDeploymentTargetsResponse_nextToken :: Lens' ListDeploymentTargetsResponse (Maybe Text) Source #

If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.

Types

Alarm

alarm_name :: Lens' Alarm (Maybe Text) Source #

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

AlarmConfiguration

alarmConfiguration_ignorePollAlarmFailure :: Lens' AlarmConfiguration (Maybe Bool) Source #

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

  • true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
  • false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.

alarmConfiguration_enabled :: Lens' AlarmConfiguration (Maybe Bool) Source #

Indicates whether the alarm configuration is enabled.

alarmConfiguration_alarms :: Lens' AlarmConfiguration (Maybe [Alarm]) Source #

A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

AppSpecContent

appSpecContent_content :: Lens' AppSpecContent (Maybe Text) Source #

The YAML-formatted or JSON-formatted revision string.

For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.

For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.

For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.

appSpecContent_sha256 :: Lens' AppSpecContent (Maybe Text) Source #

The SHA256 hash value of the revision content.

ApplicationInfo

applicationInfo_linkedToGitHub :: Lens' ApplicationInfo (Maybe Bool) Source #

True if the user has authenticated with GitHub for the specified application. Otherwise, false.

applicationInfo_computePlatform :: Lens' ApplicationInfo (Maybe ComputePlatform) Source #

The destination platform type for deployment of the application (Lambda or Server).

applicationInfo_gitHubAccountName :: Lens' ApplicationInfo (Maybe Text) Source #

The name for a connection to a GitHub account.

applicationInfo_createTime :: Lens' ApplicationInfo (Maybe UTCTime) Source #

The time at which the application was created.

AutoRollbackConfiguration

autoRollbackConfiguration_enabled :: Lens' AutoRollbackConfiguration (Maybe Bool) Source #

Indicates whether a defined automatic rollback configuration is currently enabled.

autoRollbackConfiguration_events :: Lens' AutoRollbackConfiguration (Maybe [AutoRollbackEvent]) Source #

The event type or types that trigger a rollback.

AutoScalingGroup

autoScalingGroup_hook :: Lens' AutoScalingGroup (Maybe Text) Source #

An Auto Scaling lifecycle event hook name.

autoScalingGroup_name :: Lens' AutoScalingGroup (Maybe Text) Source #

The Auto Scaling group name.

BlueGreenDeploymentConfiguration

blueGreenDeploymentConfiguration_deploymentReadyOption :: Lens' BlueGreenDeploymentConfiguration (Maybe DeploymentReadyOption) Source #

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

blueGreenDeploymentConfiguration_greenFleetProvisioningOption :: Lens' BlueGreenDeploymentConfiguration (Maybe GreenFleetProvisioningOption) Source #

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

blueGreenDeploymentConfiguration_terminateBlueInstancesOnDeploymentSuccess :: Lens' BlueGreenDeploymentConfiguration (Maybe BlueInstanceTerminationOption) Source #

Information about whether to terminate instances in the original fleet during a blue/green deployment.

BlueInstanceTerminationOption

blueInstanceTerminationOption_action :: Lens' BlueInstanceTerminationOption (Maybe InstanceAction) Source #

The action to take on instances in the original environment after a successful blue/green deployment.

  • TERMINATE: Instances are terminated after a specified wait time.
  • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

blueInstanceTerminationOption_terminationWaitTimeInMinutes :: Lens' BlueInstanceTerminationOption (Maybe Int) Source #

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

CloudFormationTarget

cloudFormationTarget_targetId :: Lens' CloudFormationTarget (Maybe Text) Source #

The unique ID of a deployment target that has a type of CloudFormationTarget.

cloudFormationTarget_status :: Lens' CloudFormationTarget (Maybe TargetStatus) Source #

The status of an AWS CloudFormation blue/green deployment's target application.

cloudFormationTarget_deploymentId :: Lens' CloudFormationTarget (Maybe Text) Source #

The unique ID of an AWS CloudFormation blue/green deployment.

cloudFormationTarget_resourceType :: Lens' CloudFormationTarget (Maybe Text) Source #

The resource type for the AWS CloudFormation blue/green deployment.

cloudFormationTarget_lastUpdatedAt :: Lens' CloudFormationTarget (Maybe UTCTime) Source #

The date and time when the target application was updated by an AWS CloudFormation blue/green deployment.

cloudFormationTarget_lifecycleEvents :: Lens' CloudFormationTarget (Maybe [LifecycleEvent]) Source #

The lifecycle events of the AWS CloudFormation blue/green deployment to this target application.

cloudFormationTarget_targetVersionWeight :: Lens' CloudFormationTarget (Maybe Double) Source #

The percentage of production traffic that the target version of an AWS CloudFormation blue/green deployment receives.

DeploymentConfigInfo

deploymentConfigInfo_computePlatform :: Lens' DeploymentConfigInfo (Maybe ComputePlatform) Source #

The destination platform type for the deployment (Lambda, Server, or ECS).

deploymentConfigInfo_minimumHealthyHosts :: Lens' DeploymentConfigInfo (Maybe MinimumHealthyHosts) Source #

Information about the number or percentage of minimum healthy instance.

deploymentConfigInfo_trafficRoutingConfig :: Lens' DeploymentConfigInfo (Maybe TrafficRoutingConfig) Source #

The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or ECS compute platform only.

deploymentConfigInfo_createTime :: Lens' DeploymentConfigInfo (Maybe UTCTime) Source #

The time at which the deployment configuration was created.

DeploymentGroupInfo

deploymentGroupInfo_serviceRoleArn :: Lens' DeploymentGroupInfo (Maybe Text) Source #

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.

deploymentGroupInfo_ec2TagSet :: Lens' DeploymentGroupInfo (Maybe EC2TagSet) Source #

Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.

deploymentGroupInfo_lastAttemptedDeployment :: Lens' DeploymentGroupInfo (Maybe LastDeploymentInfo) Source #

Information about the most recent attempted deployment to the deployment group.

deploymentGroupInfo_onPremisesTagSet :: Lens' DeploymentGroupInfo (Maybe OnPremisesTagSet) Source #

Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

deploymentGroupInfo_computePlatform :: Lens' DeploymentGroupInfo (Maybe ComputePlatform) Source #

The destination platform type for the deployment (Lambda, Server, or ECS).

deploymentGroupInfo_targetRevision :: Lens' DeploymentGroupInfo (Maybe RevisionLocation) Source #

Information about the deployment group's target revision, including type and location.

deploymentGroupInfo_ec2TagFilters :: Lens' DeploymentGroupInfo (Maybe [EC2TagFilter]) Source #

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

deploymentGroupInfo_ecsServices :: Lens' DeploymentGroupInfo (Maybe [ECSService]) Source #

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

deploymentGroupInfo_blueGreenDeploymentConfiguration :: Lens' DeploymentGroupInfo (Maybe BlueGreenDeploymentConfiguration) Source #

Information about blue/green deployment options for a deployment group.

deploymentGroupInfo_loadBalancerInfo :: Lens' DeploymentGroupInfo (Maybe LoadBalancerInfo) Source #

Information about the load balancer to use in a deployment.

deploymentGroupInfo_outdatedInstancesStrategy :: Lens' DeploymentGroupInfo (Maybe OutdatedInstancesStrategy) Source #

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

deploymentGroupInfo_onPremisesInstanceTagFilters :: Lens' DeploymentGroupInfo (Maybe [TagFilter]) Source #

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

deploymentGroupInfo_lastSuccessfulDeployment :: Lens' DeploymentGroupInfo (Maybe LastDeploymentInfo) Source #

Information about the most recent successful deployment to the deployment group.

deploymentGroupInfo_alarmConfiguration :: Lens' DeploymentGroupInfo (Maybe AlarmConfiguration) Source #

A list of alarms associated with the deployment group.

deploymentGroupInfo_triggerConfigurations :: Lens' DeploymentGroupInfo (Maybe [TriggerConfig]) Source #

Information about triggers associated with the deployment group.

deploymentGroupInfo_deploymentStyle :: Lens' DeploymentGroupInfo (Maybe DeploymentStyle) Source #

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

deploymentGroupInfo_autoRollbackConfiguration :: Lens' DeploymentGroupInfo (Maybe AutoRollbackConfiguration) Source #

Information about the automatic rollback configuration associated with the deployment group.

DeploymentInfo

deploymentInfo_creator :: Lens' DeploymentInfo (Maybe DeploymentCreator) Source #

The means by which the deployment was created:

  • user: A user created the deployment.
  • autoscaling: Amazon EC2 Auto Scaling created the deployment.
  • codeDeployRollback: A rollback process created the deployment.
  • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated EC2 instances.

deploymentInfo_status :: Lens' DeploymentInfo (Maybe DeploymentStatus) Source #

The current state of the deployment as a whole.

deploymentInfo_computePlatform :: Lens' DeploymentInfo (Maybe ComputePlatform) Source #

The destination platform type for the deployment (Lambda, Server, or ECS).

deploymentInfo_previousRevision :: Lens' DeploymentInfo (Maybe RevisionLocation) Source #

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

deploymentInfo_instanceTerminationWaitTimeStarted :: Lens' DeploymentInfo (Maybe Bool) Source #

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

deploymentInfo_deploymentStatusMessages :: Lens' DeploymentInfo (Maybe [Text]) Source #

Messages that contain information about the status of a deployment.

deploymentInfo_startTime :: Lens' DeploymentInfo (Maybe UTCTime) Source #

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

deploymentInfo_completeTime :: Lens' DeploymentInfo (Maybe UTCTime) Source #

A timestamp that indicates when the deployment was complete.

deploymentInfo_blueGreenDeploymentConfiguration :: Lens' DeploymentInfo (Maybe BlueGreenDeploymentConfiguration) Source #

Information about blue/green deployment options for this deployment.

deploymentInfo_errorInformation :: Lens' DeploymentInfo (Maybe ErrorInformation) Source #

Information about any error associated with this deployment.

deploymentInfo_loadBalancerInfo :: Lens' DeploymentInfo (Maybe LoadBalancerInfo) Source #

Information about the load balancer used in the deployment.

deploymentInfo_additionalDeploymentStatusInfo :: Lens' DeploymentInfo (Maybe Text) Source #

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

deploymentInfo_deploymentOverview :: Lens' DeploymentInfo (Maybe DeploymentOverview) Source #

A summary of the deployment status of the instances in the deployment.

deploymentInfo_fileExistsBehavior :: Lens' DeploymentInfo (Maybe FileExistsBehavior) Source #

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

deploymentInfo_rollbackInfo :: Lens' DeploymentInfo (Maybe RollbackInfo) Source #

Information about a deployment rollback.

deploymentInfo_externalId :: Lens' DeploymentInfo (Maybe Text) Source #

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

deploymentInfo_targetInstances :: Lens' DeploymentInfo (Maybe TargetInstances) Source #

Information about the instances that belong to the replacement environment in a blue/green deployment.

deploymentInfo_revision :: Lens' DeploymentInfo (Maybe RevisionLocation) Source #

Information about the location of stored application artifacts and the service from which to retrieve them.

deploymentInfo_description :: Lens' DeploymentInfo (Maybe Text) Source #

A comment about the deployment.

deploymentInfo_deploymentStyle :: Lens' DeploymentInfo (Maybe DeploymentStyle) Source #

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

deploymentInfo_createTime :: Lens' DeploymentInfo (Maybe UTCTime) Source #

A timestamp that indicates when the deployment was created.

deploymentInfo_autoRollbackConfiguration :: Lens' DeploymentInfo (Maybe AutoRollbackConfiguration) Source #

Information about the automatic rollback configuration associated with the deployment.

deploymentInfo_updateOutdatedInstancesOnly :: Lens' DeploymentInfo (Maybe Bool) Source #

Indicates whether only instances that are not running the latest application revision are to be deployed to.

deploymentInfo_ignoreApplicationStopFailures :: Lens' DeploymentInfo (Maybe Bool) Source #

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

DeploymentOverview

deploymentOverview_pending :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in the deployment in a pending state.

deploymentOverview_skipped :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in the deployment in a skipped state.

deploymentOverview_inProgress :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in which the deployment is in progress.

deploymentOverview_succeeded :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in the deployment to which revisions have been successfully deployed.

deploymentOverview_ready :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.

deploymentOverview_failed :: Lens' DeploymentOverview (Maybe Integer) Source #

The number of instances in the deployment in a failed state.

DeploymentReadyOption

deploymentReadyOption_actionOnTimeout :: Lens' DeploymentReadyOption (Maybe DeploymentReadyAction) Source #

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
  • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

deploymentReadyOption_waitTimeInMinutes :: Lens' DeploymentReadyOption (Maybe Int) Source #

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.

DeploymentStyle

deploymentStyle_deploymentOption :: Lens' DeploymentStyle (Maybe DeploymentOption) Source #

Indicates whether to route deployment traffic behind a load balancer.

deploymentStyle_deploymentType :: Lens' DeploymentStyle (Maybe DeploymentType) Source #

Indicates whether to run an in-place deployment or a blue/green deployment.

DeploymentTarget

deploymentTarget_instanceTarget :: Lens' DeploymentTarget (Maybe InstanceTarget) Source #

Information about the target for a deployment that uses the EC2/On-premises compute platform.

deploymentTarget_ecsTarget :: Lens' DeploymentTarget (Maybe ECSTarget) Source #

Information about the target for a deployment that uses the Amazon ECS compute platform.

deploymentTarget_deploymentTargetType :: Lens' DeploymentTarget (Maybe DeploymentTargetType) Source #

The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.

deploymentTarget_lambdaTarget :: Lens' DeploymentTarget (Maybe LambdaTarget) Source #

Information about the target for a deployment that uses the AWS Lambda compute platform.

Diagnostics

diagnostics_logTail :: Lens' Diagnostics (Maybe Text) Source #

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

diagnostics_errorCode :: Lens' Diagnostics (Maybe LifecycleErrorCode) Source #

The associated error code:

  • Success: The specified script ran.
  • ScriptMissing: The specified script was not found in the specified location.
  • ScriptNotExecutable: The specified script is not a recognized executable file type.
  • ScriptTimedOut: The specified script did not finish running in the specified time period.
  • ScriptFailed: The specified script failed to run as expected.
  • UnknownError: The specified script did not run for an unknown reason.

diagnostics_message :: Lens' Diagnostics (Maybe Text) Source #

The message associated with the error.

EC2TagFilter

eC2TagFilter_type :: Lens' EC2TagFilter (Maybe EC2TagFilterType) Source #

The tag filter type:

  • KEY_ONLY: Key only.
  • VALUE_ONLY: Value only.
  • KEY_AND_VALUE: Key and value.

EC2TagSet

eC2TagSet_ec2TagSetList :: Lens' EC2TagSet (Maybe [[EC2TagFilter]]) Source #

A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

ECSService

eCSService_serviceName :: Lens' ECSService (Maybe Text) Source #

The name of the target Amazon ECS service.

eCSService_clusterName :: Lens' ECSService (Maybe Text) Source #

The name of the cluster that the Amazon ECS service is associated with.

ECSTarget

eCSTarget_targetArn :: Lens' ECSTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target.

eCSTarget_targetId :: Lens' ECSTarget (Maybe Text) Source #

The unique ID of a deployment target that has a type of ecsTarget.

eCSTarget_status :: Lens' ECSTarget (Maybe TargetStatus) Source #

The status an Amazon ECS deployment's target ECS application.

eCSTarget_deploymentId :: Lens' ECSTarget (Maybe Text) Source #

The unique ID of a deployment.

eCSTarget_lastUpdatedAt :: Lens' ECSTarget (Maybe UTCTime) Source #

The date and time when the target Amazon ECS application was updated by a deployment.

eCSTarget_taskSetsInfo :: Lens' ECSTarget (Maybe [ECSTaskSet]) Source #

The ECSTaskSet objects associated with the ECS target.

eCSTarget_lifecycleEvents :: Lens' ECSTarget (Maybe [LifecycleEvent]) Source #

The lifecycle events of the deployment to this target Amazon ECS application.

ECSTaskSet

eCSTaskSet_runningCount :: Lens' ECSTaskSet (Maybe Integer) Source #

The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

eCSTaskSet_status :: Lens' ECSTaskSet (Maybe Text) Source #

The status of the task set. There are three valid task set statuses:

  • PRIMARY: Indicates the task set is serving production traffic.
  • ACTIVE: Indicates the task set is not serving production traffic.
  • DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

eCSTaskSet_identifer :: Lens' ECSTaskSet (Maybe Text) Source #

A unique ID of an ECSTaskSet.

eCSTaskSet_desiredCount :: Lens' ECSTaskSet (Maybe Integer) Source #

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

eCSTaskSet_pendingCount :: Lens' ECSTaskSet (Maybe Integer) Source #

The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

eCSTaskSet_trafficWeight :: Lens' ECSTaskSet (Maybe Double) Source #

The percentage of traffic served by this task set.

eCSTaskSet_targetGroup :: Lens' ECSTaskSet (Maybe TargetGroupInfo) Source #

The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.

eCSTaskSet_taskSetLabel :: Lens' ECSTaskSet (Maybe TargetLabel) Source #

A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

ELBInfo

eLBInfo_name :: Lens' ELBInfo (Maybe Text) Source #

For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

ErrorInformation

errorInformation_code :: Lens' ErrorInformation (Maybe DeployErrorCode) Source #

For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide.

The error code:

  • APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
  • DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
  • HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
  • HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
  • IAM_ROLE_MISSING: The service role cannot be accessed.
  • IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
  • INTERNAL_ERROR: There was an internal error.
  • NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
  • NO_INSTANCES: No instances were specified, or no instances can be found.
  • OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
  • THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.
  • TIMEOUT: The deployment has timed out.
  • REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.

errorInformation_message :: Lens' ErrorInformation (Maybe Text) Source #

An accompanying error message.

GenericRevisionInfo

genericRevisionInfo_registerTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source #

When the revision was registered with AWS CodeDeploy.

genericRevisionInfo_firstUsedTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source #

When the revision was first used by AWS CodeDeploy.

genericRevisionInfo_deploymentGroups :: Lens' GenericRevisionInfo (Maybe [Text]) Source #

The deployment groups for which this is the current target revision.

genericRevisionInfo_lastUsedTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source #

When the revision was last used by AWS CodeDeploy.

GitHubLocation

gitHubLocation_commitId :: Lens' GitHubLocation (Maybe Text) Source #

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

gitHubLocation_repository :: Lens' GitHubLocation (Maybe Text) Source #

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specified as account/repository.

GreenFleetProvisioningOption

greenFleetProvisioningOption_action :: Lens' GreenFleetProvisioningOption (Maybe GreenFleetProvisioningAction) Source #

The method used to add instances to a replacement environment.

  • DISCOVER_EXISTING: Use instances that already exist or will be created manually.
  • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

InstanceInfo

instanceInfo_registerTime :: Lens' InstanceInfo (Maybe UTCTime) Source #

The time at which the on-premises instance was registered.

instanceInfo_instanceArn :: Lens' InstanceInfo (Maybe Text) Source #

The ARN of the on-premises instance.

instanceInfo_deregisterTime :: Lens' InstanceInfo (Maybe UTCTime) Source #

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

instanceInfo_iamUserArn :: Lens' InstanceInfo (Maybe Text) Source #

The IAM user ARN associated with the on-premises instance.

instanceInfo_instanceName :: Lens' InstanceInfo (Maybe Text) Source #

The name of the on-premises instance.

instanceInfo_iamSessionArn :: Lens' InstanceInfo (Maybe Text) Source #

The ARN of the IAM session associated with the on-premises instance.

instanceInfo_tags :: Lens' InstanceInfo (Maybe [Tag]) Source #

The tags currently associated with the on-premises instance.

InstanceTarget

instanceTarget_targetArn :: Lens' InstanceTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target.

instanceTarget_targetId :: Lens' InstanceTarget (Maybe Text) Source #

The unique ID of a deployment target that has a type of instanceTarget.

instanceTarget_status :: Lens' InstanceTarget (Maybe TargetStatus) Source #

The status an EC2/On-premises deployment's target instance.

instanceTarget_instanceLabel :: Lens' InstanceTarget (Maybe TargetLabel) Source #

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

instanceTarget_lastUpdatedAt :: Lens' InstanceTarget (Maybe UTCTime) Source #

The date and time when the target instance was updated by a deployment.

instanceTarget_lifecycleEvents :: Lens' InstanceTarget (Maybe [LifecycleEvent]) Source #

The lifecycle events of the deployment to this target instance.

LambdaFunctionInfo

lambdaFunctionInfo_currentVersion :: Lens' LambdaFunctionInfo (Maybe Text) Source #

The version of a Lambda function that production traffic points to.

lambdaFunctionInfo_functionAlias :: Lens' LambdaFunctionInfo (Maybe Text) Source #

The alias of a Lambda function. For more information, see AWS Lambda Function Aliases in the AWS Lambda Developer Guide.

lambdaFunctionInfo_targetVersion :: Lens' LambdaFunctionInfo (Maybe Text) Source #

The version of a Lambda function that production traffic points to after the Lambda function is deployed.

lambdaFunctionInfo_targetVersionWeight :: Lens' LambdaFunctionInfo (Maybe Double) Source #

The percentage of production traffic that the target version of a Lambda function receives.

LambdaTarget

lambdaTarget_targetArn :: Lens' LambdaTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target.

lambdaTarget_targetId :: Lens' LambdaTarget (Maybe Text) Source #

The unique ID of a deployment target that has a type of lambdaTarget.

lambdaTarget_status :: Lens' LambdaTarget (Maybe TargetStatus) Source #

The status an AWS Lambda deployment's target Lambda function.

lambdaTarget_deploymentId :: Lens' LambdaTarget (Maybe Text) Source #

The unique ID of a deployment.

lambdaTarget_lastUpdatedAt :: Lens' LambdaTarget (Maybe UTCTime) Source #

The date and time when the target Lambda function was updated by a deployment.

lambdaTarget_lifecycleEvents :: Lens' LambdaTarget (Maybe [LifecycleEvent]) Source #

The lifecycle events of the deployment to this target Lambda function.

lambdaTarget_lambdaFunctionInfo :: Lens' LambdaTarget (Maybe LambdaFunctionInfo) Source #

A LambdaFunctionInfo object that describes a target Lambda function.

LastDeploymentInfo

lastDeploymentInfo_status :: Lens' LastDeploymentInfo (Maybe DeploymentStatus) Source #

The status of the most recent deployment.

lastDeploymentInfo_endTime :: Lens' LastDeploymentInfo (Maybe UTCTime) Source #

A timestamp that indicates when the most recent deployment to the deployment group was complete.

lastDeploymentInfo_createTime :: Lens' LastDeploymentInfo (Maybe UTCTime) Source #

A timestamp that indicates when the most recent deployment to the deployment group started.

LifecycleEvent

lifecycleEvent_status :: Lens' LifecycleEvent (Maybe LifecycleEventStatus) Source #

The deployment lifecycle event status:

  • Pending: The deployment lifecycle event is pending.
  • InProgress: The deployment lifecycle event is in progress.
  • Succeeded: The deployment lifecycle event ran successfully.
  • Failed: The deployment lifecycle event has failed.
  • Skipped: The deployment lifecycle event has been skipped.
  • Unknown: The deployment lifecycle event is unknown.

lifecycleEvent_lifecycleEventName :: Lens' LifecycleEvent (Maybe Text) Source #

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

lifecycleEvent_startTime :: Lens' LifecycleEvent (Maybe UTCTime) Source #

A timestamp that indicates when the deployment lifecycle event started.

lifecycleEvent_diagnostics :: Lens' LifecycleEvent (Maybe Diagnostics) Source #

Diagnostic information about the deployment lifecycle event.

lifecycleEvent_endTime :: Lens' LifecycleEvent (Maybe UTCTime) Source #

A timestamp that indicates when the deployment lifecycle event ended.

LoadBalancerInfo

loadBalancerInfo_elbInfoList :: Lens' LoadBalancerInfo (Maybe [ELBInfo]) Source #

An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.

Adding more than one load balancer to the array is not supported.

loadBalancerInfo_targetGroupInfoList :: Lens' LoadBalancerInfo (Maybe [TargetGroupInfo]) Source #

An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.

Adding more than one target group to the array is not supported.

loadBalancerInfo_targetGroupPairInfoList :: Lens' LoadBalancerInfo (Maybe [TargetGroupPairInfo]) Source #

The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

MinimumHealthyHosts

minimumHealthyHosts_value :: Lens' MinimumHealthyHosts (Maybe Int) Source #

The minimum healthy instance value.

minimumHealthyHosts_type :: Lens' MinimumHealthyHosts (Maybe MinimumHealthyHostsType) Source #

The minimum healthy instance type:

  • HOST_COUNT: The minimum number of healthy instances as an absolute value.
  • FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.

In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.

In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.

For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

OnPremisesTagSet

onPremisesTagSet_onPremisesTagSetList :: Lens' OnPremisesTagSet (Maybe [[TagFilter]]) Source #

A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

RawString

rawString_content :: Lens' RawString (Maybe Text) Source #

The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.

rawString_sha256 :: Lens' RawString (Maybe Text) Source #

The SHA256 hash value of the revision content.

RelatedDeployments

relatedDeployments_autoUpdateOutdatedInstancesDeploymentIds :: Lens' RelatedDeployments (Maybe [Text]) Source #

The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.

relatedDeployments_autoUpdateOutdatedInstancesRootDeploymentId :: Lens' RelatedDeployments (Maybe Text) Source #

The deployment ID of the root deployment that triggered this deployment.

RevisionInfo

revisionInfo_genericRevisionInfo :: Lens' RevisionInfo (Maybe GenericRevisionInfo) Source #

Information about an application revision, including usage details and associated deployment groups.

revisionInfo_revisionLocation :: Lens' RevisionInfo (Maybe RevisionLocation) Source #

Information about the location and type of an application revision.

RevisionLocation

revisionLocation_string :: Lens' RevisionLocation (Maybe RawString) Source #

Information about the location of an AWS Lambda deployment revision stored as a RawString.

revisionLocation_revisionType :: Lens' RevisionLocation (Maybe RevisionLocationType) Source #

The type of application revision:

  • S3: An application revision stored in Amazon S3.
  • GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
  • String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).
  • AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.

revisionLocation_s3Location :: Lens' RevisionLocation (Maybe S3Location) Source #

Information about the location of a revision stored in Amazon S3.

revisionLocation_appSpecContent :: Lens' RevisionLocation (Maybe AppSpecContent) Source #

The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.

revisionLocation_gitHubLocation :: Lens' RevisionLocation (Maybe GitHubLocation) Source #

Information about the location of application artifacts stored in GitHub.

RollbackInfo

rollbackInfo_rollbackTriggeringDeploymentId :: Lens' RollbackInfo (Maybe Text) Source #

The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.

rollbackInfo_rollbackMessage :: Lens' RollbackInfo (Maybe Text) Source #

Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded).

rollbackInfo_rollbackDeploymentId :: Lens' RollbackInfo (Maybe Text) Source #

The ID of the deployment rollback.

S3Location

s3Location_bundleType :: Lens' S3Location (Maybe BundleType) Source #

The file type of the application revision. Must be one of the following:

  • tar: A tar archive file.
  • tgz: A compressed tar archive file.
  • zip: A zip archive file.

s3Location_eTag :: Lens' S3Location (Maybe Text) Source #

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object is skipped.

s3Location_bucket :: Lens' S3Location (Maybe Text) Source #

The name of the Amazon S3 bucket where the application revision is stored.

s3Location_key :: Lens' S3Location (Maybe Text) Source #

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

s3Location_version :: Lens' S3Location (Maybe Text) Source #

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system uses the most recent version by default.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The tag's value.

tag_key :: Lens' Tag (Maybe Text) Source #

The tag's key.

TagFilter

tagFilter_value :: Lens' TagFilter (Maybe Text) Source #

The on-premises instance tag filter value.

tagFilter_key :: Lens' TagFilter (Maybe Text) Source #

The on-premises instance tag filter key.

tagFilter_type :: Lens' TagFilter (Maybe TagFilterType) Source #

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.
  • VALUE_ONLY: Value only.
  • KEY_AND_VALUE: Key and value.

TargetGroupInfo

targetGroupInfo_name :: Lens' TargetGroupInfo (Maybe Text) Source #

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

TargetGroupPairInfo

targetGroupPairInfo_prodTrafficRoute :: Lens' TargetGroupPairInfo (Maybe TrafficRoute) Source #

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

targetGroupPairInfo_testTrafficRoute :: Lens' TargetGroupPairInfo (Maybe TrafficRoute) Source #

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.

targetGroupPairInfo_targetGroups :: Lens' TargetGroupPairInfo (Maybe [TargetGroupInfo]) Source #

One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.

TargetInstances

targetInstances_ec2TagSet :: Lens' TargetInstances (Maybe EC2TagSet) Source #

Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.

targetInstances_tagFilters :: Lens' TargetInstances (Maybe [EC2TagFilter]) Source #

The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.

targetInstances_autoScalingGroups :: Lens' TargetInstances (Maybe [Text]) Source #

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

TimeBasedCanary

timeBasedCanary_canaryInterval :: Lens' TimeBasedCanary (Maybe Int) Source #

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

timeBasedCanary_canaryPercentage :: Lens' TimeBasedCanary (Maybe Int) Source #

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

TimeBasedLinear

timeBasedLinear_linearInterval :: Lens' TimeBasedLinear (Maybe Int) Source #

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.

timeBasedLinear_linearPercentage :: Lens' TimeBasedLinear (Maybe Int) Source #

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

TimeRange

timeRange_start :: Lens' TimeRange (Maybe UTCTime) Source #

The start time of the time range.

Specify null to leave the start time open-ended.

timeRange_end :: Lens' TimeRange (Maybe UTCTime) Source #

The end time of the time range.

Specify null to leave the end time open-ended.

TrafficRoute

trafficRoute_listenerArns :: Lens' TrafficRoute (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.

TrafficRoutingConfig

trafficRoutingConfig_timeBasedCanary :: Lens' TrafficRoutingConfig (Maybe TimeBasedCanary) Source #

A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

trafficRoutingConfig_timeBasedLinear :: Lens' TrafficRoutingConfig (Maybe TimeBasedLinear) Source #

A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

trafficRoutingConfig_type :: Lens' TrafficRoutingConfig (Maybe TrafficRoutingType) Source #

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

TriggerConfig

triggerConfig_triggerName :: Lens' TriggerConfig (Maybe Text) Source #

The name of the notification trigger.

triggerConfig_triggerEvents :: Lens' TriggerConfig (Maybe [TriggerEventType]) Source #

The event type or types for which notifications are triggered.

triggerConfig_triggerTargetArn :: Lens' TriggerConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.