Class: AWSCDK::SSM::StringListParameter

Inherits:
Resource
  • Object
show all
Includes:
IAM::IEncryptedResource, IParameter, IStringListParameter
Defined in:
ssm/string_list_parameter.rb

Overview

Creates a new StringList SSM Parameter.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ StringListParameter

Returns a new instance of StringListParameter.

Parameters:



14
15
16
17
18
19
20
 
# File 'ssm/string_list_parameter.rb', line 14

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

Class Method Details

.from_list_parameter_attributes(scope, id, attrs) ⇒ AWSCDK::SSM::IStringListParameter

Imports an external string list parameter with name and optional version.

Parameters:

Returns:



53
54
55
56
57
58
59
 
# File 'ssm/string_list_parameter.rb', line 53

def self.from_list_parameter_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::SSM::ListParameterAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLkxpc3RQYXJhbWV0ZXJBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringListParameter", "fromListParameterAttributes", [scope, id, attrs])
end

.from_string_list_parameter_name(scope, id, string_list_parameter_name) ⇒ AWSCDK::SSM::IStringListParameter

Imports an external parameter of type string list.

Returns a token and should not be parsed.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • string_list_parameter_name (String)

Returns:



69
70
71
72
73
74
 
# File 'ssm/string_list_parameter.rb', line 69

def self.from_string_list_parameter_name(scope, id, string_list_parameter_name)
  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(string_list_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stringListParameterName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringListParameter", "fromStringListParameterName", [scope, id, string_list_parameter_name])
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 'ssm/string_list_parameter.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 },
    :parameter_arn => { kind: :property, name: "parameterArn", is_optional: false },
    :parameter_name => { kind: :property, name: "parameterName", is_optional: false },
    :parameter_ref => { kind: :property, name: "parameterRef", is_optional: false },
    :parameter_type => { kind: :property, name: "parameterType", is_optional: false },
    :string_list_value => { kind: :property, name: "stringListValue", is_optional: false },
    :encryption_key => { kind: :property, name: "encryptionKey", 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 },
    :grant_on_key => { kind: :method, name: "grantOnKey", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


137
138
139
 
# File 'ssm/string_list_parameter.rb', line 137

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

.value_for_typed_list_parameter(scope, parameter_name, type = nil, version = nil) ⇒ Array<String>

Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

Parameters:

  • scope (Constructs::Construct) —

    Some scope within a stack.

  • parameter_name (String) —

    The name of the SSM parameter.

  • type (AWSCDK::SSM::ParameterValueType, nil) (defaults to: nil) —

    the type of the SSM list parameter.

  • version (Numeric, nil) (defaults to: nil) —

    The parameter version (recommended in order to ensure that the value won't change during deployment).

Returns:

  • (Array<String>) 


83
84
85
86
87
88
89
 
# File 'ssm/string_list_parameter.rb', line 83

def self.value_for_typed_list_parameter(scope, parameter_name, type = nil, version = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName")
  Jsii::Type.check_type(type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLlBhcmFtZXRlclZhbHVlVHlwZSJ9")), "type") unless type.nil?
  Jsii::Type.check_type(version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "version") unless version.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringListParameter", "valueForTypedListParameter", [scope, parameter_name, type, version])
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:



220
221
222
223
 
# File 'ssm/string_list_parameter.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 'ssm/string_list_parameter.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

#encryption_key ⇒ AWSCDK::KMS::IKey?

Note:

Default: - default master key

The encryption key that is used to encrypt this parameter.

Returns:



183
184
185
 
# File 'ssm/string_list_parameter.rb', line 183

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



109
110
111
 
# File 'ssm/string_list_parameter.rb', line 109

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


243
244
245
 
# File 'ssm/string_list_parameter.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 'ssm/string_list_parameter.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 'ssm/string_list_parameter.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

#grant_on_key(grantee, *actions) ⇒ AWSCDK::IAM::GrantOnKeyResult

Gives permissions to a grantable entity to perform actions on the encryption key.

Parameters:

Returns:



282
283
284
285
286
287
288
 
# File 'ssm/string_list_parameter.rb', line 282

def grant_on_key(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grantOnKey", [grantee, *actions])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



294
295
296
297
 
# File 'ssm/string_list_parameter.rb', line 294

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_write(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



303
304
305
306
 
# File 'ssm/string_list_parameter.rb', line 303

def grant_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantWrite", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'ssm/string_list_parameter.rb', line 94

def node()
  jsii_get_property("node")
end

#parameter_arn ⇒ String

The ARN of the SSM Parameter resource.

Returns:

  • (String) 


144
145
146
 
# File 'ssm/string_list_parameter.rb', line 144

def parameter_arn()
  jsii_get_property("parameterArn")
end

#parameter_name ⇒ String

The name of the SSM Parameter resource.

Returns:

  • (String) 


151
152
153
 
# File 'ssm/string_list_parameter.rb', line 151

def parameter_name()
  jsii_get_property("parameterName")
end

#parameter_ref ⇒ AWSCDK::Interfaces::AWSSSM::ParameterReference

A reference to a Parameter resource.

Returns:



158
159
160
 
# File 'ssm/string_list_parameter.rb', line 158

def parameter_ref()
  jsii_get_property("parameterRef")
end

#parameter_type ⇒ String

The type of the SSM Parameter resource.

Returns:

  • (String) 


165
166
167
 
# File 'ssm/string_list_parameter.rb', line 165

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


123
124
125
 
# File 'ssm/string_list_parameter.rb', line 123

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



130
131
132
 
# File 'ssm/string_list_parameter.rb', line 130

def stack()
  jsii_get_property("stack")
end

#string_list_value ⇒ Array<String>

The parameter value.

Value must not nest another parameter. Do not use {} in the value. Values in the array cannot contain commas (,).

Returns:

  • (Array<String>) 


175
176
177
 
# File 'ssm/string_list_parameter.rb', line 175

def string_list_value()
  jsii_get_property("stringListValue")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


190
191
192
 
# File 'ssm/string_list_parameter.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 'ssm/string_list_parameter.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