software.amazon.awscdk.services.ssm

Interface ListParameterAttributes

All Superinterfaces:

CommonStringParameterAttributes, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ListParameterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.330Z")
 @Stability(value=Stable)
public interface ListParameterAttributes
extends software.amazon.jsii.JsiiSerializable, CommonStringParameterAttributes

Attributes for parameters of string list type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 ListParameterAttributes listParameterAttributes = ListParameterAttributes.builder()
         .parameterName("parameterName")
         // the properties below are optional
         .elementType(ParameterValueType.STRING)
         .simpleName(false)
         .version(123)
         .build();
 

See Also:

ParameterType

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ListParameterAttributes.Builder	builder()
default ParameterValueType	getElementType() The type of the string list parameter value.
default Number	getVersion() The version number of the value you wish to retrieve.

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

getParameterName, getSimpleName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getElementType

@Stability(value=Stable)
 @Nullable
default ParameterValueType getElementType()

The type of the string list parameter value.

Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

Default: ParameterValueType.STRING

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types

getVersion

@Stability(value=Stable)
 @Nullable
default Number getVersion()

The version number of the value you wish to retrieve.

Default: The latest version will be retrieved.

builder

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

Specified by:

builder in interface CommonStringParameterAttributes

Returns:

a ListParameterAttributes.Builder of ListParameterAttributes