Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Deploys an application revision through the specified deployment group.
Synopsis
- data CreateDeployment = CreateDeployment' {
- autoRollbackConfiguration :: Maybe AutoRollbackConfiguration
- deploymentConfigName :: Maybe Text
- deploymentGroupName :: Maybe Text
- description :: Maybe Text
- fileExistsBehavior :: Maybe FileExistsBehavior
- ignoreApplicationStopFailures :: Maybe Bool
- overrideAlarmConfiguration :: Maybe AlarmConfiguration
- revision :: Maybe RevisionLocation
- targetInstances :: Maybe TargetInstances
- updateOutdatedInstancesOnly :: Maybe Bool
- applicationName :: Text
- newCreateDeployment :: Text -> CreateDeployment
- createDeployment_autoRollbackConfiguration :: Lens' CreateDeployment (Maybe AutoRollbackConfiguration)
- createDeployment_deploymentConfigName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_deploymentGroupName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_description :: Lens' CreateDeployment (Maybe Text)
- createDeployment_fileExistsBehavior :: Lens' CreateDeployment (Maybe FileExistsBehavior)
- createDeployment_ignoreApplicationStopFailures :: Lens' CreateDeployment (Maybe Bool)
- createDeployment_overrideAlarmConfiguration :: Lens' CreateDeployment (Maybe AlarmConfiguration)
- createDeployment_revision :: Lens' CreateDeployment (Maybe RevisionLocation)
- createDeployment_targetInstances :: Lens' CreateDeployment (Maybe TargetInstances)
- createDeployment_updateOutdatedInstancesOnly :: Lens' CreateDeployment (Maybe Bool)
- createDeployment_applicationName :: Lens' CreateDeployment Text
- data CreateDeploymentResponse = CreateDeploymentResponse' {
- deploymentId :: Maybe Text
- httpStatus :: Int
- newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
- createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int
Creating a Request
data CreateDeployment Source #
Represents the input of a CreateDeployment
operation.
See: newCreateDeployment
smart constructor.
CreateDeployment' | |
|
Instances
Create a value of CreateDeployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeployment
, createDeployment_autoRollbackConfiguration
- Configuration information for an automatic rollback that is added when a
deployment is created.
CreateDeployment
, createDeployment_deploymentConfigName
- The name of a deployment configuration associated with the IAM user or
Amazon Web Services 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
, createDeployment_deploymentGroupName
- The name of the deployment group.
CreateDeployment
, createDeployment_description
- A comment about the deployment.
CreateDeployment
, createDeployment_fileExistsBehavior
- Information about how 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
, createDeployment_ignoreApplicationStopFailures
- 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 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
, createDeployment_overrideAlarmConfiguration
- Allows you to specify information about alarms associated with a
deployment. The alarm configuration that you specify here will override
the alarm configuration at the deployment group level. Consider
overriding the alarm configuration if you have set up alarms at the
deployment group level that are causing deployment failures. In this
case, you would call CreateDeployment
to create a new deployment that
uses a previous application revision that is known to work, and set its
alarm configuration to turn off alarm polling. Turning off alarm polling
ensures that the new deployment proceeds without being blocked by the
alarm that was generated by the previous, failed, deployment.
If you specify an overrideAlarmConfiguration
, you need the
UpdateDeploymentGroup
IAM permission when calling CreateDeployment
.
CreateDeployment
, createDeployment_revision
- The type and location of the revision to deploy.
CreateDeployment
, createDeployment_targetInstances
- Information about the instances that belong to the replacement
environment in a blue/green deployment.
CreateDeployment
, createDeployment_updateOutdatedInstancesOnly
- Indicates whether to deploy to all instances or only to instances that
are not running the latest application revision.
CreateDeployment
, createDeployment_applicationName
- The name of an CodeDeploy application associated with the IAM user or
Amazon Web Services account.
Request Lenses
createDeployment_autoRollbackConfiguration :: Lens' CreateDeployment (Maybe AutoRollbackConfiguration) Source #
Configuration information for an automatic rollback that is added when a deployment is created.
createDeployment_deploymentConfigName :: Lens' CreateDeployment (Maybe Text) Source #
The name of a deployment configuration associated with the IAM user or Amazon Web Services 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_deploymentGroupName :: Lens' CreateDeployment (Maybe Text) Source #
The name of the deployment group.
createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #
A comment about the deployment.
createDeployment_fileExistsBehavior :: Lens' CreateDeployment (Maybe FileExistsBehavior) Source #
Information about how 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_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 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_overrideAlarmConfiguration :: Lens' CreateDeployment (Maybe AlarmConfiguration) Source #
Allows you to specify information about alarms associated with a
deployment. The alarm configuration that you specify here will override
the alarm configuration at the deployment group level. Consider
overriding the alarm configuration if you have set up alarms at the
deployment group level that are causing deployment failures. In this
case, you would call CreateDeployment
to create a new deployment that
uses a previous application revision that is known to work, and set its
alarm configuration to turn off alarm polling. Turning off alarm polling
ensures that the new deployment proceeds without being blocked by the
alarm that was generated by the previous, failed, deployment.
If you specify an overrideAlarmConfiguration
, you need the
UpdateDeploymentGroup
IAM permission when calling CreateDeployment
.
createDeployment_revision :: Lens' CreateDeployment (Maybe RevisionLocation) Source #
The type and location of the revision to deploy.
createDeployment_targetInstances :: Lens' CreateDeployment (Maybe TargetInstances) Source #
Information about the instances that belong to the replacement environment in a blue/green deployment.
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_applicationName :: Lens' CreateDeployment Text Source #
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
Destructuring the Response
data CreateDeploymentResponse Source #
Represents the output of a CreateDeployment
operation.
See: newCreateDeploymentResponse
smart constructor.
CreateDeploymentResponse' | |
|
Instances
newCreateDeploymentResponse Source #
Create a value of CreateDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeploymentResponse
, createDeploymentResponse_deploymentId
- The unique ID of a deployment.
$sel:httpStatus:CreateDeploymentResponse'
, createDeploymentResponse_httpStatus
- The response's http status code.
Response Lenses
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The unique ID of a deployment.
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #
The response's http status code.