Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

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

Instances

Instances details

Eq CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
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 #
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 #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods rnf :: CreateDeployment -> () #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Associated Types type AWSResponse CreateDeployment # Methods request :: CreateDeployment -> Request CreateDeployment # response :: MonadResource m => Logger -> Service -> Proxy CreateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeployment))) #
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 #
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.CodeDeploy.CreateDeployment" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deploymentConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileExistsBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileExistsBehavior))) :: (S1 ('MetaSel ('Just "targetInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetInstances)) :: (S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RevisionLocation)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "autoRollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRollbackConfiguration)) :: S1 ('MetaSel ('Just "updateOutdatedInstancesOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "deploymentGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ignoreApplicationStopFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type AWSResponse CreateDeployment = CreateDeploymentResponse

newCreateDeployment Source #

Arguments

:: Text	`$sel:applicationName: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:

$sel:deploymentConfigName:CreateDeployment', createDeployment_deploymentConfigName - 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.

$sel:fileExistsBehavior:CreateDeployment', createDeployment_fileExistsBehavior - 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.

$sel:targetInstances:CreateDeployment', createDeployment_targetInstances - Information about the instances that belong to the replacement environment in a blue/green deployment.

$sel:revision:CreateDeployment', createDeployment_revision - The type and location of the revision to deploy.

$sel:description:CreateDeployment', createDeployment_description - A comment about the deployment.

$sel:autoRollbackConfiguration:CreateDeployment', createDeployment_autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment is created.

$sel:updateOutdatedInstancesOnly:CreateDeployment', createDeployment_updateOutdatedInstancesOnly - Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

$sel:deploymentGroupName:CreateDeployment', createDeployment_deploymentGroupName - The name of the deployment group.

$sel:ignoreApplicationStopFailures: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 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.

$sel:applicationName:CreateDeployment', createDeployment_applicationName - The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

Request Lenses

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_description :: Lens' CreateDeployment (Maybe Text) Source #

A comment about the deployment.

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_deploymentGroupName :: Lens' CreateDeployment (Maybe Text) Source #

The name of the deployment group.

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.

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

Eq CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods (==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool # (/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool #
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 #
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 #
NFData CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment Methods rnf :: CreateDeploymentResponse -> () #
type Rep CreateDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeployment type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.CodeDeploy.CreateDeployment" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" '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:

$sel:deploymentId: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.