libZSservicesZSamazonka-codedeployZSamazonka-codedeploy
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeDeploy.CreateDeploymentGroup

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

  • ec2TagSet :: Maybe EC2TagSet

    Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

  • deploymentConfigName :: Maybe Text

    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.

    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 AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

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

  • ec2TagFilters :: Maybe [EC2TagFilter]

    The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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

  • blueGreenDeploymentConfiguration :: Maybe BlueGreenDeploymentConfiguration

    Information about blue/green deployment options for a deployment group.

  • loadBalancerInfo :: Maybe LoadBalancerInfo

    Information about the load balancer used in a deployment.

  • outdatedInstancesStrategy :: Maybe OutdatedInstancesStrategy

    Indicates what happens when new 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 EC2 instances.

    If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

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

  • alarmConfiguration :: Maybe AlarmConfiguration

    Information to add about Amazon CloudWatch alarms when the deployment group is created.

  • triggerConfigurations :: Maybe [TriggerConfig]

    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.

  • autoScalingGroups :: Maybe [Text]

    A list of associated Amazon EC2 Auto Scaling groups.

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

  • autoRollbackConfiguration :: Maybe AutoRollbackConfiguration

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

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

  • applicationName :: Text

    The name of an AWS CodeDeploy application associated with the IAM user or AWS 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 AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Instances

Instances details
Eq CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Read CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Show CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Generic CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Associated Types

type Rep CreateDeploymentGroup :: Type -> Type #

NFData CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Methods

rnf :: CreateDeploymentGroup -> () #

Hashable CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

ToJSON CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

AWSRequest CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Associated Types

type AWSResponse CreateDeploymentGroup #

ToHeaders CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

ToPath CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

ToQuery CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

type Rep CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

type Rep CreateDeploymentGroup = D1 ('MetaData "CreateDeploymentGroup" "Amazonka.CodeDeploy.CreateDeploymentGroup" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "CreateDeploymentGroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "ec2TagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EC2TagSet)) :*: S1 ('MetaSel ('Just "deploymentConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "onPremisesTagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremisesTagSet)) :*: S1 ('MetaSel ('Just "ec2TagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EC2TagFilter])))) :*: ((S1 ('MetaSel ('Just "ecsServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ECSService])) :*: S1 ('MetaSel ('Just "blueGreenDeploymentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlueGreenDeploymentConfiguration))) :*: (S1 ('MetaSel ('Just "loadBalancerInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerInfo)) :*: (S1 ('MetaSel ('Just "outdatedInstancesStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutdatedInstancesStrategy)) :*: S1 ('MetaSel ('Just "onPremisesInstanceTagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])))))) :*: (((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :*: S1 ('MetaSel ('Just "triggerConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TriggerConfig]))) :*: (S1 ('MetaSel ('Just "autoScalingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "deploymentStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStyle)))) :*: ((S1 ('MetaSel ('Just "autoRollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRollbackConfiguration)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (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)))))))
type AWSResponse CreateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

newCreateDeploymentGroup Source #

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:

$sel:ec2TagSet:CreateDeploymentGroup', createDeploymentGroup_ec2TagSet - Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

$sel:deploymentConfigName:CreateDeploymentGroup', createDeploymentGroup_deploymentConfigName - 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.

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 AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

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

$sel:ec2TagFilters:CreateDeploymentGroup', createDeploymentGroup_ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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

$sel:blueGreenDeploymentConfiguration:CreateDeploymentGroup', createDeploymentGroup_blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

$sel:loadBalancerInfo:CreateDeploymentGroup', createDeploymentGroup_loadBalancerInfo - Information about the load balancer used in a deployment.

$sel:outdatedInstancesStrategy:CreateDeploymentGroup', createDeploymentGroup_outdatedInstancesStrategy - Indicates what happens when new 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 EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

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

$sel:alarmConfiguration:CreateDeploymentGroup', createDeploymentGroup_alarmConfiguration - Information to add about Amazon CloudWatch alarms when the deployment group is created.

$sel:triggerConfigurations:CreateDeploymentGroup', createDeploymentGroup_triggerConfigurations - 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.

$sel:autoScalingGroups:CreateDeploymentGroup', createDeploymentGroup_autoScalingGroups - A list of associated Amazon EC2 Auto Scaling groups.

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

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

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

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

$sel:deploymentGroupName:CreateDeploymentGroup', createDeploymentGroup_deploymentGroupName - The name of a new deployment group for the specified application.

$sel:serviceRoleArn:CreateDeploymentGroup', createDeploymentGroup_serviceRoleArn - A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Request Lenses

createDeploymentGroup_ec2TagSet :: Lens' CreateDeploymentGroup (Maybe EC2TagSet) Source #

Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

createDeploymentGroup_deploymentConfigName :: 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.

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 AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

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_ec2TagFilters :: Lens' CreateDeploymentGroup (Maybe [EC2TagFilter]) Source #

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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_outdatedInstancesStrategy :: Lens' CreateDeploymentGroup (Maybe OutdatedInstancesStrategy) Source #

Indicates what happens when new 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 EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

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_alarmConfiguration :: Lens' CreateDeploymentGroup (Maybe AlarmConfiguration) Source #

Information to add about Amazon CloudWatch alarms when the deployment group is created.

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 AWS CodeDeploy Event in the AWS CodeDeploy User Guide.

createDeploymentGroup_autoScalingGroups :: Lens' CreateDeploymentGroup (Maybe [Text]) Source #

A list of associated Amazon EC2 Auto Scaling groups.

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_autoRollbackConfiguration :: Lens' CreateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #

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

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_applicationName :: Lens' CreateDeploymentGroup Text Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS 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 AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Destructuring the Response

data CreateDeploymentGroupResponse Source #

Represents the output of a CreateDeploymentGroup operation.

See: newCreateDeploymentGroupResponse smart constructor.

Constructors

CreateDeploymentGroupResponse' 

Fields

Instances

Instances details
Eq CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Read CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Show CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Generic CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

Associated Types

type Rep CreateDeploymentGroupResponse :: Type -> Type #

NFData CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

type Rep CreateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.CreateDeploymentGroup

type Rep CreateDeploymentGroupResponse = D1 ('MetaData "CreateDeploymentGroupResponse" "Amazonka.CodeDeploy.CreateDeploymentGroup" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" '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 #

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:

$sel:deploymentGroupId:CreateDeploymentGroupResponse', createDeploymentGroupResponse_deploymentGroupId - A unique deployment group ID.

$sel:httpStatus:CreateDeploymentGroupResponse', createDeploymentGroupResponse_httpStatus - The response's http status code.

Response Lenses