Network.AWS.CodeDeploy.CreateDeployment

Deploys an application revision through the specified deployment group.

Creating a Request

createDeployment

Arguments

:: Text

cdApplicationName

-> CreateDeployment

Creates a value of CreateDeployment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdDeploymentConfigName - The name of a deployment configuration associated with the applicable IAM user or AWS account. If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
• cdFileExistsBehavior - 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.
• cdTargetInstances - Information about the instances that will belong to the replacement environment in a blue/green deployment.
• cdRevision - The type and location of the revision to deploy.
• cdDescription - A comment about the deployment.
• cdAutoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment is created.
• cdUpdateOutdatedInstancesOnly - Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
• cdDeploymentGroupName - The name of the deployment group.
• cdIgnoreApplicationStopFailures - If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event. If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
• cdApplicationName - The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

data CreateDeployment

Represents the input of a CreateDeployment operation.

See: createDeployment smart constructor.

Instances

Eq CreateDeployment

Methods

(==) :: CreateDeployment -> CreateDeployment -> Bool

(/=) :: CreateDeployment -> CreateDeployment -> Bool

Data CreateDeployment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDeployment -> c CreateDeployment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDeployment

toConstr :: CreateDeployment -> Constr

dataTypeOf :: CreateDeployment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDeployment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDeployment)

gmapT :: (forall b. Data b => b -> b) -> CreateDeployment -> CreateDeployment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeployment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeployment -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDeployment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDeployment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

Read CreateDeployment

Methods

readsPrec :: Int -> ReadS CreateDeployment

readList :: ReadS [CreateDeployment]

readPrec :: ReadPrec CreateDeployment

readListPrec :: ReadPrec [CreateDeployment]

Show CreateDeployment

Methods

showsPrec :: Int -> CreateDeployment -> ShowS

show :: CreateDeployment -> String

showList :: [CreateDeployment] -> ShowS

Generic CreateDeployment

Associated Types

type Rep CreateDeployment :: * -> *

Methods

from :: CreateDeployment -> Rep CreateDeployment x

to :: Rep CreateDeployment x -> CreateDeployment

Hashable CreateDeployment

Methods

hashWithSalt :: Int -> CreateDeployment -> Int

hash :: CreateDeployment -> Int

ToJSON CreateDeployment

Methods

toJSON :: CreateDeployment -> Value

toEncoding :: CreateDeployment -> Encoding

toJSONList :: [CreateDeployment] -> Value

toEncodingList :: [CreateDeployment] -> Encoding

NFData CreateDeployment

Methods

rnf :: CreateDeployment -> ()

AWSRequest CreateDeployment

Associated Types

type Rs CreateDeployment :: *

Methods

request :: CreateDeployment -> Request CreateDeployment

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateDeployment -> ClientResponse -> m (Response CreateDeployment)

ToHeaders CreateDeployment

Methods

toHeaders :: CreateDeployment -> [Header]

ToPath CreateDeployment

Methods

toPath :: CreateDeployment -> ByteString

ToQuery CreateDeployment

Methods

toQuery :: CreateDeployment -> QueryString

type Rep CreateDeployment

type Rep CreateDeployment = D1 * (MetaData "CreateDeployment" "Network.AWS.CodeDeploy.CreateDeployment" "amazonka-codedeploy-1.6.0-FbexHQXokzbCl7hnYMiCm8" False) (C1 * (MetaCons "CreateDeployment'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdDeploymentConfigName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdFileExistsBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FileExistsBehavior)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdTargetInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TargetInstances))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdRevision") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RevisionLocation))) (S1 * (MetaSel (Just Symbol "_cdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdAutoRollbackConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AutoRollbackConfiguration))) (S1 * (MetaSel (Just Symbol "_cdUpdateOutdatedInstancesOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdDeploymentGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdIgnoreApplicationStopFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cdApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs CreateDeployment

type Rs CreateDeployment = CreateDeploymentResponse

Request Lenses

cdDeploymentConfigName :: Lens' CreateDeployment (Maybe Text)

The name of a deployment configuration associated with the applicable IAM user or AWS account. If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

cdFileExistsBehavior :: Lens' CreateDeployment (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.

cdTargetInstances :: Lens' CreateDeployment (Maybe TargetInstances)

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

cdRevision :: Lens' CreateDeployment (Maybe RevisionLocation)

The type and location of the revision to deploy.

cdDescription :: Lens' CreateDeployment (Maybe Text)

A comment about the deployment.

cdAutoRollbackConfiguration :: Lens' CreateDeployment (Maybe AutoRollbackConfiguration)

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

cdUpdateOutdatedInstancesOnly :: Lens' CreateDeployment (Maybe Bool)

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

cdDeploymentGroupName :: Lens' CreateDeployment (Maybe Text)

The name of the deployment group.

cdIgnoreApplicationStopFailures :: Lens' CreateDeployment (Maybe Bool)

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event. If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

cdApplicationName :: Lens' CreateDeployment Text

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

Destructuring the Response

createDeploymentResponse

Arguments

:: Int

cdrsResponseStatus

-> CreateDeploymentResponse

Creates a value of CreateDeploymentResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdrsDeploymentId - A unique deployment ID.
• cdrsResponseStatus - -- | The response status code.

data CreateDeploymentResponse

Represents the output of a CreateDeployment operation.

See: createDeploymentResponse smart constructor.

Instances

Eq CreateDeploymentResponse

Methods

(==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool

(/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool

Data CreateDeploymentResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDeploymentResponse -> c CreateDeploymentResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDeploymentResponse

toConstr :: CreateDeploymentResponse -> Constr

dataTypeOf :: CreateDeploymentResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDeploymentResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDeploymentResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateDeploymentResponse -> CreateDeploymentResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeploymentResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeploymentResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDeploymentResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDeploymentResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDeploymentResponse -> m CreateDeploymentResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeploymentResponse -> m CreateDeploymentResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeploymentResponse -> m CreateDeploymentResponse

Read CreateDeploymentResponse

Methods

readsPrec :: Int -> ReadS CreateDeploymentResponse

readList :: ReadS [CreateDeploymentResponse]

readPrec :: ReadPrec CreateDeploymentResponse

readListPrec :: ReadPrec [CreateDeploymentResponse]

Show CreateDeploymentResponse

Methods

showsPrec :: Int -> CreateDeploymentResponse -> ShowS

show :: CreateDeploymentResponse -> String

showList :: [CreateDeploymentResponse] -> ShowS

Generic CreateDeploymentResponse

Associated Types

type Rep CreateDeploymentResponse :: * -> *

Methods

from :: CreateDeploymentResponse -> Rep CreateDeploymentResponse x

to :: Rep CreateDeploymentResponse x -> CreateDeploymentResponse

NFData CreateDeploymentResponse

Methods

rnf :: CreateDeploymentResponse -> ()

type Rep CreateDeploymentResponse

type Rep CreateDeploymentResponse = D1 * (MetaData "CreateDeploymentResponse" "Network.AWS.CodeDeploy.CreateDeployment" "amazonka-codedeploy-1.6.0-FbexHQXokzbCl7hnYMiCm8" False) (C1 * (MetaCons "CreateDeploymentResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdrsDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cdrsDeploymentId :: Lens' CreateDeploymentResponse (Maybe Text)

A unique deployment ID.

cdrsResponseStatus :: Lens' CreateDeploymentResponse Int

• - | The response status code.