Module: AWSCDK::CodeDeploy::IServerDeploymentGroup

Includes:
IResource, Interfaces::AWSCodedeploy::IDeploymentGroupRef
Included in:
ServerDeploymentGroup
Defined in:
code_deploy/i_server_deployment_group.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'code_deploy/i_server_deployment_group.rb', line 105

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :deployment_group_ref => { kind: :property, name: "deploymentGroupRef", is_optional: false },
    :application => { kind: :property, name: "application", is_optional: false },
    :deployment_config => { kind: :property, name: "deploymentConfig", is_optional: false },
    :deployment_group_arn => { kind: :property, name: "deploymentGroupArn", is_optional: false },
    :deployment_group_name => { kind: :property, name: "deploymentGroupName", is_optional: false },
    :auto_scaling_groups => { kind: :property, name: "autoScalingGroups", is_optional: true },
    :role => { kind: :property, name: "role", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#application ⇒ AWSCDK::CodeDeploy::IServerApplication

Returns:



45
46
47
 
# File 'code_deploy/i_server_deployment_group.rb', line 45

def application()
  jsii_get_property("application")
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



100
101
102
103
 
# File 'code_deploy/i_server_deployment_group.rb', line 100

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#auto_scaling_groups ⇒ Array<AWSCDK::Autoscaling::IAutoScalingGroup>?

Returns:



65
66
67
 
# File 'code_deploy/i_server_deployment_group.rb', line 65

def auto_scaling_groups()
  jsii_get_property("autoScalingGroups")
end

#deployment_config ⇒ AWSCDK::CodeDeploy::IServerDeploymentConfig

Returns:



50
51
52
 
# File 'code_deploy/i_server_deployment_group.rb', line 50

def deployment_config()
  jsii_get_property("deploymentConfig")
end

#deployment_group_arn ⇒ String

Returns:

  • (String) 


55
56
57
 
# File 'code_deploy/i_server_deployment_group.rb', line 55

def deployment_group_arn()
  jsii_get_property("deploymentGroupArn")
end

#deployment_group_name ⇒ String

Returns:

  • (String) 


60
61
62
 
# File 'code_deploy/i_server_deployment_group.rb', line 60

def deployment_group_name()
  jsii_get_property("deploymentGroupName")
end

#deployment_group_ref ⇒ AWSCDK::Interfaces::AWSCodedeploy::DeploymentGroupReference

A reference to a DeploymentGroup resource.

Returns:



40
41
42
 
# File 'code_deploy/i_server_deployment_group.rb', line 40

def deployment_group_ref()
  jsii_get_property("deploymentGroupRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



26
27
28
 
# File 'code_deploy/i_server_deployment_group.rb', line 26

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'code_deploy/i_server_deployment_group.rb', line 11

def node()
  jsii_get_property("node")
end

#role ⇒ AWSCDK::IAM::IRole?

Returns:



70
71
72
 
# File 'code_deploy/i_server_deployment_group.rb', line 70

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'code_deploy/i_server_deployment_group.rb', line 33

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



81
82
83
84
85
86
 
# File 'code_deploy/i_server_deployment_group.rb', line 81

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