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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.335Z")
 @Stability(value=Stable)
public interface StringParameterProps
extends software.amazon.jsii.JsiiSerializable, ParameterOptions

Properties needed to create a String SSM parameter.

Example:

 StringParameter.Builder.create(this, "Parameter")
         .allowedPattern(".*")
         .description("The value Foo")
         .parameterName("FooParameter")
         .stringValue("Foo")
         .tier(ParameterTier.ADVANCED)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.awscdk.services.ssm.ParameterOptions

getAllowedPattern, getDescription, getParameterName, getSimpleName, getTier

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStringValue

@Stability(value=Stable)
 @NotNull
String getStringValue()

The value of the parameter.

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

getDataType

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

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

Default: ParameterDataType.TEXT

getType

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

Deprecated. - type will always be 'String'

(deprecated) The type of the string parameter.

Default: ParameterType.STRING

builder

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

Specified by:

builder in interface ParameterOptions

Returns:

a StringParameterProps.Builder of StringParameterProps