Module: AWSCDK::AppConfig::IExtension

Includes:
IResource, Interfaces::AWSAppconfig::IExtensionRef
Included in:
Extension
Defined in:
app_config/i_extension.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_extension.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 },
    :extension_ref => { kind: :property, name: "extensionRef", is_optional: false },
    :extension_arn => { kind: :property, name: "extensionArn", is_optional: false },
    :extension_id => { kind: :property, name: "extensionId", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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

The actions for the extension.

Returns:



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

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



126
127
128
129
 
# File 'app_config/i_extension.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

#description ⇒ String?

The description of the extension.

Returns:

  • (String, nil) 


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

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_extension.rb', line 26

def env()
  jsii_get_property("env")
end

#extension_arn ⇒ String

The Amazon Resource Name (ARN) of the extension.

Returns:

  • (String) 


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

def extension_arn()
  jsii_get_property("extensionArn")
end

#extension_id ⇒ String

The ID of the extension.

Returns:

  • (String) 


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

def extension_id()
  jsii_get_property("extensionId")
end

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

A reference to a Extension resource.

Returns:



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

def extension_ref()
  jsii_get_property("extensionRef")
end

#extension_version_number ⇒ Numeric

The version number of the extension.

Returns:

  • (Numeric) 


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

def extension_version_number()
  jsii_get_property("extensionVersionNumber")
end

#latest_version_number ⇒ Numeric?

The latest version number of the extension.

Returns:

  • (Numeric, nil) 


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

def latest_version_number()
  jsii_get_property("latestVersionNumber")
end

#name ⇒ String?

The name of the extension.

Returns:

  • (String, nil) 


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

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

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

The parameters of the extension.

Returns:



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

def parameters()
  jsii_get_property("parameters")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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