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.CreateDeploymentGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a deployment group to which application revisions are deployed.

Synopsis

Creating a Request

data CreateDeploymentGroup Source #

Represents the input of a CreateDeploymentGroup operation.

See: newCreateDeploymentGroup smart constructor.

Constructors

CreateDeploymentGroup'

Fields

alarmConfiguration :: Maybe AlarmConfiguration
Information to add about Amazon CloudWatch alarms when the deployment group is created.
autoRollbackConfiguration :: Maybe AutoRollbackConfiguration
Configuration information for an automatic rollback that is added when a deployment group is created.
autoScalingGroups :: Maybe [Text]
A list of associated Amazon EC2 Auto Scaling groups.
blueGreenDeploymentConfiguration :: Maybe BlueGreenDeploymentConfiguration
Information about blue/green deployment options for a deployment group.
deploymentConfigName :: Maybe Text
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.
deploymentStyle :: Maybe 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.
ec2TagFilters :: Maybe [EC2TagFilter]
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.
ec2TagSet :: Maybe 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.
ecsServices :: Maybe [ECSService]
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>.
loadBalancerInfo :: Maybe LoadBalancerInfo
Information about the load balancer used in a deployment.
onPremisesInstanceTagFilters :: Maybe [TagFilter]
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.
onPremisesTagSet :: Maybe 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.
outdatedInstancesStrategy :: Maybe 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.
tags :: Maybe [Tag]
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.
triggerConfigurations :: Maybe [TriggerConfig]
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.
applicationName :: Text
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName :: Text
The name of a new deployment group for the specified application.
serviceRoleArn :: Text
A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Instances

Instances details

ToJSON CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods toJSON :: CreateDeploymentGroup -> Value # toEncoding :: CreateDeploymentGroup -> Encoding # toJSONList :: [CreateDeploymentGroup] -> Value # toEncodingList :: [CreateDeploymentGroup] -> Encoding #
ToHeaders CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods toHeaders :: CreateDeploymentGroup -> [Header] #
ToPath CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods toPath :: CreateDeploymentGroup -> ByteString #
ToQuery CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods toQuery :: CreateDeploymentGroup -> QueryString #
AWSRequest CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Associated Types type AWSResponse CreateDeploymentGroup # Methods request :: (Service -> Service) -> CreateDeploymentGroup -> Request CreateDeploymentGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeploymentGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeploymentGroup))) #
Generic CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Associated Types type Rep CreateDeploymentGroup :: Type -> Type # Methods from :: CreateDeploymentGroup -> Rep CreateDeploymentGroup x # to :: Rep CreateDeploymentGroup x -> CreateDeploymentGroup #
Read CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods readsPrec :: Int -> ReadS CreateDeploymentGroup # readList :: ReadS [CreateDeploymentGroup] # readPrec :: ReadPrec CreateDeploymentGroup # readListPrec :: ReadPrec [CreateDeploymentGroup] #
Show CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods showsPrec :: Int -> CreateDeploymentGroup -> ShowS # show :: CreateDeploymentGroup -> String # showList :: [CreateDeploymentGroup] -> ShowS #
NFData CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods rnf :: CreateDeploymentGroup -> () #
Eq CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods (==) :: CreateDeploymentGroup -> CreateDeploymentGroup -> Bool # (/=) :: CreateDeploymentGroup -> CreateDeploymentGroup -> Bool #
Hashable CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup Methods hashWithSalt :: Int -> CreateDeploymentGroup -> Int # hash :: CreateDeploymentGroup -> Int #
type AWSResponse CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup type AWSResponse CreateDeploymentGroup = CreateDeploymentGroupResponse
type Rep CreateDeploymentGroup Source #
Instance details Defined in Amazonka.CodeDeploy.CreateDeploymentGroup type Rep CreateDeploymentGroup = D1 ('MetaData "CreateDeploymentGroup" "Amazonka.CodeDeploy.CreateDeploymentGroup" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "CreateDeploymentGroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :: S1 ('MetaSel ('Just "autoRollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRollbackConfiguration))) :: (S1 ('MetaSel ('Just "autoScalingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "blueGreenDeploymentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlueGreenDeploymentConfiguration)))) :: ((S1 ('MetaSel ('Just "deploymentConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deploymentStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStyle))) :: (S1 ('MetaSel ('Just "ec2TagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EC2TagFilter])) :: (S1 ('MetaSel ('Just "ec2TagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EC2TagSet)) :: S1 ('MetaSel ('Just "ecsServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ECSService])))))) :: (((S1 ('MetaSel ('Just "loadBalancerInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerInfo)) :: S1 ('MetaSel ('Just "onPremisesInstanceTagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter]))) :: (S1 ('MetaSel ('Just "onPremisesTagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremisesTagSet)) :: S1 ('MetaSel ('Just "outdatedInstancesStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutdatedInstancesStrategy)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "triggerConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TriggerConfig]))) :: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "deploymentGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateDeploymentGroup Source #

Arguments

:: Text	`CreateDeploymentGroup`
-> Text	`CreateDeploymentGroup`
-> Text	`CreateDeploymentGroup`
-> 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.

Constructors

CreateDeploymentGroupResponse'
Fields deploymentGroupId :: Maybe Text A unique deployment group ID. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDeploymentGroupResponse Source #

Arguments

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

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.