Package software.amazon.awscdk.services.ssm

Interface StringParameterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ParameterOptions

All Known Implementing Classes:

StringParameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-14T22:22:02.177Z")
@Stability(Stable)
public interface StringParameterProps
extends software.amazon.jsii.JsiiSerializable, ParameterOptions

Properties needed to create a String SSM parameter.

Example:

 // Grant read access to some Role
 IRole role;
 // Create a new SSM Parameter holding a String
 StringParameter param = StringParameter.Builder.create(this, "StringParameter")
         // description: 'Some user-friendly description',
         // name: 'ParameterName',
         .stringValue("Initial parameter value")
         .build();
 param.grantRead(role);
 // Create a new SSM Parameter holding a StringList
 StringListParameter listParameter = StringListParameter.Builder.create(this, "StringListParameter")
         // description: 'Some user-friendly description',
         // name: 'ParameterName',
         .stringListValue(List.of("Initial parameter value A", "Initial parameter value B"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StringParameterProps.Builder	A builder for StringParameterProps
static final class	StringParameterProps.Jsii$Proxy	An implementation for StringParameterProps

Method Summary

Modifier and Type	Method	Description
static StringParameterProps.Builder	builder()
default ParameterDataType	getDataType()	The data type of the parameter, such as text or aws:ec2:image.
String	getStringValue()	The value of the parameter.
default ParameterType	getType()	Deprecated. type will always be 'String'

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ssm.ParameterOptions

getAllowedPattern, getDescription, getParameterName, getSimpleName, getTier

Method Details

getStringValue

@Stability(Stable)
@NotNull
String getStringValue()

The value of the parameter.

It may not reference another parameter and {{}} cannot be used in the value.

getDataType

@Stability(Stable)
@Nullable
default ParameterDataType getDataType()

The data type of the parameter, such as text or aws:ec2:image.

Default: ParameterDataType.TEXT

getType

@Stability(Deprecated)
@Deprecated
@Nullable
default ParameterType getType()

Deprecated.

• type will always be 'String'

(deprecated) The type of the string parameter.

Default: ParameterType.STRING

builder

@Stability(Stable)
static StringParameterProps.Builder builder()

Returns:

a StringParameterProps.Builder of StringParameterProps