CfnDeploymentGroup L1 construct
The AWS::CodeDeploy::DeploymentGroup resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.
For more information, see CreateDeploymentGroup in the CodeDeploy API Reference .
Amazon ECS blue/green deployments through CodeDeploy do not use the
AWS::CodeDeploy::DeploymentGroupresource. To perform Amazon ECS blue/green deployments, use theAWS::CodeDeploy::BlueGreenhook. See Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation for more information.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const cfnDeploymentGroup = new codedeploy.CfnDeploymentGroup(this, 'MyCfnDeploymentGroup', {
applicationName: 'applicationName',
serviceRoleArn: 'serviceRoleArn',
// the properties below are optional
alarmConfiguration: {
alarms: [{
name: 'name',
}],
enabled: false,
ignorePollAlarmFailure: false,
},
autoRollbackConfiguration: {
enabled: false,
events: ['events'],
},
autoScalingGroups: ['autoScalingGroups'],
blueGreenDeploymentConfiguration: {
deploymentReadyOption: {
actionOnTimeout: 'actionOnTimeout',
waitTimeInMinutes: 123,
},
greenFleetProvisioningOption: {
action: 'action',
},
terminateBlueInstancesOnDeploymentSuccess: {
action: 'action',
terminationWaitTimeInMinutes: 123,
},
},
deployment: {
revision: {
gitHubLocation: {
commitId: 'commitId',
repository: 'repository',
},
revisionType: 'revisionType',
s3Location: {
bucket: 'bucket',
key: 'key',
// the properties below are optional
bundleType: 'bundleType',
eTag: 'eTag',
version: 'version',
},
},
// the properties below are optional
description: 'description',
ignoreApplicationStopFailures: false,
},
deploymentConfigName: 'deploymentConfigName',
deploymentGroupName: 'deploymentGroupName',
deploymentStyle: {
deploymentOption: 'deploymentOption',
deploymentType: 'deploymentType',
},
ec2TagFilters: [{
key: 'key',
type: 'type',
value: 'value',
}],
ec2TagSet: {
ec2TagSetList: [{
ec2TagGroup: [{
key: 'key',
type: 'type',
value: 'value',
}],
}],
},
ecsServices: [{
clusterName: 'clusterName',
serviceName: 'serviceName',
}],
loadBalancerInfo: {
elbInfoList: [{
name: 'name',
}],
targetGroupInfoList: [{
name: 'name',
}],
targetGroupPairInfoList: [{
prodTrafficRoute: {
listenerArns: ['listenerArns'],
},
targetGroups: [{
name: 'name',
}],
testTrafficRoute: {
listenerArns: ['listenerArns'],
},
}],
},
onPremisesInstanceTagFilters: [{
key: 'key',
type: 'type',
value: 'value',
}],
onPremisesTagSet: {
onPremisesTagSetList: [{
onPremisesTagGroup: [{
key: 'key',
type: 'type',
value: 'value',
}],
}],
},
outdatedInstancesStrategy: 'outdatedInstancesStrategy',
tags: [{
key: 'key',
value: 'value',
}],
terminationHookEnabled: false,
triggerConfigurations: [{
triggerEvents: ['triggerEvents'],
triggerName: 'triggerName',
triggerTargetArn: 'triggerTargetArn',
}],
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codedeploy as codedeploy
cfn_deployment_group = codedeploy.CfnDeploymentGroup(self, "MyCfnDeploymentGroup",
application_name="applicationName",
service_role_arn="serviceRoleArn",
# the properties below are optional
alarm_configuration=codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty(
alarms=[codedeploy.CfnDeploymentGroup.AlarmProperty(
name="name"
)],
enabled=False,
ignore_poll_alarm_failure=False
),
auto_rollback_configuration=codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty(
enabled=False,
events=["events"]
),
auto_scaling_groups=["autoScalingGroups"],
blue_green_deployment_configuration=codedeploy.CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty(
deployment_ready_option=codedeploy.CfnDeploymentGroup.DeploymentReadyOptionProperty(
action_on_timeout="actionOnTimeout",
wait_time_in_minutes=123
),
green_fleet_provisioning_option=codedeploy.CfnDeploymentGroup.GreenFleetProvisioningOptionProperty(
action="action"
),
terminate_blue_instances_on_deployment_success=codedeploy.CfnDeploymentGroup.BlueInstanceTerminationOptionProperty(
action="action",
termination_wait_time_in_minutes=123
)
),
deployment=codedeploy.CfnDeploymentGroup.DeploymentProperty(
revision=codedeploy.CfnDeploymentGroup.RevisionLocationProperty(
git_hub_location=codedeploy.CfnDeploymentGroup.GitHubLocationProperty(
commit_id="commitId",
repository="repository"
),
revision_type="revisionType",
s3_location=codedeploy.CfnDeploymentGroup.S3LocationProperty(
bucket="bucket",
key="key",
# the properties below are optional
bundle_type="bundleType",
e_tag="eTag",
version="version"
)
),
# the properties below are optional
description="description",
ignore_application_stop_failures=False
),
deployment_config_name="deploymentConfigName",
deployment_group_name="deploymentGroupName",
deployment_style=codedeploy.CfnDeploymentGroup.DeploymentStyleProperty(
deployment_option="deploymentOption",
deployment_type="deploymentType"
),
ec2_tag_filters=[codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
key="key",
type="type",
value="value"
)],
ec2_tag_set=codedeploy.CfnDeploymentGroup.EC2TagSetProperty(
ec2_tag_set_list=[codedeploy.CfnDeploymentGroup.EC2TagSetListObjectProperty(
ec2_tag_group=[codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
key="key",
type="type",
value="value"
)]
)]
),
ecs_services=[codedeploy.CfnDeploymentGroup.ECSServiceProperty(
cluster_name="clusterName",
service_name="serviceName"
)],
load_balancer_info=codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty(
elb_info_list=[codedeploy.CfnDeploymentGroup.ELBInfoProperty(
name="name"
)],
target_group_info_list=[codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
name="name"
)],
target_group_pair_info_list=[codedeploy.CfnDeploymentGroup.TargetGroupPairInfoProperty(
prod_traffic_route=codedeploy.CfnDeploymentGroup.TrafficRouteProperty(
listener_arns=["listenerArns"]
),
target_groups=[codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
name="name"
)],
test_traffic_route=codedeploy.CfnDeploymentGroup.TrafficRouteProperty(
listener_arns=["listenerArns"]
)
)]
),
on_premises_instance_tag_filters=[codedeploy.CfnDeploymentGroup.TagFilterProperty(
key="key",
type="type",
value="value"
)],
on_premises_tag_set=codedeploy.CfnDeploymentGroup.OnPremisesTagSetProperty(
on_premises_tag_set_list=[codedeploy.CfnDeploymentGroup.OnPremisesTagSetListObjectProperty(
on_premises_tag_group=[codedeploy.CfnDeploymentGroup.TagFilterProperty(
key="key",
type="type",
value="value"
)]
)]
),
outdated_instances_strategy="outdatedInstancesStrategy",
tags=[CfnTag(
key="key",
value="value"
)],
termination_hook_enabled=False,
trigger_configurations=[codedeploy.CfnDeploymentGroup.TriggerConfigProperty(
trigger_events=["triggerEvents"],
trigger_name="triggerName",
trigger_target_arn="triggerTargetArn"
)]
)
java
// 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.*;
CfnDeploymentGroup cfnDeploymentGroup = CfnDeploymentGroup.Builder.create(this, "MyCfnDeploymentGroup")
.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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeDeploy;
var cfnDeploymentGroup = new CfnDeploymentGroup(this, "MyCfnDeploymentGroup", new CfnDeploymentGroupProps {
ApplicationName = "applicationName",
ServiceRoleArn = "serviceRoleArn",
// the properties below are optional
AlarmConfiguration = new AlarmConfigurationProperty {
Alarms = new [] { new AlarmProperty {
Name = "name"
} },
Enabled = false,
IgnorePollAlarmFailure = false
},
AutoRollbackConfiguration = new AutoRollbackConfigurationProperty {
Enabled = false,
Events = new [] { "events" }
},
AutoScalingGroups = new [] { "autoScalingGroups" },
BlueGreenDeploymentConfiguration = new BlueGreenDeploymentConfigurationProperty {
DeploymentReadyOption = new DeploymentReadyOptionProperty {
ActionOnTimeout = "actionOnTimeout",
WaitTimeInMinutes = 123
},
GreenFleetProvisioningOption = new GreenFleetProvisioningOptionProperty {
Action = "action"
},
TerminateBlueInstancesOnDeploymentSuccess = new BlueInstanceTerminationOptionProperty {
Action = "action",
TerminationWaitTimeInMinutes = 123
}
},
Deployment = new DeploymentProperty {
Revision = new RevisionLocationProperty {
GitHubLocation = new GitHubLocationProperty {
CommitId = "commitId",
Repository = "repository"
},
RevisionType = "revisionType",
S3Location = new S3LocationProperty {
Bucket = "bucket",
Key = "key",
// the properties below are optional
BundleType = "bundleType",
ETag = "eTag",
Version = "version"
}
},
// the properties below are optional
Description = "description",
IgnoreApplicationStopFailures = false
},
DeploymentConfigName = "deploymentConfigName",
DeploymentGroupName = "deploymentGroupName",
DeploymentStyle = new DeploymentStyleProperty {
DeploymentOption = "deploymentOption",
DeploymentType = "deploymentType"
},
Ec2TagFilters = new [] { new EC2TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} },
Ec2TagSet = new EC2TagSetProperty {
Ec2TagSetList = new [] { new EC2TagSetListObjectProperty {
Ec2TagGroup = new [] { new EC2TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} }
} }
},
EcsServices = new [] { new ECSServiceProperty {
ClusterName = "clusterName",
ServiceName = "serviceName"
} },
LoadBalancerInfo = new LoadBalancerInfoProperty {
ElbInfoList = new [] { new ELBInfoProperty {
Name = "name"
} },
TargetGroupInfoList = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TargetGroupPairInfoList = new [] { new TargetGroupPairInfoProperty {
ProdTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
},
TargetGroups = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TestTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
}
} }
},
OnPremisesInstanceTagFilters = new [] { new TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} },
OnPremisesTagSet = new OnPremisesTagSetProperty {
OnPremisesTagSetList = new [] { new OnPremisesTagSetListObjectProperty {
OnPremisesTagGroup = new [] { new TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} }
} }
},
OutdatedInstancesStrategy = "outdatedInstancesStrategy",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TerminationHookEnabled = false,
TriggerConfigurations = new [] { new TriggerConfigProperty {
TriggerEvents = new [] { "triggerEvents" },
TriggerName = "triggerName",
TriggerTargetArn = "triggerTargetArn"
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDeploymentGroup := awscdk.Aws_codedeploy.NewCfnDeploymentGroup(this, jsii.String("MyCfnDeploymentGroup"), &CfnDeploymentGroupProps{
ApplicationName: jsii.String("applicationName"),
ServiceRoleArn: jsii.String("serviceRoleArn"),
// the properties below are optional
AlarmConfiguration: &AlarmConfigurationProperty{
Alarms: []interface{}{
&AlarmProperty{
Name: jsii.String("name"),
},
},
Enabled: jsii.Boolean(false),
IgnorePollAlarmFailure: jsii.Boolean(false),
},
AutoRollbackConfiguration: &AutoRollbackConfigurationProperty{
Enabled: jsii.Boolean(false),
Events: []*string{
jsii.String("events"),
},
},
AutoScalingGroups: []*string{
jsii.String("autoScalingGroups"),
},
BlueGreenDeploymentConfiguration: &BlueGreenDeploymentConfigurationProperty{
DeploymentReadyOption: &DeploymentReadyOptionProperty{
ActionOnTimeout: jsii.String("actionOnTimeout"),
WaitTimeInMinutes: jsii.Number(123),
},
GreenFleetProvisioningOption: &GreenFleetProvisioningOptionProperty{
Action: jsii.String("action"),
},
TerminateBlueInstancesOnDeploymentSuccess: &BlueInstanceTerminationOptionProperty{
Action: jsii.String("action"),
TerminationWaitTimeInMinutes: jsii.Number(123),
},
},
Deployment: &DeploymentProperty{
Revision: &RevisionLocationProperty{
GitHubLocation: &GitHubLocationProperty{
CommitId: jsii.String("commitId"),
Repository: jsii.String("repository"),
},
RevisionType: jsii.String("revisionType"),
S3Location: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
// the properties below are optional
BundleType: jsii.String("bundleType"),
ETag: jsii.String("eTag"),
Version: jsii.String("version"),
},
},
// the properties below are optional
Description: jsii.String("description"),
IgnoreApplicationStopFailures: jsii.Boolean(false),
},
DeploymentConfigName: jsii.String("deploymentConfigName"),
DeploymentGroupName: jsii.String("deploymentGroupName"),
DeploymentStyle: &DeploymentStyleProperty{
DeploymentOption: jsii.String("deploymentOption"),
DeploymentType: jsii.String("deploymentType"),
},
Ec2TagFilters: []interface{}{
&EC2TagFilterProperty{
Key: jsii.String("key"),
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
Ec2TagSet: &EC2TagSetProperty{
Ec2TagSetList: []interface{}{
&EC2TagSetListObjectProperty{
Ec2TagGroup: []interface{}{
&EC2TagFilterProperty{
Key: jsii.String("key"),
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
},
},
},
EcsServices: []interface{}{
&ECSServiceProperty{
ClusterName: jsii.String("clusterName"),
ServiceName: jsii.String("serviceName"),
},
},
LoadBalancerInfo: &LoadBalancerInfoProperty{
ElbInfoList: []interface{}{
&ELBInfoProperty{
Name: jsii.String("name"),
},
},
TargetGroupInfoList: []interface{}{
&TargetGroupInfoProperty{
Name: jsii.String("name"),
},
},
TargetGroupPairInfoList: []interface{}{
&TargetGroupPairInfoProperty{
ProdTrafficRoute: &TrafficRouteProperty{
ListenerArns: []*string{
jsii.String("listenerArns"),
},
},
TargetGroups: []interface{}{
&TargetGroupInfoProperty{
Name: jsii.String("name"),
},
},
TestTrafficRoute: &TrafficRouteProperty{
ListenerArns: []*string{
jsii.String("listenerArns"),
},
},
},
},
},
OnPremisesInstanceTagFilters: []interface{}{
&TagFilterProperty{
Key: jsii.String("key"),
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
OnPremisesTagSet: &OnPremisesTagSetProperty{
OnPremisesTagSetList: []interface{}{
&OnPremisesTagSetListObjectProperty{
OnPremisesTagGroup: []interface{}{
&TagFilterProperty{
Key: jsii.String("key"),
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
},
},
},
OutdatedInstancesStrategy: jsii.String("outdatedInstancesStrategy"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TerminationHookEnabled: jsii.Boolean(false),
TriggerConfigurations: []interface{}{
&TriggerConfigProperty{
TriggerEvents: []*string{
jsii.String("triggerEvents"),
},
TriggerName: jsii.String("triggerName"),
TriggerTargetArn: jsii.String("triggerTargetArn"),
},
},
})
Initializer
ts
new CfnDeploymentGroup(scope: Construct, id: string, props: CfnDeploymentGroupProps)
python
CfnDeploymentGroup(scope: Construct, id: str, props: CfnDeploymentGroupProps)
java
new CfnDeploymentGroup(Construct scope, String id, CfnDeploymentGroupProps props)
csharp
new CfnDeploymentGroup(Construct scope, string id, CfnDeploymentGroupProps props)
go
NewCfnDeploymentGroup(Scope Construct, Id *string, Props CfnDeploymentGroupProps)
Construct Props
alarmConfigurationoptionalIResolvable | CfnDeploymentGroup.AlarmConfigurationPropertyalarm_configurationoptionaltyping.Union[IResolvable, AlarmConfigurationProperty]alarmConfigurationoptionalIResolvableAlarmConfigurationoptionalIResolvableAlarmConfigurationoptionalinterface{}#Information about the Amazon CloudWatch alarms that are associated with the deployment group.
applicationNamestringapplication_namestrapplicationNameStringApplicationNamestringApplicationName*stringrequired#The name of an existing CodeDeploy application to associate this deployment group with.
autoRollbackConfigurationoptionalIResolvable | CfnDeploymentGroup.AutoRollbackConfigurationPropertyauto_rollback_configurationoptionaltyping.Union[IResolvable, AutoRollbackConfigurationProperty]autoRollbackConfigurationoptionalIResolvableAutoRollbackConfigurationoptionalIResolvableAutoRollbackConfigurationoptionalinterface{}#Information about the automatic rollback configuration that is associated with the deployment group.
If you specify this property, don't specify the Deployment property.
autoScalingGroupsoptionalstring[]auto_scaling_groupsoptionaltyping.List[str]autoScalingGroupsoptionalList<String>AutoScalingGroupsoptionalstring[]AutoScalingGroupsoptional*[]*string#A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
Duplicates are not allowed.
blueGreenDeploymentConfigurationoptionalIResolvable | CfnDeploymentGroup.BlueGreenDeploymentConfigurationPropertyblue_green_deployment_configurationoptionaltyping.Union[IResolvable, BlueGreenDeploymentConfigurationProperty]blueGreenDeploymentConfigurationoptionalIResolvableBlueGreenDeploymentConfigurationoptionalIResolvableBlueGreenDeploymentConfigurationoptionalinterface{}#Information about blue/green deployment options for a deployment group.
deploymentoptionalIResolvable | CfnDeploymentGroup.DeploymentPropertydeploymentoptionaltyping.Union[IResolvable, DeploymentProperty]deploymentoptionalIResolvableDeploymentoptionalIResolvableDeploymentoptionalinterface{}#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 AutoRollbackConfiguration property.
deploymentConfigNameoptionalstringdeployment_config_nameoptionalstrdeploymentConfigNameoptionalStringDeploymentConfigNameoptionalstringDeploymentConfigNameoptional*string#A deployment configuration name or a predefined configuration name.
notes
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 .
deploymentGroupNameoptionalstringdeployment_group_nameoptionalstrdeploymentGroupNameoptionalStringDeploymentGroupNameoptionalstringDeploymentGroupNameoptional*string#A name for the deployment group.
notes
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.
deploymentStyleoptionalIResolvable | CfnDeploymentGroup.DeploymentStylePropertydeployment_styleoptionaltyping.Union[IResolvable, DeploymentStyleProperty]deploymentStyleoptionalIResolvableDeploymentStyleoptionalIResolvableDeploymentStyleoptionalinterface{}#Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
notes
If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.
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.
ec2TagFiltersoptionalIResolvable | IResolvable | CfnDeploymentGroup.EC2TagFilterProperty[]ec2_tag_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EC2TagFilterProperty]]]ec2TagFiltersoptionalIResolvableEc2TagFiltersoptionalIResolvableEc2TagFiltersoptionalinterface{}#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 EC2TagFilters or Ec2TagSet , but not both.
ec2TagSetoptionalIResolvable | CfnDeploymentGroup.EC2TagSetPropertyec2_tag_setoptionaltyping.Union[IResolvable, EC2TagSetProperty]ec2TagSetoptionalIResolvableEc2TagSetoptionalIResolvableEc2TagSetoptionalinterface{}#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 .
ecsServicesoptionalIResolvable | IResolvable | CfnDeploymentGroup.ECSServiceProperty[]ecs_servicesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ECSServiceProperty]]]ecsServicesoptionalIResolvableEcsServicesoptionalIResolvableEcsServicesoptionalinterface{}#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> .
loadBalancerInfooptionalIResolvable | CfnDeploymentGroup.LoadBalancerInfoPropertyload_balancer_infooptionaltyping.Union[IResolvable, LoadBalancerInfoProperty]loadBalancerInfooptionalIResolvableLoadBalancerInfooptionalIResolvableLoadBalancerInfooptionalinterface{}#Information about the load balancer to use in a deployment.
For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .
onPremisesInstanceTagFiltersoptionalIResolvable | IResolvable | CfnDeploymentGroup.TagFilterProperty[]on_premises_instance_tag_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagFilterProperty]]]onPremisesInstanceTagFiltersoptionalIResolvableOnPremisesInstanceTagFiltersoptionalIResolvableOnPremisesInstanceTagFiltersoptionalinterface{}#The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
notes
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 OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
onPremisesTagSetoptionalIResolvable | CfnDeploymentGroup.OnPremisesTagSetPropertyon_premises_tag_setoptionaltyping.Union[IResolvable, OnPremisesTagSetProperty]onPremisesTagSetoptionalIResolvableOnPremisesTagSetoptionalIResolvableOnPremisesTagSetoptionalinterface{}#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 OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
outdatedInstancesStrategyoptionalstringoutdated_instances_strategyoptionalstroutdatedInstancesStrategyoptionalStringOutdatedInstancesStrategyoptionalstringOutdatedInstancesStrategyoptional*string#Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
notes
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.
serviceRoleArnstringservice_role_arnstrserviceRoleArnStringServiceRoleArnstringServiceRoleArn*stringrequired#A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
notes
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 .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#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.
terminationHookEnabledoptionalboolean | IResolvabletermination_hook_enabledoptionaltyping.Union[bool, IResolvable]terminationHookEnabledoptionalBooleanTerminationHookEnabledoptionalboolTerminationHookEnabledoptionalinterface{}#Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.
notes
For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the AWS CodeDeploy User Guide .
triggerConfigurationsoptionalIResolvable | IResolvable | CfnDeploymentGroup.TriggerConfigProperty[]trigger_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TriggerConfigProperty]]]triggerConfigurationsoptionalIResolvableTriggerConfigurationsoptionalIResolvableTriggerConfigurationsoptionalinterface{}#Information about triggers associated with the deployment group.
Duplicates are not allowed
Properties
alarmConfigurationmay be undefinedIResolvable | CfnDeploymentGroup.AlarmConfigurationPropertyalarm_configurationmay be undefinedtyping.Union[IResolvable, AlarmConfigurationProperty]alarmConfigurationmay be undefinedIResolvableAlarmConfigurationmay be undefinedIResolvableAlarmConfigurationmay be undefinedinterface{}#Information about the Amazon CloudWatch alarms that are associated with the deployment group.
applicationNamestringapplication_namestrapplicationNameStringApplicationNamestringApplicationName*stringrequired#The name of an existing CodeDeploy application to associate this deployment group with.
autoRollbackConfigurationmay be undefinedIResolvable | CfnDeploymentGroup.AutoRollbackConfigurationPropertyauto_rollback_configurationmay be undefinedtyping.Union[IResolvable, AutoRollbackConfigurationProperty]autoRollbackConfigurationmay be undefinedIResolvableAutoRollbackConfigurationmay be undefinedIResolvableAutoRollbackConfigurationmay be undefinedinterface{}#Information about the automatic rollback configuration that is associated with the deployment group.
autoScalingGroupsmay be undefinedstring[]auto_scaling_groupsmay be undefinedtyping.List[str]autoScalingGroupsmay be undefinedList<String>AutoScalingGroupsmay be undefinedstring[]AutoScalingGroupsmay be undefined*[]*string#A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
blueGreenDeploymentConfigurationmay be undefinedIResolvable | CfnDeploymentGroup.BlueGreenDeploymentConfigurationPropertyblue_green_deployment_configurationmay be undefinedtyping.Union[IResolvable, BlueGreenDeploymentConfigurationProperty]blueGreenDeploymentConfigurationmay be undefinedIResolvableBlueGreenDeploymentConfigurationmay be undefinedIResolvableBlueGreenDeploymentConfigurationmay be undefinedinterface{}#Information about blue/green deployment options for a deployment group.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#deploymentmay be undefinedIResolvable | CfnDeploymentGroup.DeploymentPropertydeploymentmay be undefinedtyping.Union[IResolvable, DeploymentProperty]deploymentmay be undefinedIResolvableDeploymentmay be undefinedIResolvableDeploymentmay be undefinedinterface{}#The application revision to deploy to this deployment group.
deploymentConfigNamemay be undefinedstringdeployment_config_namemay be undefinedstrdeploymentConfigNamemay be undefinedStringDeploymentConfigNamemay be undefinedstringDeploymentConfigNamemay be undefined*string#A deployment configuration name or a predefined configuration name.
deploymentGroupNamemay be undefinedstringdeployment_group_namemay be undefinedstrdeploymentGroupNamemay be undefinedStringDeploymentGroupNamemay be undefinedstringDeploymentGroupNamemay be undefined*string#A name for the deployment group.
deploymentGroupRefDeploymentGroupReferencedeployment_group_refDeploymentGroupReferencedeploymentGroupRefDeploymentGroupReferenceDeploymentGroupRefDeploymentGroupReferenceDeploymentGroupRefDeploymentGroupReferencerequired#A reference to a DeploymentGroup resource.
deploymentStylemay be undefinedIResolvable | CfnDeploymentGroup.DeploymentStylePropertydeployment_stylemay be undefinedtyping.Union[IResolvable, DeploymentStyleProperty]deploymentStylemay be undefinedIResolvableDeploymentStylemay be undefinedIResolvableDeploymentStylemay be undefinedinterface{}#Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
ec2TagFiltersmay be undefinedIResolvable | IResolvable | CfnDeploymentGroup.EC2TagFilterProperty[]ec2_tag_filtersmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EC2TagFilterProperty]]]ec2TagFiltersmay be undefinedIResolvableEc2TagFiltersmay be undefinedIResolvableEc2TagFiltersmay be undefinedinterface{}#The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
ec2TagSetmay be undefinedIResolvable | CfnDeploymentGroup.EC2TagSetPropertyec2_tag_setmay be undefinedtyping.Union[IResolvable, EC2TagSetProperty]ec2TagSetmay be undefinedIResolvableEc2TagSetmay be undefinedIResolvableEc2TagSetmay be undefinedinterface{}#Information about groups of tags applied to Amazon EC2 instances.
ecsServicesmay be undefinedIResolvable | IResolvable | CfnDeploymentGroup.ECSServiceProperty[]ecs_servicesmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ECSServiceProperty]]]ecsServicesmay be undefinedIResolvableEcsServicesmay be undefinedIResolvableEcsServicesmay be undefinedinterface{}#The target Amazon ECS services in the deployment group.
loadBalancerInfomay be undefinedIResolvable | CfnDeploymentGroup.LoadBalancerInfoPropertyload_balancer_infomay be undefinedtyping.Union[IResolvable, LoadBalancerInfoProperty]loadBalancerInfomay be undefinedIResolvableLoadBalancerInfomay be undefinedIResolvableLoadBalancerInfomay be undefinedinterface{}#Information about the load balancer to use in a deployment.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
onPremisesInstanceTagFiltersmay be undefinedIResolvable | IResolvable | CfnDeploymentGroup.TagFilterProperty[]on_premises_instance_tag_filtersmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagFilterProperty]]]onPremisesInstanceTagFiltersmay be undefinedIResolvableOnPremisesInstanceTagFiltersmay be undefinedIResolvableOnPremisesInstanceTagFiltersmay be undefinedinterface{}#The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
onPremisesTagSetmay be undefinedIResolvable | CfnDeploymentGroup.OnPremisesTagSetPropertyon_premises_tag_setmay be undefinedtyping.Union[IResolvable, OnPremisesTagSetProperty]onPremisesTagSetmay be undefinedIResolvableOnPremisesTagSetmay be undefinedIResolvableOnPremisesTagSetmay be undefinedinterface{}#Information about groups of tags applied to on-premises instances.
outdatedInstancesStrategymay be undefinedstringoutdated_instances_strategymay be undefinedstroutdatedInstancesStrategymay be undefinedStringOutdatedInstancesStrategymay be undefinedstringOutdatedInstancesStrategymay be undefined*string#Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
serviceRoleArnstringservice_role_arnstrserviceRoleArnStringServiceRoleArnstringServiceRoleArn*stringrequired#A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
terminationHookEnabledmay be undefinedboolean | IResolvabletermination_hook_enabledmay be undefinedtyping.Union[bool, IResolvable]terminationHookEnabledmay be undefinedBooleanTerminationHookEnabledmay be undefinedboolTerminationHookEnabledmay be undefinedinterface{}#Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.
triggerConfigurationsmay be undefinedIResolvable | IResolvable | CfnDeploymentGroup.TriggerConfigProperty[]trigger_configurationsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TriggerConfigProperty]]]triggerConfigurationsmay be undefinedIResolvableTriggerConfigurationsmay be undefinedIResolvableTriggerConfigurationsmay be undefinedinterface{}#Information about triggers associated with the deployment group.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnDeploymentGroup(x: any): boolean@staticmethod def is_cfn_deployment_group(x: Any) -> boolpublic static Boolean isCfnDeploymentGroup(Object x)public static bool IsCfnDeploymentGroup(object x)func IsCfnDeploymentGroup(X interface{}) *boolstatic#Checks whether the given object is a CfnDeploymentGroup.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.