Class: AWSCDK::AppConfig::Extension

Inherits:
Resource
  • Object
show all
Includes:
IExtension
Defined in:
app_config/extension.rb

Overview

An AWS AppConfig extension.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Extension

Returns a new instance of Extension.

Parameters:



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

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

Class Method Details

.from_extension_arn(scope, id, extension_arn) ⇒ AWSCDK::AppConfig::IExtension

Imports an extension into the CDK using its Amazon Resource Name (ARN).

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The name of the extension construct.

  • extension_arn (String) —

    The Amazon Resource Name (ARN) of the extension.

Returns:



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

def self.from_extension_arn(scope, id, extension_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(extension_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "extensionArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Extension", "fromExtensionArn", [scope, id, extension_arn])
end

.from_extension_attributes(scope, id, attrs) ⇒ AWSCDK::AppConfig::IExtension

Imports an extension into the CDK using its attributes.

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The name of the extension construct.

  • attrs (AWSCDK::AppConfig::ExtensionAttributes) —

    The attributes of the extension.

Returns:



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

def self.from_extension_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbkF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Extension", "fromExtensionAttributes", [scope, id, attrs])
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/extension.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 },
    :extension_arn => { kind: :property, name: "extensionArn", is_optional: false },
    :extension_id => { kind: :property, name: "extensionId", is_optional: false },
    :extension_ref => { kind: :property, name: "extensionRef", is_optional: false },
    :extension_version_number => { kind: :property, name: "extensionVersionNumber", is_optional: false },
    :actions => { kind: :property, name: "actions", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :latest_version_number => { kind: :property, name: "latestVersionNumber", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :parameters => { kind: :property, name: "parameters", 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) 


120
121
122
 
# File 'app_config/extension.rb', line 120

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

Instance Method Details

#actions ⇒ Array<AWSCDK::AppConfig::Action>?

The actions for the extension.

Returns:



155
156
157
 
# File 'app_config/extension.rb', line 155

def actions()
  jsii_get_property("actions")
end

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



220
221
222
223
 
# File 'app_config/extension.rb', line 220

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:



237
238
239
240
 
# File 'app_config/extension.rb', line 237

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

#description ⇒ String?

The description of the extension.

Returns:

  • (String, nil) 


162
163
164
 
# File 'app_config/extension.rb', line 162

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:



92
93
94
 
# File 'app_config/extension.rb', line 92

def env()
  jsii_get_property("env")
end

#extension_arn ⇒ String

The Amazon Resource Name (ARN) of the extension.

Returns:

  • (String) 


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

def extension_arn()
  jsii_get_property("extensionArn")
end

#extension_id ⇒ String

The ID of the extension.

Returns:

  • (String) 


134
135
136
 
# File 'app_config/extension.rb', line 134

def extension_id()
  jsii_get_property("extensionId")
end

#extension_ref ⇒ AWSCDK::Interfaces::AWSAppconfig::ExtensionReference

A reference to a Extension resource.

Returns:



141
142
143
 
# File 'app_config/extension.rb', line 141

def extension_ref()
  jsii_get_property("extensionRef")
end

#extension_version_number ⇒ Numeric

The version number of the extension.

Returns:

  • (Numeric) 


148
149
150
 
# File 'app_config/extension.rb', line 148

def extension_version_number()
  jsii_get_property("extensionVersionNumber")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


243
244
245
 
# File 'app_config/extension.rb', line 243

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) 


257
258
259
260
261
262
 
# File 'app_config/extension.rb', line 257

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) 


272
273
274
275
 
# File 'app_config/extension.rb', line 272

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

#latest_version_number ⇒ Numeric?

The latest version number of the extension.

Returns:

  • (Numeric, nil) 


169
170
171
 
# File 'app_config/extension.rb', line 169

def latest_version_number()
  jsii_get_property("latestVersionNumber")
end

#name ⇒ String?

The name of the extension.

Returns:

  • (String, nil) 


176
177
178
 
# File 'app_config/extension.rb', line 176

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


77
78
79
 
# File 'app_config/extension.rb', line 77

def node()
  jsii_get_property("node")
end

#parameters ⇒ Array<AWSCDK::AppConfig::Parameter>?

The parameters of the extension.

Returns:



183
184
185
 
# File 'app_config/extension.rb', line 183

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


106
107
108
 
# File 'app_config/extension.rb', line 106

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



113
114
115
 
# File 'app_config/extension.rb', line 113

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


190
191
192
 
# File 'app_config/extension.rb', line 190

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) 


203
204
205
206
207
208
 
# File 'app_config/extension.rb', line 203

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