Interface CfnDeploymentGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeploymentGroupProps.Jsii$Proxy
CfnDeploymentGroup.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codedeploy.*;
CfnDeploymentGroupProps cfnDeploymentGroupProps = CfnDeploymentGroupProps.builder()
.applicationName("applicationName")
.serviceRoleArn("serviceRoleArn")
// the properties below are optional
.alarmConfiguration(AlarmConfigurationProperty.builder()
.alarms(List.of(AlarmProperty.builder()
.name("name")
.build()))
.enabled(false)
.ignorePollAlarmFailure(false)
.build())
.autoRollbackConfiguration(AutoRollbackConfigurationProperty.builder()
.enabled(false)
.events(List.of("events"))
.build())
.autoScalingGroups(List.of("autoScalingGroups"))
.blueGreenDeploymentConfiguration(BlueGreenDeploymentConfigurationProperty.builder()
.deploymentReadyOption(DeploymentReadyOptionProperty.builder()
.actionOnTimeout("actionOnTimeout")
.waitTimeInMinutes(123)
.build())
.greenFleetProvisioningOption(GreenFleetProvisioningOptionProperty.builder()
.action("action")
.build())
.terminateBlueInstancesOnDeploymentSuccess(BlueInstanceTerminationOptionProperty.builder()
.action("action")
.terminationWaitTimeInMinutes(123)
.build())
.build())
.deployment(DeploymentProperty.builder()
.revision(RevisionLocationProperty.builder()
.gitHubLocation(GitHubLocationProperty.builder()
.commitId("commitId")
.repository("repository")
.build())
.revisionType("revisionType")
.s3Location(S3LocationProperty.builder()
.bucket("bucket")
.key("key")
// the properties below are optional
.bundleType("bundleType")
.eTag("eTag")
.version("version")
.build())
.build())
// the properties below are optional
.description("description")
.ignoreApplicationStopFailures(false)
.build())
.deploymentConfigName("deploymentConfigName")
.deploymentGroupName("deploymentGroupName")
.deploymentStyle(DeploymentStyleProperty.builder()
.deploymentOption("deploymentOption")
.deploymentType("deploymentType")
.build())
.ec2TagFilters(List.of(EC2TagFilterProperty.builder()
.key("key")
.type("type")
.value("value")
.build()))
.ec2TagSet(EC2TagSetProperty.builder()
.ec2TagSetList(List.of(EC2TagSetListObjectProperty.builder()
.ec2TagGroup(List.of(EC2TagFilterProperty.builder()
.key("key")
.type("type")
.value("value")
.build()))
.build()))
.build())
.ecsServices(List.of(ECSServiceProperty.builder()
.clusterName("clusterName")
.serviceName("serviceName")
.build()))
.loadBalancerInfo(LoadBalancerInfoProperty.builder()
.elbInfoList(List.of(ELBInfoProperty.builder()
.name("name")
.build()))
.targetGroupInfoList(List.of(TargetGroupInfoProperty.builder()
.name("name")
.build()))
.targetGroupPairInfoList(List.of(TargetGroupPairInfoProperty.builder()
.prodTrafficRoute(TrafficRouteProperty.builder()
.listenerArns(List.of("listenerArns"))
.build())
.targetGroups(List.of(TargetGroupInfoProperty.builder()
.name("name")
.build()))
.testTrafficRoute(TrafficRouteProperty.builder()
.listenerArns(List.of("listenerArns"))
.build())
.build()))
.build())
.onPremisesInstanceTagFilters(List.of(TagFilterProperty.builder()
.key("key")
.type("type")
.value("value")
.build()))
.onPremisesTagSet(OnPremisesTagSetProperty.builder()
.onPremisesTagSetList(List.of(OnPremisesTagSetListObjectProperty.builder()
.onPremisesTagGroup(List.of(TagFilterProperty.builder()
.key("key")
.type("type")
.value("value")
.build()))
.build()))
.build())
.outdatedInstancesStrategy("outdatedInstancesStrategy")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.terminationHookEnabled(false)
.triggerConfigurations(List.of(TriggerConfigProperty.builder()
.triggerEvents(List.of("triggerEvents"))
.triggerName("triggerName")
.triggerTargetArn("triggerTargetArn")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDeploymentGroupPropsstatic final classAn implementation forCfnDeploymentGroupProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectInformation about the Amazon CloudWatch alarms that are associated with the deployment group.The name of an existing CodeDeploy application to associate this deployment group with.default ObjectInformation about the automatic rollback configuration that is associated with the deployment group.A list of associated Amazon EC2 Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.default ObjectInformation about blue/green deployment options for a deployment group.default ObjectThe application revision to deploy to this deployment group.default StringA deployment configuration name or a predefined configuration name.default StringA name for the deployment group.default ObjectAttributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.default ObjectThe Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.default ObjectInformation about groups of tags applied to Amazon EC2 instances.default ObjectThe target Amazon ECS services in the deployment group.default ObjectInformation about the load balancer to use in a deployment.default ObjectThe on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.default ObjectInformation about groups of tags applied to on-premises instances.default StringIndicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.getTags()The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.default ObjectIndicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.default ObjectInformation about triggers associated with the deployment group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationName
The name of an existing CodeDeploy application to associate this deployment group with.- See Also:
-
getServiceRoleArn
A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide .
In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute .
- See Also:
-
getAlarmConfiguration
Information about the Amazon CloudWatch alarms that are associated with the deployment group.Returns union: either
IResolvableorCfnDeploymentGroup.AlarmConfigurationProperty- See Also:
-
getAutoRollbackConfiguration
Information about the automatic rollback configuration that is associated with the deployment group.If you specify this property, don't specify the
Deploymentproperty.Returns union: either
IResolvableorCfnDeploymentGroup.AutoRollbackConfigurationProperty- See Also:
-
getAutoScalingGroups
A list of associated Amazon EC2 Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.Duplicates are not allowed.
- See Also:
-
getBlueGreenDeploymentConfiguration
Information about blue/green deployment options for a deployment group.Returns union: either
IResolvableorCfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty- See Also:
-
getDeployment
The application revision to deploy to this deployment group.If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the
AutoRollbackConfigurationproperty.Returns union: either
IResolvableorCfnDeploymentGroup.DeploymentProperty- See Also:
-
getDeploymentConfigName
A deployment configuration name or a predefined configuration name.With predefined configurations, you can deploy application revisions to one instance at a time (
CodeDeployDefault.OneAtATime), half of the instances at a time (CodeDeployDefault.HalfAtATime), or all the instances at once (CodeDeployDefault.AllAtOnce). For more information and valid values, see Working with Deployment Configurations in the AWS CodeDeploy User Guide .- See Also:
-
getDeploymentGroupName
A name for the deployment group.If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- See Also:
-
getDeploymentStyle
Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.If you specify this property with a blue/green deployment type, don't specify the
AutoScalingGroups,LoadBalancerInfo, orDeploymentproperties.For blue/green deployments, CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using
AWS::CodeDeploy::BlueGreenhook. See Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation for more information.Returns union: either
IResolvableorCfnDeploymentGroup.DeploymentStyleProperty- See Also:
-
getEc2TagFilters
The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.
You can specify
EC2TagFiltersorEc2TagSet, but not both.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDeploymentGroup.EC2TagFilterProperty>- See Also:
-
getEc2TagSet
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
ec2TagFilter.Returns union: either
IResolvableorCfnDeploymentGroup.EC2TagSetProperty- See Also:
-
getEcsServices
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>.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDeploymentGroup.ECSServiceProperty>- See Also:
-
getLoadBalancerInfo
Information about the load balancer to use in a deployment.For more information, see Integrating CodeDeploy with ELB in the AWS CodeDeploy User Guide .
Returns union: either
IResolvableorCfnDeploymentGroup.LoadBalancerInfoProperty- See Also:
-
getOnPremisesInstanceTagFilters
The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.
You can specify
OnPremisesInstanceTagFiltersorOnPremisesInstanceTagSet, but not both.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDeploymentGroup.TagFilterProperty>- See Also:
-
getOnPremisesTagSet
Information about groups of tags applied to on-premises instances.The deployment group includes only on-premises instances identified by all the tag groups.
You can specify
OnPremisesInstanceTagFiltersorOnPremisesInstanceTagSet, but not both.Returns union: either
IResolvableorCfnDeploymentGroup.OnPremisesTagSetProperty- See Also:
-
getOutdatedInstancesStrategy
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
UPDATEor 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.- See Also:
-
getTags
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.
- See Also:
-
getTerminationHookEnabled
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the AWS CodeDeploy User Guide .
Returns union: either
BooleanorIResolvable- See Also:
-
getTriggerConfigurations
Information about triggers associated with the deployment group.Duplicates are not allowed
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDeploymentGroup.TriggerConfigProperty>- See Also:
-
builder
- Returns:
- a
CfnDeploymentGroupProps.BuilderofCfnDeploymentGroupProps
-