software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-15T10:03:47.371Z")
 @Stability(value=Stable)
public interface CfnDeploymentGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::CodeDeploy::DeploymentGroup`.

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()))
                 .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())
         .triggerConfigurations(List.of(TriggerConfigProperty.builder()
                 .triggerEvents(List.of("triggerEvents"))
                 .triggerName("triggerName")
                 .triggerTargetArn("triggerTargetArn")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeploymentGroupProps.Builder A builder for CfnDeploymentGroupProps
static class	CfnDeploymentGroupProps.Jsii$Proxy An implementation for CfnDeploymentGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentGroupProps.Builder	builder()
default Object	getAlarmConfiguration() `AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration`.
String	getApplicationName() `AWS::CodeDeploy::DeploymentGroup.ApplicationName`.
default Object	getAutoRollbackConfiguration() `AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration`.
default List<String>	getAutoScalingGroups() `AWS::CodeDeploy::DeploymentGroup.AutoScalingGroups`.
default Object	getBlueGreenDeploymentConfiguration() `AWS::CodeDeploy::DeploymentGroup.BlueGreenDeploymentConfiguration`.
default Object	getDeployment() `AWS::CodeDeploy::DeploymentGroup.Deployment`.
default String	getDeploymentConfigName() `AWS::CodeDeploy::DeploymentGroup.DeploymentConfigName`.
default String	getDeploymentGroupName() `AWS::CodeDeploy::DeploymentGroup.DeploymentGroupName`.
default Object	getDeploymentStyle() `AWS::CodeDeploy::DeploymentGroup.DeploymentStyle`.
default Object	getEc2TagFilters() `AWS::CodeDeploy::DeploymentGroup.Ec2TagFilters`.
default Object	getEc2TagSet() `AWS::CodeDeploy::DeploymentGroup.Ec2TagSet`.
default Object	getEcsServices() `AWS::CodeDeploy::DeploymentGroup.ECSServices`.
default Object	getLoadBalancerInfo() `AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo`.
default Object	getOnPremisesInstanceTagFilters() `AWS::CodeDeploy::DeploymentGroup.OnPremisesInstanceTagFilters`.
default Object	getOnPremisesTagSet() `AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet`.
String	getServiceRoleArn() `AWS::CodeDeploy::DeploymentGroup.ServiceRoleArn`.
default Object	getTriggerConfigurations() `AWS::CodeDeploy::DeploymentGroup.TriggerConfigurations`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlarmConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAlarmConfiguration()

`AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration`.

getApplicationName

@Stability(value=Stable)
 @NotNull
String getApplicationName()

`AWS::CodeDeploy::DeploymentGroup.ApplicationName`.

getAutoRollbackConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAutoRollbackConfiguration()

`AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration`.

getAutoScalingGroups

@Stability(value=Stable)
 @Nullable
default List<String> getAutoScalingGroups()

`AWS::CodeDeploy::DeploymentGroup.AutoScalingGroups`.

getBlueGreenDeploymentConfiguration

@Stability(value=Stable)
 @Nullable
default Object getBlueGreenDeploymentConfiguration()

`AWS::CodeDeploy::DeploymentGroup.BlueGreenDeploymentConfiguration`.

getDeployment

@Stability(value=Stable)
 @Nullable
default Object getDeployment()

`AWS::CodeDeploy::DeploymentGroup.Deployment`.

getDeploymentConfigName

@Stability(value=Stable)
 @Nullable
default String getDeploymentConfigName()

`AWS::CodeDeploy::DeploymentGroup.DeploymentConfigName`.

getDeploymentGroupName

@Stability(value=Stable)
 @Nullable
default String getDeploymentGroupName()

`AWS::CodeDeploy::DeploymentGroup.DeploymentGroupName`.

getDeploymentStyle

@Stability(value=Stable)
 @Nullable
default Object getDeploymentStyle()

`AWS::CodeDeploy::DeploymentGroup.DeploymentStyle`.

getEc2TagFilters

@Stability(value=Stable)
 @Nullable
default Object getEc2TagFilters()

`AWS::CodeDeploy::DeploymentGroup.Ec2TagFilters`.

getEc2TagSet

@Stability(value=Stable)
 @Nullable
default Object getEc2TagSet()

`AWS::CodeDeploy::DeploymentGroup.Ec2TagSet`.

getEcsServices

@Stability(value=Stable)
 @Nullable
default Object getEcsServices()

`AWS::CodeDeploy::DeploymentGroup.ECSServices`.

getLoadBalancerInfo

@Stability(value=Stable)
 @Nullable
default Object getLoadBalancerInfo()

`AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo`.

getOnPremisesInstanceTagFilters

@Stability(value=Stable)
 @Nullable
default Object getOnPremisesInstanceTagFilters()

`AWS::CodeDeploy::DeploymentGroup.OnPremisesInstanceTagFilters`.

getOnPremisesTagSet

@Stability(value=Stable)
 @Nullable
default Object getOnPremisesTagSet()

`AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet`.

getServiceRoleArn

@Stability(value=Stable)
 @NotNull
String getServiceRoleArn()

`AWS::CodeDeploy::DeploymentGroup.ServiceRoleArn`.

getTriggerConfigurations

@Stability(value=Stable)
 @Nullable
default Object getTriggerConfigurations()

`AWS::CodeDeploy::DeploymentGroup.TriggerConfigurations`.

builder

@Stability(value=Stable)
static CfnDeploymentGroupProps.Builder builder()

Returns:

a CfnDeploymentGroupProps.Builder of CfnDeploymentGroupProps