Module: AWSCDK::AppConfig::IDeploymentStrategy

Includes:
IResource, Interfaces::AWSAppconfig::IDeploymentStrategyRef
Included in:
DeploymentStrategy
Defined in:
app_config/i_deployment_strategy.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'app_config/i_deployment_strategy.rb', line 131

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_strategy_ref => { kind: :property, name: "deploymentStrategyRef", is_optional: false },
    :deployment_strategy_arn => { kind: :property, name: "deploymentStrategyArn", is_optional: false },
    :deployment_strategy_id => { kind: :property, name: "deploymentStrategyId", is_optional: false },
    :deployment_duration_in_minutes => { kind: :property, name: "deploymentDurationInMinutes", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :final_bake_time_in_minutes => { kind: :property, name: "finalBakeTimeInMinutes", is_optional: true },
    :growth_factor => { kind: :property, name: "growthFactor", is_optional: true },
    :growth_type => { kind: :property, name: "growthType", is_optional: true },
    :name => { kind: :property, name: "name", 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

#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:



126
127
128
129
 
# File 'app_config/i_deployment_strategy.rb', line 126

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

#deployment_duration_in_minutes ⇒ Numeric?

The deployment duration in minutes.

Returns:

  • (Numeric, nil) 


61
62
63
 
# File 'app_config/i_deployment_strategy.rb', line 61

def deployment_duration_in_minutes()
  jsii_get_property("deploymentDurationInMinutes")
end

#deployment_strategy_arn ⇒ String

The Amazon Resource Name (ARN) of the deployment strategy.

Returns:

  • (String) 


47
48
49
 
# File 'app_config/i_deployment_strategy.rb', line 47

def deployment_strategy_arn()
  jsii_get_property("deploymentStrategyArn")
end

#deployment_strategy_id ⇒ String

The ID of the deployment strategy.

Returns:

  • (String) 


54
55
56
 
# File 'app_config/i_deployment_strategy.rb', line 54

def deployment_strategy_id()
  jsii_get_property("deploymentStrategyId")
end

#deployment_strategy_ref ⇒ AWSCDK::Interfaces::AWSAppconfig::DeploymentStrategyReference

A reference to a DeploymentStrategy resource.

Returns:



40
41
42
 
# File 'app_config/i_deployment_strategy.rb', line 40

def deployment_strategy_ref()
  jsii_get_property("deploymentStrategyRef")
end

#description ⇒ String?

The description of the deployment strategy.

Returns:

  • (String, nil) 


68
69
70
 
# File 'app_config/i_deployment_strategy.rb', line 68

def description()
  jsii_get_property("description")
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 'app_config/i_deployment_strategy.rb', line 26

def env()
  jsii_get_property("env")
end

#final_bake_time_in_minutes ⇒ Numeric?

The final bake time in minutes.

Returns:

  • (Numeric, nil) 


75
76
77
 
# File 'app_config/i_deployment_strategy.rb', line 75

def final_bake_time_in_minutes()
  jsii_get_property("finalBakeTimeInMinutes")
end

#growth_factor ⇒ Numeric?

The growth factor of the deployment strategy.

Returns:

  • (Numeric, nil) 


82
83
84
 
# File 'app_config/i_deployment_strategy.rb', line 82

def growth_factor()
  jsii_get_property("growthFactor")
end

#growth_type ⇒ AWSCDK::AppConfig::GrowthType?

The growth type of the deployment strategy.

Returns:



89
90
91
 
# File 'app_config/i_deployment_strategy.rb', line 89

def growth_type()
  jsii_get_property("growthType")
end

#name ⇒ String?

The name of the deployment strategy.

Returns:

  • (String, nil) 


96
97
98
 
# File 'app_config/i_deployment_strategy.rb', line 96

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'app_config/i_deployment_strategy.rb', line 11

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'app_config/i_deployment_strategy.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



107
108
109
110
111
112
 
# File 'app_config/i_deployment_strategy.rb', line 107

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