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 |
Creates a deployment group to which application revisions are deployed.
Synopsis
- data CreateDeploymentGroup = CreateDeploymentGroup' {
- alarmConfiguration :: Maybe AlarmConfiguration
- autoRollbackConfiguration :: Maybe AutoRollbackConfiguration
- autoScalingGroups :: Maybe [Text]
- blueGreenDeploymentConfiguration :: Maybe BlueGreenDeploymentConfiguration
- deploymentConfigName :: Maybe Text
- deploymentStyle :: Maybe DeploymentStyle
- ec2TagFilters :: Maybe [EC2TagFilter]
- ec2TagSet :: Maybe EC2TagSet
- ecsServices :: Maybe [ECSService]
- loadBalancerInfo :: Maybe LoadBalancerInfo
- onPremisesInstanceTagFilters :: Maybe [TagFilter]
- onPremisesTagSet :: Maybe OnPremisesTagSet
- outdatedInstancesStrategy :: Maybe OutdatedInstancesStrategy
- tags :: Maybe [Tag]
- triggerConfigurations :: Maybe [TriggerConfig]
- applicationName :: Text
- deploymentGroupName :: Text
- serviceRoleArn :: Text
- newCreateDeploymentGroup :: Text -> Text -> Text -> CreateDeploymentGroup
- createDeploymentGroup_alarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration)
- createDeploymentGroup_autoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration)
- createDeploymentGroup_autoScalingGroups :: Lens' CreateDeploymentGroup (Maybe [Text])
- createDeploymentGroup_blueGreenDeploymentConfiguration :: Lens' CreateDeploymentGroup (Maybe BlueGreenDeploymentConfiguration)
- createDeploymentGroup_deploymentConfigName :: Lens' CreateDeploymentGroup (Maybe Text)
- createDeploymentGroup_deploymentStyle :: Lens' CreateDeploymentGroup (Maybe DeploymentStyle)
- createDeploymentGroup_ec2TagFilters :: Lens' CreateDeploymentGroup (Maybe [EC2TagFilter])
- createDeploymentGroup_ec2TagSet :: Lens' CreateDeploymentGroup (Maybe EC2TagSet)
- createDeploymentGroup_ecsServices :: Lens' CreateDeploymentGroup (Maybe [ECSService])
- createDeploymentGroup_loadBalancerInfo :: Lens' CreateDeploymentGroup (Maybe LoadBalancerInfo)
- createDeploymentGroup_onPremisesInstanceTagFilters :: Lens' CreateDeploymentGroup (Maybe [TagFilter])
- createDeploymentGroup_onPremisesTagSet :: Lens' CreateDeploymentGroup (Maybe OnPremisesTagSet)
- createDeploymentGroup_outdatedInstancesStrategy :: Lens' CreateDeploymentGroup (Maybe OutdatedInstancesStrategy)
- createDeploymentGroup_tags :: Lens' CreateDeploymentGroup (Maybe [Tag])
- createDeploymentGroup_triggerConfigurations :: Lens' CreateDeploymentGroup (Maybe [TriggerConfig])
- createDeploymentGroup_applicationName :: Lens' CreateDeploymentGroup Text
- createDeploymentGroup_deploymentGroupName :: Lens' CreateDeploymentGroup Text
- createDeploymentGroup_serviceRoleArn :: Lens' CreateDeploymentGroup Text
- data CreateDeploymentGroupResponse = CreateDeploymentGroupResponse' {}
- newCreateDeploymentGroupResponse :: Int -> CreateDeploymentGroupResponse
- createDeploymentGroupResponse_deploymentGroupId :: Lens' CreateDeploymentGroupResponse (Maybe Text)
- createDeploymentGroupResponse_httpStatus :: Lens' CreateDeploymentGroupResponse Int
Creating a Request
data CreateDeploymentGroup Source #
Represents the input of a CreateDeploymentGroup
operation.
See: newCreateDeploymentGroup
smart constructor.
CreateDeploymentGroup' | |
|
Instances
newCreateDeploymentGroup Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateDeploymentGroup |
Create a value of CreateDeploymentGroup
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:
CreateDeploymentGroup
, createDeploymentGroup_alarmConfiguration
- Information to add about Amazon CloudWatch alarms when the deployment
group is created.
CreateDeploymentGroup
, createDeploymentGroup_autoRollbackConfiguration
- Configuration information for an automatic rollback that is added when a
deployment group is created.
CreateDeploymentGroup
, createDeploymentGroup_autoScalingGroups
- A list of associated Amazon EC2 Auto Scaling groups.
CreateDeploymentGroup
, createDeploymentGroup_blueGreenDeploymentConfiguration
- Information about blue/green deployment options for a deployment group.
CreateDeploymentGroup
, createDeploymentGroup_deploymentConfigName
- If specified, the deployment configuration name can be either one of the
predefined configurations provided with CodeDeploy or a custom
deployment configuration that you create by calling the create
deployment configuration operation.
CodeDeployDefault.OneAtATime
is the default deployment configuration.
It is used if a configuration isn't specified for the deployment or
deployment group.
For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
CreateDeploymentGroup
, createDeploymentGroup_deploymentStyle
- Information about the type of deployment, in-place or blue/green, that
you want to run and whether to route deployment traffic behind a load
balancer.
CreateDeploymentGroup
, createDeploymentGroup_ec2TagFilters
- The Amazon EC2 tags on which to filter. The deployment group includes
Amazon EC2 instances with any of the specified tags. Cannot be used in
the same call as ec2TagSet.
CreateDeploymentGroup
, createDeploymentGroup_ec2TagSet
- Information about groups of tags applied to Amazon EC2 instances. The
deployment group includes only Amazon EC2 instances identified by all
the tag groups. Cannot be used in the same call as ec2TagFilters
.
CreateDeploymentGroup
, createDeploymentGroup_ecsServices
- The target Amazon ECS services in the deployment group. This applies
only to deployment groups that use the Amazon ECS compute platform. A
target Amazon ECS service is specified as an Amazon ECS cluster and
service name pair using the format <clustername>:<servicename>
.
CreateDeploymentGroup
, createDeploymentGroup_loadBalancerInfo
- Information about the load balancer used in a deployment.
CreateDeploymentGroup
, createDeploymentGroup_onPremisesInstanceTagFilters
- The on-premises instance tags on which to filter. The deployment group
includes on-premises instances with any of the specified tags. Cannot be
used in the same call as OnPremisesTagSet
.
CreateDeploymentGroup
, createDeploymentGroup_onPremisesTagSet
- Information about groups of tags applied to on-premises instances. The
deployment group includes only on-premises instances identified by all
of the tag groups. Cannot be used in the same call as
onPremisesInstanceTagFilters
.
CreateDeploymentGroup
, createDeploymentGroup_outdatedInstancesStrategy
- Indicates what happens when new Amazon EC2 instances are launched
mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
or is unspecified, CodeDeploy
initiates one or more 'auto-update outdated instances' deployments to
apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE
, CodeDeploy does not initiate a
deployment to update the new Amazon EC2 instances. This may result in
instances having different revisions.
CreateDeploymentGroup
, createDeploymentGroup_tags
- The metadata that you apply to CodeDeploy deployment groups to help you
organize and categorize them. Each tag consists of a key and an optional
value, both of which you define.
CreateDeploymentGroup
, createDeploymentGroup_triggerConfigurations
- Information about triggers to create when the deployment group is
created. For examples, see
Create a Trigger for an CodeDeploy Event
in the CodeDeploy User Guide.
CreateDeploymentGroup
, createDeploymentGroup_applicationName
- The name of an CodeDeploy application associated with the IAM user or
Amazon Web Services account.
CreateDeploymentGroup
, createDeploymentGroup_deploymentGroupName
- The name of a new deployment group for the specified application.
CreateDeploymentGroup
, createDeploymentGroup_serviceRoleArn
- A service role Amazon Resource Name (ARN) that allows CodeDeploy to act
on the user's behalf when interacting with Amazon Web Services
services.
Request Lenses
createDeploymentGroup_alarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration) Source #
Information to add about Amazon CloudWatch alarms when the deployment group is created.
createDeploymentGroup_autoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #
Configuration information for an automatic rollback that is added when a deployment group is created.
createDeploymentGroup_autoScalingGroups :: Lens' CreateDeploymentGroup (Maybe [Text]) Source #
A list of associated Amazon EC2 Auto Scaling groups.
createDeploymentGroup_blueGreenDeploymentConfiguration :: Lens' CreateDeploymentGroup (Maybe BlueGreenDeploymentConfiguration) Source #
Information about blue/green deployment options for a deployment group.
createDeploymentGroup_deploymentConfigName :: Lens' CreateDeploymentGroup (Maybe Text) Source #
If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime
is the default deployment configuration.
It is used if a configuration isn't specified for the deployment or
deployment group.
For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
createDeploymentGroup_deploymentStyle :: Lens' CreateDeploymentGroup (Maybe DeploymentStyle) Source #
Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
createDeploymentGroup_ec2TagFilters :: Lens' CreateDeploymentGroup (Maybe [EC2TagFilter]) Source #
The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
createDeploymentGroup_ec2TagSet :: Lens' CreateDeploymentGroup (Maybe EC2TagSet) Source #
Information about groups of tags applied to Amazon EC2 instances. The
deployment group includes only Amazon EC2 instances identified by all
the tag groups. Cannot be used in the same call as ec2TagFilters
.
createDeploymentGroup_ecsServices :: Lens' CreateDeploymentGroup (Maybe [ECSService]) Source #
The target Amazon ECS services in the deployment group. This applies
only to deployment groups that use the Amazon ECS compute platform. A
target Amazon ECS service is specified as an Amazon ECS cluster and
service name pair using the format <clustername>:<servicename>
.
createDeploymentGroup_loadBalancerInfo :: Lens' CreateDeploymentGroup (Maybe LoadBalancerInfo) Source #
Information about the load balancer used in a deployment.
createDeploymentGroup_onPremisesInstanceTagFilters :: Lens' CreateDeploymentGroup (Maybe [TagFilter]) Source #
The on-premises instance tags on which to filter. The deployment group
includes on-premises instances with any of the specified tags. Cannot be
used in the same call as OnPremisesTagSet
.
createDeploymentGroup_onPremisesTagSet :: Lens' CreateDeploymentGroup (Maybe OnPremisesTagSet) Source #
Information about groups of tags applied to on-premises instances. The
deployment group includes only on-premises instances identified by all
of the tag groups. Cannot be used in the same call as
onPremisesInstanceTagFilters
.
createDeploymentGroup_outdatedInstancesStrategy :: Lens' CreateDeploymentGroup (Maybe OutdatedInstancesStrategy) Source #
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
or is unspecified, CodeDeploy
initiates one or more 'auto-update outdated instances' deployments to
apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE
, CodeDeploy does not initiate a
deployment to update the new Amazon EC2 instances. This may result in
instances having different revisions.
createDeploymentGroup_tags :: Lens' CreateDeploymentGroup (Maybe [Tag]) Source #
The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
createDeploymentGroup_triggerConfigurations :: Lens' CreateDeploymentGroup (Maybe [TriggerConfig]) Source #
Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.
createDeploymentGroup_applicationName :: Lens' CreateDeploymentGroup Text Source #
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
createDeploymentGroup_deploymentGroupName :: Lens' CreateDeploymentGroup Text Source #
The name of a new deployment group for the specified application.
createDeploymentGroup_serviceRoleArn :: Lens' CreateDeploymentGroup Text Source #
A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
Destructuring the Response
data CreateDeploymentGroupResponse Source #
Represents the output of a CreateDeploymentGroup
operation.
See: newCreateDeploymentGroupResponse
smart constructor.
CreateDeploymentGroupResponse' | |
|
Instances
newCreateDeploymentGroupResponse Source #
Create a value of CreateDeploymentGroupResponse
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:
CreateDeploymentGroupResponse
, createDeploymentGroupResponse_deploymentGroupId
- A unique deployment group ID.
$sel:httpStatus:CreateDeploymentGroupResponse'
, createDeploymentGroupResponse_httpStatus
- The response's http status code.
Response Lenses
createDeploymentGroupResponse_deploymentGroupId :: Lens' CreateDeploymentGroupResponse (Maybe Text) Source #
A unique deployment group ID.
createDeploymentGroupResponse_httpStatus :: Lens' CreateDeploymentGroupResponse Int Source #
The response's http status code.