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

Amazonka.CodeDeploy.CreateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deploys an application revision through the specified deployment group.

Synopsis

Creating a Request

data CreateDeployment Source #

Represents the input of a CreateDeployment operation.

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment'

Fields

autoRollbackConfiguration :: Maybe AutoRollbackConfiguration
Configuration information for an automatic rollback that is added when a deployment is created.
deploymentConfigName :: Maybe Text
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.
deploymentGroupName :: Maybe Text
The name of the deployment group.
description :: Maybe Text
A comment about the deployment.
fileExistsBehavior :: Maybe 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.
ignoreApplicationStopFailures :: Maybe Bool
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.
overrideAlarmConfiguration :: Maybe AlarmConfiguration
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.
revision :: Maybe RevisionLocation
The type and location of the revision to deploy.
targetInstances :: Maybe TargetInstances
Information about the instances that belong to the replacement environment in a blue/green deployment.
updateOutdatedInstancesOnly :: Maybe Bool
Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
applicationName :: Text
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Instances

Instances details

ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Associated Types type AWSResponse CreateDeployment # Methods request :: (Service -> Service) -> CreateDeployment -> Request CreateDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeployment))) #
Generic CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Associated Types type Rep CreateDeployment :: Type -> Type # Methods from :: CreateDeployment -> Rep CreateDeployment x # to :: Rep CreateDeployment x -> CreateDeployment #
Read CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods rnf :: CreateDeployment -> () #
Eq CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type AWSResponse CreateDeployment = CreateDeploymentResponse
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.CodeDeploy.CreateDeployment" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoRollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRollbackConfiguration)) :: S1 ('MetaSel ('Just "deploymentConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deploymentGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileExistsBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileExistsBehavior))))) :: ((S1 ('MetaSel ('Just "ignoreApplicationStopFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "overrideAlarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RevisionLocation)))) :: (S1 ('MetaSel ('Just "targetInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetInstances)) :: (S1 ('MetaSel ('Just "updateOutdatedInstancesOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDeployment Source #

Arguments

:: Text	`CreateDeployment`
-> CreateDeployment

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.

Constructors

CreateDeploymentResponse'
Fields deploymentId :: Maybe Text The unique ID of a deployment. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Associated Types type Rep CreateDeploymentResponse :: Type -> Type # Methods from :: CreateDeploymentResponse -> Rep CreateDeploymentResponse x # to :: Rep CreateDeploymentResponse x -> CreateDeploymentResponse #
Read CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeploymentResponse # readList :: ReadS [CreateDeploymentResponse] # readPrec :: ReadPrec CreateDeploymentResponse # readListPrec :: ReadPrec [CreateDeploymentResponse] #
Show CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods showsPrec :: Int -> CreateDeploymentResponse -> ShowS # show :: CreateDeploymentResponse -> String # showList :: [CreateDeploymentResponse] -> ShowS #
NFData CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods rnf :: CreateDeploymentResponse -> () #
Eq CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods (==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool # (/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool #
type Rep CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.CodeDeploy.CreateDeployment" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "CreateDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDeploymentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDeploymentResponse'`
-> CreateDeploymentResponse

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.