Class: AWSCDK::SSM::StringParameter

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

Overview

Creates a new String SSM Parameter.

Examples:

ssm_parameter = AWSCDK::SSM::StringParameter.new(self, "mySsmParameter", {
    parameter_name: "mySsmParameter",
    string_value: "mySsmParameterValue",
})

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ StringParameter

Returns a new instance of StringParameter.

Parameters:



20
21
22
23
24
25
26
 
# File 'ssm/string_parameter.rb', line 20

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

Class Method Details

.from_secure_string_parameter_attributes(scope, id, attrs) ⇒ AWSCDK::SSM::IStringParameter

Imports a secure string parameter from the SSM parameter store.

Parameters:

Returns:



59
60
61
62
63
64
65
 
# File 'ssm/string_parameter.rb', line 59

def self.from_secure_string_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::SecureStringParameterAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLlNlY3VyZVN0cmluZ1BhcmFtZXRlckF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "fromSecureStringParameterAttributes", [scope, id, attrs])
end

.from_string_parameter_arn(scope, id, string_parameter_arn) ⇒ AWSCDK::SSM::IStringParameter

Imports an external string parameter by ARN.

Parameters:

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

Returns:



73
74
75
76
77
78
 
# File 'ssm/string_parameter.rb', line 73

def self.from_string_parameter_arn(scope, id, string_parameter_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(string_parameter_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stringParameterArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "fromStringParameterArn", [scope, id, string_parameter_arn])
end

.from_string_parameter_attributes(scope, id, attrs) ⇒ AWSCDK::SSM::IStringParameter

Imports an external string parameter with name and optional version.

Parameters:

Returns:



86
87
88
89
90
91
92
 
# File 'ssm/string_parameter.rb', line 86

def self.from_string_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::StringParameterAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLlN0cmluZ1BhcmFtZXRlckF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "fromStringParameterAttributes", [scope, id, attrs])
end

.from_string_parameter_name(scope, id, string_parameter_name) ⇒ AWSCDK::SSM::IStringParameter

Imports an external string parameter by name.

Parameters:

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

Returns:



100
101
102
103
104
105
 
# File 'ssm/string_parameter.rb', line 100

def self.from_string_parameter_name(scope, id, string_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_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stringParameterName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "fromStringParameterName", [scope, id, string_parameter_name])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'ssm/string_parameter.rb', line 28

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_value => { kind: :property, name: "stringValue", 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) 


234
235
236
 
# File 'ssm/string_parameter.rb', line 234

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

.value_for_secure_string_parameter(scope, parameter_name, version) ⇒ String

Deprecated.

Use SecretValue.ssmSecure() instead, it will correctly type the imported value as a SecretValue and allow importing without version. SecretValue lives in the core aws-cdk-lib module.

Returns a token that will resolve (during deployment).

Parameters:

  • scope (Constructs::Construct) —

    Some scope within a stack.

  • parameter_name (String) —

    The name of the SSM parameter.

  • version (Numeric) —

    The parameter version (required for secure strings).

Returns:

  • (String) 


114
115
116
117
118
119
 
# File 'ssm/string_parameter.rb', line 114

def self.value_for_secure_string_parameter(scope, parameter_name, version)
  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(version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "version")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "valueForSecureStringParameter", [scope, parameter_name, version])
end

.value_for_string_parameter(scope, parameter_name, version = nil) ⇒ String

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

Parameters:

  • scope (Constructs::Construct) —

    Some scope within a stack.

  • parameter_name (String) —

    The name of the SSM parameter.

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

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

Returns:

  • (String) 


127
128
129
130
131
132
 
# File 'ssm/string_parameter.rb', line 127

def self.value_for_string_parameter(scope, parameter_name, 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(version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "version") unless version.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "valueForStringParameter", [scope, parameter_name, version])
end

.value_for_typed_string_parameter(scope, parameter_name, type = nil, version = nil) ⇒ String

Deprecated.
  • use valueForTypedStringParameterV2 instead

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

Parameters:

  • scope (Constructs::Construct) —

    Some scope within a stack.

  • parameter_name (String) —

    The name of the SSM parameter.

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

    The type of the SSM parameter.

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

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

Returns:

  • (String) 


142
143
144
145
146
147
148
 
# File 'ssm/string_parameter.rb', line 142

def self.value_for_typed_string_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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLlBhcmFtZXRlclR5cGUifQ==")), "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.StringParameter", "valueForTypedStringParameter", [scope, parameter_name, type, version])
end

.value_for_typed_string_parameter_v2(scope, parameter_name, type = nil, version = nil) ⇒ String

Returns a token that will resolve (during deployment) to the string value of an SSM string 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 parameter.

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

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

Returns:

  • (String) 


157
158
159
160
161
162
163
 
# File 'ssm/string_parameter.rb', line 157

def self.value_for_typed_string_parameter_v2(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.StringParameter", "valueForTypedStringParameterV2", [scope, parameter_name, type, version])
end

.value_from_lookup(scope, parameter_name, default_value = nil, options = nil) ⇒ String

Reads the value of an SSM parameter during synthesis through an environmental context provider.

Requires that the stack this scope is defined in will have explicit account/region information. Otherwise, it will fail during synthesis.

If defaultValue is provided, it will be used as the dummyValue and the ContextProvider will be told NOT to raise an error on synthesis if the SSM Parameter is not found in the account at synth time.

Parameters:

Returns:

  • (String) 


179
180
181
182
183
184
185
186
 
# File 'ssm/string_parameter.rb', line 179

def self.value_from_lookup(scope, parameter_name, default_value = nil, options = 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(default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless default_value.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::SSM::StringParameterLookupOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLlN0cmluZ1BhcmFtZXRlckxvb2t1cE9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.StringParameter", "valueFromLookup", [scope, parameter_name, default_value, options])
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:



316
317
318
319
 
# File 'ssm/string_parameter.rb', line 316

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:



333
334
335
336
 
# File 'ssm/string_parameter.rb', line 333

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:



279
280
281
 
# File 'ssm/string_parameter.rb', line 279

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:



206
207
208
 
# File 'ssm/string_parameter.rb', line 206

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


339
340
341
 
# File 'ssm/string_parameter.rb', line 339

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) 


353
354
355
356
357
358
 
# File 'ssm/string_parameter.rb', line 353

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) 


368
369
370
371
 
# File 'ssm/string_parameter.rb', line 368

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:



378
379
380
381
382
383
384
 
# File 'ssm/string_parameter.rb', line 378

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:



390
391
392
393
 
# File 'ssm/string_parameter.rb', line 390

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:



399
400
401
402
 
# File 'ssm/string_parameter.rb', line 399

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) 


191
192
193
 
# File 'ssm/string_parameter.rb', line 191

def node()
  jsii_get_property("node")
end

#parameter_arn ⇒ String

The ARN of the SSM Parameter resource.

Returns:

  • (String) 


241
242
243
 
# File 'ssm/string_parameter.rb', line 241

def parameter_arn()
  jsii_get_property("parameterArn")
end

#parameter_name ⇒ String

The name of the SSM Parameter resource.

Returns:

  • (String) 


248
249
250
 
# File 'ssm/string_parameter.rb', line 248

def parameter_name()
  jsii_get_property("parameterName")
end

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

A reference to a Parameter resource.

Returns:



255
256
257
 
# File 'ssm/string_parameter.rb', line 255

def parameter_ref()
  jsii_get_property("parameterRef")
end

#parameter_type ⇒ String

The type of the SSM Parameter resource.

Returns:

  • (String) 


262
263
264
 
# File 'ssm/string_parameter.rb', line 262

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) 


220
221
222
 
# File 'ssm/string_parameter.rb', line 220

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



227
228
229
 
# File 'ssm/string_parameter.rb', line 227

def stack()
  jsii_get_property("stack")
end

#string_value ⇒ String

The parameter value.

Value must not nest another parameter. Do not use {} in the value.

Returns:

  • (String) 


271
272
273
 
# File 'ssm/string_parameter.rb', line 271

def string_value()
  jsii_get_property("stringValue")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


286
287
288
 
# File 'ssm/string_parameter.rb', line 286

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) 


299
300
301
302
303
304
 
# File 'ssm/string_parameter.rb', line 299

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