Class: AWSCDK::AppConfig::DeploymentStrategy

Inherits:
Resource
  • Object
show all
Includes:
IDeploymentStrategy
Defined in:
app_config/deployment_strategy.rb

Overview

An AWS AppConfig deployment strategy.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ DeploymentStrategy

Returns a new instance of DeploymentStrategy.

Parameters:



14
15
16
17
18
19
20
 
# File 'app_config/deployment_strategy.rb', line 14

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppConfig::DeploymentStrategyProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkRlcGxveW1lbnRTdHJhdGVneVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_deployment_strategy_arn(scope, id, deployment_strategy_arn) ⇒ AWSCDK::AppConfig::IDeploymentStrategy

Imports a deployment strategy into the CDK using its Amazon Resource Name (ARN).

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The name of the deployment strategy construct.

  • deployment_strategy_arn (String) —

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

Returns:



53
54
55
56
57
58
 
# File 'app_config/deployment_strategy.rb', line 53

def self.from_deployment_strategy_arn(scope, id, deployment_strategy_arn)
  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(deployment_strategy_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentStrategyArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.DeploymentStrategy", "fromDeploymentStrategyArn", [scope, id, deployment_strategy_arn])
end

.from_deployment_strategy_id(scope, id, deployment_strategy_id) ⇒ AWSCDK::AppConfig::IDeploymentStrategy

Imports a deployment strategy into the CDK using its ID.

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The name of the deployment strategy construct.

  • deployment_strategy_id (AWSCDK::AppConfig::DeploymentStrategyId) —

    The ID of the deployment strategy.

Returns:



66
67
68
69
70
71
 
# File 'app_config/deployment_strategy.rb', line 66

def self.from_deployment_strategy_id(scope, id, deployment_strategy_id)
  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(deployment_strategy_id, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkRlcGxveW1lbnRTdHJhdGVneUlkIn0=")), "deploymentStrategyId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.DeploymentStrategy", "fromDeploymentStrategyId", [scope, id, deployment_strategy_id])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'app_config/deployment_strategy.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :deployment_strategy_arn => { kind: :property, name: "deploymentStrategyArn", is_optional: false },
    :deployment_strategy_id => { kind: :property, name: "deploymentStrategyId", is_optional: false },
    :deployment_strategy_ref => { kind: :property, name: "deploymentStrategyRef", 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 },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


119
120
121
 
# File 'app_config/deployment_strategy.rb', line 119

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appconfig.DeploymentStrategy", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



219
220
221
222
 
# File 'app_config/deployment_strategy.rb', line 219

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) ⇒ 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:



236
237
238
239
 
# File 'app_config/deployment_strategy.rb', line 236

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 of the deployment strategy.

Returns:

  • (Numeric, nil) 


147
148
149
 
# File 'app_config/deployment_strategy.rb', line 147

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) 


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

def deployment_strategy_arn()
  jsii_get_property("deploymentStrategyArn")
end

#deployment_strategy_id ⇒ String

The ID of the deployment strategy.

Returns:

  • (String) 


133
134
135
 
# File 'app_config/deployment_strategy.rb', line 133

def deployment_strategy_id()
  jsii_get_property("deploymentStrategyId")
end

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

A reference to a DeploymentStrategy resource.

Returns:



140
141
142
 
# File 'app_config/deployment_strategy.rb', line 140

def deployment_strategy_ref()
  jsii_get_property("deploymentStrategyRef")
end

#description ⇒ String?

The description of the deployment strategy.

Returns:

  • (String, nil) 


154
155
156
 
# File 'app_config/deployment_strategy.rb', line 154

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:



91
92
93
 
# File 'app_config/deployment_strategy.rb', line 91

def env()
  jsii_get_property("env")
end

#final_bake_time_in_minutes ⇒ Numeric?

The final bake time in minutes of the deployment strategy.

Returns:

  • (Numeric, nil) 


161
162
163
 
# File 'app_config/deployment_strategy.rb', line 161

def final_bake_time_in_minutes()
  jsii_get_property("finalBakeTimeInMinutes")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


242
243
244
 
# File 'app_config/deployment_strategy.rb', line 242

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


256
257
258
259
260
261
 
# File 'app_config/deployment_strategy.rb', line 256

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


271
272
273
274
 
# File 'app_config/deployment_strategy.rb', line 271

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#growth_factor ⇒ Numeric?

The growth factor of the deployment strategy.

Returns:

  • (Numeric, nil) 


168
169
170
 
# File 'app_config/deployment_strategy.rb', line 168

def growth_factor()
  jsii_get_property("growthFactor")
end

#growth_type ⇒ AWSCDK::AppConfig::GrowthType?

The growth type of the deployment strategy.

Returns:



175
176
177
 
# File 'app_config/deployment_strategy.rb', line 175

def growth_type()
  jsii_get_property("growthType")
end

#name ⇒ String?

The name of the deployment strategy.

Returns:

  • (String, nil) 


182
183
184
 
# File 'app_config/deployment_strategy.rb', line 182

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


76
77
78
 
# File 'app_config/deployment_strategy.rb', line 76

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


105
106
107
 
# File 'app_config/deployment_strategy.rb', line 105

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



112
113
114
 
# File 'app_config/deployment_strategy.rb', line 112

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


189
190
191
 
# File 'app_config/deployment_strategy.rb', line 189

def to_string()
  jsii_call_method("toString", [])
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) 


202
203
204
205
206
207
 
# File 'app_config/deployment_strategy.rb', line 202

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