Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a deployment group to which application revisions will be deployed.
- createDeploymentGroup :: Text -> Text -> Text -> CreateDeploymentGroup
- data CreateDeploymentGroup
- cdgDeploymentConfigName :: Lens' CreateDeploymentGroup (Maybe Text)
- cdgEc2TagFilters :: Lens' CreateDeploymentGroup [EC2TagFilter]
- cdgOnPremisesInstanceTagFilters :: Lens' CreateDeploymentGroup [TagFilter]
- cdgAlarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration)
- cdgTriggerConfigurations :: Lens' CreateDeploymentGroup [TriggerConfig]
- cdgAutoScalingGroups :: Lens' CreateDeploymentGroup [Text]
- cdgAutoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration)
- cdgApplicationName :: Lens' CreateDeploymentGroup Text
- cdgDeploymentGroupName :: Lens' CreateDeploymentGroup Text
- cdgServiceRoleARN :: Lens' CreateDeploymentGroup Text
- createDeploymentGroupResponse :: Int -> CreateDeploymentGroupResponse
- data CreateDeploymentGroupResponse
- cdgrsDeploymentGroupId :: Lens' CreateDeploymentGroupResponse (Maybe Text)
- cdgrsResponseStatus :: Lens' CreateDeploymentGroupResponse Int
Creating a Request
createDeploymentGroup Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateDeploymentGroup |
Creates a value of CreateDeploymentGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdgDeploymentConfigName
- 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. The predefined deployment configurations include the following: * CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail. * CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails. * CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time. For deployment groups that contain more than one instance: * The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration. * The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails. * In an example using nine instances, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instances is successful; the overall deployment fails if deployment to any of the first eight instances fails. For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successfulcdgEc2TagFilters
- The Amazon EC2 tags on which to filter.cdgOnPremisesInstanceTagFilters
- The on-premises instance tags on which to filter.cdgAlarmConfiguration
- Information to add about Amazon CloudWatch alarms when the deployment group is created.cdgTriggerConfigurations
- 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.cdgAutoScalingGroups
- A list of associated Auto Scaling groups.cdgAutoRollbackConfiguration
- Configuration information for an automatic rollback that is added when a deployment group is created.cdgApplicationName
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.cdgDeploymentGroupName
- The name of a new deployment group for the specified application.cdgServiceRoleARN
- A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
data CreateDeploymentGroup Source #
Represents the input of a create deployment group operation.
See: createDeploymentGroup
smart constructor.
Request Lenses
cdgDeploymentConfigName :: 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. The predefined deployment configurations include the following: * CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail. * CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails. * CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time. For deployment groups that contain more than one instance: * The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration. * The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails. * In an example using nine instances, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instances is successful; the overall deployment fails if deployment to any of the first eight instances fails. For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
cdgEc2TagFilters :: Lens' CreateDeploymentGroup [EC2TagFilter] Source #
The Amazon EC2 tags on which to filter.
cdgOnPremisesInstanceTagFilters :: Lens' CreateDeploymentGroup [TagFilter] Source #
The on-premises instance tags on which to filter.
cdgAlarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration) Source #
Information to add about Amazon CloudWatch alarms when the deployment group is created.
cdgTriggerConfigurations :: Lens' CreateDeploymentGroup [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.
cdgAutoScalingGroups :: Lens' CreateDeploymentGroup [Text] Source #
A list of associated Auto Scaling groups.
cdgAutoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #
Configuration information for an automatic rollback that is added when a deployment group is created.
cdgApplicationName :: Lens' CreateDeploymentGroup Text Source #
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
cdgDeploymentGroupName :: Lens' CreateDeploymentGroup Text Source #
The name of a new deployment group for the specified application.
cdgServiceRoleARN :: Lens' CreateDeploymentGroup Text Source #
A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
Destructuring the Response
createDeploymentGroupResponse Source #
Creates a value of CreateDeploymentGroupResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdgrsDeploymentGroupId
- A unique deployment group ID.cdgrsResponseStatus
- -- | The response status code.
data CreateDeploymentGroupResponse Source #
Represents the output of a create deployment group operation.
See: createDeploymentGroupResponse
smart constructor.
Response Lenses
cdgrsDeploymentGroupId :: Lens' CreateDeploymentGroupResponse (Maybe Text) Source #
A unique deployment group ID.
cdgrsResponseStatus :: Lens' CreateDeploymentGroupResponse Int Source #
- - | The response status code.