Class: AWSCDK::CodeDeploy::CfnDeploymentGroup

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCodedeploy::IDeploymentGroupRef
Defined in:
code_deploy/cfn_deployment_group.rb

Overview

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::DeploymentGroup resource. To perform Amazon ECS blue/green deployments, use the AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation for more information.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDeploymentGroup

Create a new AWS::CodeDeploy::DeploymentGroup.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CodeDeploy::CfnDeploymentGroupProps)

    Resource properties.



22
23
24
25
26
27
28
# File 'code_deploy/cfn_deployment_group.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroupProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5DZm5EZXBsb3ltZW50R3JvdXBQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


194
195
196
# File 'code_deploy/cfn_deployment_group.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_deployment_group(x) ⇒ Boolean

Checks whether the given object is a CfnDeploymentGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


96
97
98
99
# File 'code_deploy/cfn_deployment_group.rb', line 96

def self.is_cfn_deployment_group(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup", "isCfnDeploymentGroup", [x])
end

.jsii_overridable_methodsObject



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'code_deploy/cfn_deployment_group.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :deployment_group_ref => { kind: :property, name: "deploymentGroupRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :application_name => { kind: :property, name: "applicationName", is_optional: false },
    :service_role_arn => { kind: :property, name: "serviceRoleArn", is_optional: false },
    :alarm_configuration => { kind: :property, name: "alarmConfiguration", is_optional: true },
    :auto_rollback_configuration => { kind: :property, name: "autoRollbackConfiguration", is_optional: true },
    :auto_scaling_groups => { kind: :property, name: "autoScalingGroups", is_optional: true },
    :blue_green_deployment_configuration => { kind: :property, name: "blueGreenDeploymentConfiguration", is_optional: true },
    :deployment => { kind: :property, name: "deployment", is_optional: true },
    :deployment_config_name => { kind: :property, name: "deploymentConfigName", is_optional: true },
    :deployment_group_name => { kind: :property, name: "deploymentGroupName", is_optional: true },
    :deployment_style => { kind: :property, name: "deploymentStyle", is_optional: true },
    :ec2_tag_filters => { kind: :property, name: "ec2TagFilters", is_optional: true },
    :ec2_tag_set => { kind: :property, name: "ec2TagSet", is_optional: true },
    :ecs_services => { kind: :property, name: "ecsServices", is_optional: true },
    :load_balancer_info => { kind: :property, name: "loadBalancerInfo", is_optional: true },
    :on_premises_instance_tag_filters => { kind: :property, name: "onPremisesInstanceTagFilters", is_optional: true },
    :on_premises_tag_set => { kind: :property, name: "onPremisesTagSet", is_optional: true },
    :outdated_instances_strategy => { kind: :property, name: "outdatedInstancesStrategy", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :termination_hook_enabled => { kind: :property, name: "terminationHookEnabled", is_optional: true },
    :trigger_configurations => { kind: :property, name: "triggerConfigurations", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



497
498
499
500
# File 'code_deploy/cfn_deployment_group.rb', line 497

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



509
510
511
512
# File 'code_deploy/cfn_deployment_group.rb', line 509

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



519
520
521
522
# File 'code_deploy/cfn_deployment_group.rb', line 519

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



530
531
532
533
534
# File 'code_deploy/cfn_deployment_group.rb', line 530

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


587
588
589
590
591
# File 'code_deploy/cfn_deployment_group.rb', line 587

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



597
598
599
600
# File 'code_deploy/cfn_deployment_group.rb', line 597

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



609
610
611
612
613
# File 'code_deploy/cfn_deployment_group.rb', line 609

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#alarm_configurationAWSCDK::IResolvable, ...

Information about the Amazon CloudWatch alarms that are associated with the deployment group.



239
240
241
# File 'code_deploy/cfn_deployment_group.rb', line 239

def alarm_configuration()
  jsii_get_property("alarmConfiguration")
end

#alarm_configuration=(value) ⇒ Object



243
244
245
246
247
# File 'code_deploy/cfn_deployment_group.rb', line 243

def alarm_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::AlarmConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5BbGFybUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "alarmConfiguration") unless value.nil?
  jsii_set_property("alarmConfiguration", value)
end

#application_nameString

The name of an existing CodeDeploy application to associate this deployment group with.

Returns:

  • (String)


215
216
217
# File 'code_deploy/cfn_deployment_group.rb', line 215

def application_name()
  jsii_get_property("applicationName")
end

#application_name=(value) ⇒ Object



219
220
221
222
# File 'code_deploy/cfn_deployment_group.rb', line 219

def application_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName")
  jsii_set_property("applicationName", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

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.

Parameters:



622
623
624
625
# File 'code_deploy/cfn_deployment_group.rb', line 622

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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:



644
645
646
647
648
649
# File 'code_deploy/cfn_deployment_group.rb', line 644

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#auto_rollback_configurationAWSCDK::IResolvable, ...

Information about the automatic rollback configuration that is associated with the deployment group.



252
253
254
# File 'code_deploy/cfn_deployment_group.rb', line 252

def auto_rollback_configuration()
  jsii_get_property("autoRollbackConfiguration")
end

#auto_rollback_configuration=(value) ⇒ Object



256
257
258
259
260
# File 'code_deploy/cfn_deployment_group.rb', line 256

def auto_rollback_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::AutoRollbackConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5BdXRvUm9sbGJhY2tDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "autoRollbackConfiguration") unless value.nil?
  jsii_set_property("autoRollbackConfiguration", value)
end

#auto_scaling_groupsArray<String>?

A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.

Returns:

  • (Array<String>, nil)


265
266
267
# File 'code_deploy/cfn_deployment_group.rb', line 265

def auto_scaling_groups()
  jsii_get_property("autoScalingGroups")
end

#auto_scaling_groups=(value) ⇒ Object



269
270
271
272
# File 'code_deploy/cfn_deployment_group.rb', line 269

def auto_scaling_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "autoScalingGroups") unless value.nil?
  jsii_set_property("autoScalingGroups", value)
end

#blue_green_deployment_configurationAWSCDK::IResolvable, ...

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



277
278
279
# File 'code_deploy/cfn_deployment_group.rb', line 277

def blue_green_deployment_configuration()
  jsii_get_property("blueGreenDeploymentConfiguration")
end

#blue_green_deployment_configuration=(value) ⇒ Object



281
282
283
284
285
# File 'code_deploy/cfn_deployment_group.rb', line 281

def blue_green_deployment_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::BlueGreenDeploymentConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5CbHVlR3JlZW5EZXBsb3ltZW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "blueGreenDeploymentConfiguration") unless value.nil?
  jsii_set_property("blueGreenDeploymentConfiguration", value)
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



147
148
149
# File 'code_deploy/cfn_deployment_group.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


152
153
154
# File 'code_deploy/cfn_deployment_group.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


653
654
655
656
# File 'code_deploy/cfn_deployment_group.rb', line 653

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


157
158
159
# File 'code_deploy/cfn_deployment_group.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


164
165
166
# File 'code_deploy/cfn_deployment_group.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


109
110
111
# File 'code_deploy/cfn_deployment_group.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#deploymentAWSCDK::IResolvable, ...

The application revision to deploy to this deployment group.



290
291
292
# File 'code_deploy/cfn_deployment_group.rb', line 290

def deployment()
  jsii_get_property("deployment")
end

#deployment=(value) ⇒ Object



294
295
296
297
298
# File 'code_deploy/cfn_deployment_group.rb', line 294

def deployment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::DeploymentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5EZXBsb3ltZW50UHJvcGVydHkifV19fQ==")), "deployment") unless value.nil?
  jsii_set_property("deployment", value)
end

#deployment_config_nameString?

A deployment configuration name or a predefined configuration name.

Returns:

  • (String, nil)


303
304
305
# File 'code_deploy/cfn_deployment_group.rb', line 303

def deployment_config_name()
  jsii_get_property("deploymentConfigName")
end

#deployment_config_name=(value) ⇒ Object



307
308
309
310
# File 'code_deploy/cfn_deployment_group.rb', line 307

def deployment_config_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentConfigName") unless value.nil?
  jsii_set_property("deploymentConfigName", value)
end

#deployment_group_nameString?

A name for the deployment group.

Returns:

  • (String, nil)


315
316
317
# File 'code_deploy/cfn_deployment_group.rb', line 315

def deployment_group_name()
  jsii_get_property("deploymentGroupName")
end

#deployment_group_name=(value) ⇒ Object



319
320
321
322
# File 'code_deploy/cfn_deployment_group.rb', line 319

def deployment_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentGroupName") unless value.nil?
  jsii_set_property("deploymentGroupName", value)
end

#deployment_group_refAWSCDK::Interfaces::AWSCodedeploy::DeploymentGroupReference

A reference to a DeploymentGroup resource.



201
202
203
# File 'code_deploy/cfn_deployment_group.rb', line 201

def deployment_group_ref()
  jsii_get_property("deploymentGroupRef")
end

#deployment_styleAWSCDK::IResolvable, ...

Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.



327
328
329
# File 'code_deploy/cfn_deployment_group.rb', line 327

def deployment_style()
  jsii_get_property("deploymentStyle")
end

#deployment_style=(value) ⇒ Object



331
332
333
334
335
# File 'code_deploy/cfn_deployment_group.rb', line 331

def deployment_style=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::DeploymentStyleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5EZXBsb3ltZW50U3R5bGVQcm9wZXJ0eSJ9XX19")), "deploymentStyle") unless value.nil?
  jsii_set_property("deploymentStyle", value)
end

#ec2_tag_filtersAWSCDK::IResolvable, ...

The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.



340
341
342
# File 'code_deploy/cfn_deployment_group.rb', line 340

def ec2_tag_filters()
  jsii_get_property("ec2TagFilters")
end

#ec2_tag_filters=(value) ⇒ Object



344
345
346
347
# File 'code_deploy/cfn_deployment_group.rb', line 344

def ec2_tag_filters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5DZm5EZXBsb3ltZW50R3JvdXAuRUMyVGFnRmlsdGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "ec2TagFilters") unless value.nil?
  jsii_set_property("ec2TagFilters", value)
end

#ec2_tag_setAWSCDK::IResolvable, ...

Information about groups of tags applied to Amazon EC2 instances.



352
353
354
# File 'code_deploy/cfn_deployment_group.rb', line 352

def ec2_tag_set()
  jsii_get_property("ec2TagSet")
end

#ec2_tag_set=(value) ⇒ Object



356
357
358
359
360
# File 'code_deploy/cfn_deployment_group.rb', line 356

def ec2_tag_set=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::EC2TagSetProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5FQzJUYWdTZXRQcm9wZXJ0eSJ9XX19")), "ec2TagSet") unless value.nil?
  jsii_set_property("ec2TagSet", value)
end

#ecs_servicesAWSCDK::IResolvable, ...

The target Amazon ECS services in the deployment group.



365
366
367
# File 'code_deploy/cfn_deployment_group.rb', line 365

def ecs_services()
  jsii_get_property("ecsServices")
end

#ecs_services=(value) ⇒ Object



369
370
371
372
# File 'code_deploy/cfn_deployment_group.rb', line 369

def ecs_services=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5DZm5EZXBsb3ltZW50R3JvdXAuRUNTU2VydmljZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "ecsServices") unless value.nil?
  jsii_set_property("ecsServices", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



169
170
171
# File 'code_deploy/cfn_deployment_group.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::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.

Parameters:

Returns:



666
667
668
669
670
# File 'code_deploy/cfn_deployment_group.rb', line 666

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



677
678
679
680
# File 'code_deploy/cfn_deployment_group.rb', line 677

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



747
748
749
750
# File 'code_deploy/cfn_deployment_group.rb', line 747

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#load_balancer_infoAWSCDK::IResolvable, ...

Information about the load balancer to use in a deployment.



377
378
379
# File 'code_deploy/cfn_deployment_group.rb', line 377

def load_balancer_info()
  jsii_get_property("loadBalancerInfo")
end

#load_balancer_info=(value) ⇒ Object



381
382
383
384
385
# File 'code_deploy/cfn_deployment_group.rb', line 381

def load_balancer_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::LoadBalancerInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5Mb2FkQmFsYW5jZXJJbmZvUHJvcGVydHkifV19fQ==")), "loadBalancerInfo") unless value.nil?
  jsii_set_property("loadBalancerInfo", value)
end

#logical_idString

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 override_logical_id(new_logical_id).

Returns:

  • (String)


121
122
123
# File 'code_deploy/cfn_deployment_group.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


104
105
106
# File 'code_deploy/cfn_deployment_group.rb', line 104

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



688
689
690
# File 'code_deploy/cfn_deployment_group.rb', line 688

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



695
696
697
# File 'code_deploy/cfn_deployment_group.rb', line 695

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#on_premises_instance_tag_filtersAWSCDK::IResolvable, ...

The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.



390
391
392
# File 'code_deploy/cfn_deployment_group.rb', line 390

def on_premises_instance_tag_filters()
  jsii_get_property("onPremisesInstanceTagFilters")
end

#on_premises_instance_tag_filters=(value) ⇒ Object



394
395
396
397
# File 'code_deploy/cfn_deployment_group.rb', line 394

def on_premises_instance_tag_filters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5DZm5EZXBsb3ltZW50R3JvdXAuVGFnRmlsdGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "onPremisesInstanceTagFilters") unless value.nil?
  jsii_set_property("onPremisesInstanceTagFilters", value)
end

#on_premises_tag_setAWSCDK::IResolvable, ...

Information about groups of tags applied to on-premises instances.



402
403
404
# File 'code_deploy/cfn_deployment_group.rb', line 402

def on_premises_tag_set()
  jsii_get_property("onPremisesTagSet")
end

#on_premises_tag_set=(value) ⇒ Object



406
407
408
409
410
# File 'code_deploy/cfn_deployment_group.rb', line 406

def on_premises_tag_set=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeDeploy::CfnDeploymentGroup::OnPremisesTagSetProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlZGVwbG95LkNmbkRlcGxveW1lbnRHcm91cC5PblByZW1pc2VzVGFnU2V0UHJvcGVydHkifV19fQ==")), "onPremisesTagSet") unless value.nil?
  jsii_set_property("onPremisesTagSet", value)
end

#outdated_instances_strategyString?

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

Returns:

  • (String, nil)


415
416
417
# File 'code_deploy/cfn_deployment_group.rb', line 415

def outdated_instances_strategy()
  jsii_get_property("outdatedInstancesStrategy")
end

#outdated_instances_strategy=(value) ⇒ Object



419
420
421
422
# File 'code_deploy/cfn_deployment_group.rb', line 419

def outdated_instances_strategy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outdatedInstancesStrategy") unless value.nil?
  jsii_set_property("outdatedInstancesStrategy", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



488
489
490
491
# File 'code_deploy/cfn_deployment_group.rb', line 488

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#refString

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 }).

Returns:

  • (String)


140
141
142
# File 'code_deploy/cfn_deployment_group.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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.

Parameters:



706
707
708
709
# File 'code_deploy/cfn_deployment_group.rb', line 706

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


713
714
715
716
# File 'code_deploy/cfn_deployment_group.rb', line 713

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



723
724
725
726
727
# File 'code_deploy/cfn_deployment_group.rb', line 723

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#service_role_arnString

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.

Returns:

  • (String)


227
228
229
# File 'code_deploy/cfn_deployment_group.rb', line 227

def service_role_arn()
  jsii_get_property("serviceRoleArn")
end

#service_role_arn=(value) ⇒ Object



231
232
233
234
# File 'code_deploy/cfn_deployment_group.rb', line 231

def service_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRoleArn")
  jsii_set_property("serviceRoleArn", value)
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



732
733
734
# File 'code_deploy/cfn_deployment_group.rb', line 732

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



130
131
132
# File 'code_deploy/cfn_deployment_group.rb', line 130

def stack()
  jsii_get_property("stack")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



208
209
210
# File 'code_deploy/cfn_deployment_group.rb', line 208

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.

Returns:



427
428
429
# File 'code_deploy/cfn_deployment_group.rb', line 427

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



431
432
433
434
435
# File 'code_deploy/cfn_deployment_group.rb', line 431

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#termination_hook_enabledBoolean, ...

Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

Returns:



440
441
442
# File 'code_deploy/cfn_deployment_group.rb', line 440

def termination_hook_enabled()
  jsii_get_property("terminationHookEnabled")
end

#termination_hook_enabled=(value) ⇒ Object



444
445
446
447
# File 'code_deploy/cfn_deployment_group.rb', line 444

def termination_hook_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "terminationHookEnabled") unless value.nil?
  jsii_set_property("terminationHookEnabled", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



464
465
466
# File 'code_deploy/cfn_deployment_group.rb', line 464

def to_string()
  jsii_call_method("toString", [])
end

#trigger_configurationsAWSCDK::IResolvable, ...

Information about triggers associated with the deployment group.



452
453
454
# File 'code_deploy/cfn_deployment_group.rb', line 452

def trigger_configurations()
  jsii_get_property("triggerConfigurations")
end

#trigger_configurations=(value) ⇒ Object



456
457
458
459
# File 'code_deploy/cfn_deployment_group.rb', line 456

def trigger_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5DZm5EZXBsb3ltZW50R3JvdXAuVHJpZ2dlckNvbmZpZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "triggerConfigurations") unless value.nil?
  jsii_set_property("triggerConfigurations", value)
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


177
178
179
# File 'code_deploy/cfn_deployment_group.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


187
188
189
# File 'code_deploy/cfn_deployment_group.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


738
739
740
741
# File 'code_deploy/cfn_deployment_group.rb', line 738

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


477
478
479
480
481
482
# File 'code_deploy/cfn_deployment_group.rb', line 477

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end