software.amazon.awscdk.services.ssm

Class StringListParameter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ssm.StringListParameter

All Implemented Interfaces:

IDependable, IResource, IParameter, IStringListParameter, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.968Z")
 @Stability(value=Stable)
public class StringListParameter
extends Resource
implements IStringListParameter, IParameter

Creates a new StringList SSM Parameter.

Example:

 // Create a new SSM Parameter holding a String
 StringParameter param = StringParameter.Builder.create(stack, "StringParameter")
         // description: 'Some user-friendly description',
         // name: 'ParameterName',
         .stringValue("Initial parameter value")
         .build();
 // Grant read access to some Role
 param.grantRead(role);
 // Create a new SSM Parameter holding a StringList
 StringListParameter listParameter = StringListParameter.Builder.create(stack, "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	Class and Description
static class	StringListParameter.Builder A fluent builder for StringListParameter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.IStringListParameter

IStringListParameter.Jsii$Default, IStringListParameter.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	StringListParameter(software.constructs.Construct scope, String id, StringListParameterProps props)
protected	StringListParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StringListParameter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IStringListParameter	fromStringListParameterName(software.constructs.Construct scope, String id, String stringListParameterName) Imports an external parameter of type string list.
IKey	getEncryptionKey() The encryption key that is used to encrypt this parameter.
String	getParameterArn() The ARN of the SSM Parameter resource.
String	getParameterName() The name of the SSM Parameter resource.
String	getParameterType() The type of the SSM Parameter resource.
List<String>	getStringListValue() The parameter value.
Grant	grantRead(IGrantable grantee) Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
Grant	grantWrite(IGrantable grantee) Grants write (PutParameter) permissions on the SSM Parameter.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

StringListParameter

protected StringListParameter(software.amazon.jsii.JsiiObjectRef objRef)

StringListParameter

protected StringListParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StringListParameter

@Stability(value=Stable)
public StringListParameter(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    StringListParameterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromStringListParameterName

@Stability(value=Stable)
 @NotNull
public static IStringListParameter fromStringListParameterName(@NotNull
                                                                                                  software.constructs.Construct scope,
                                                                                                  @NotNull
                                                                                                  String id,
                                                                                                  @NotNull
                                                                                                  String stringListParameterName)

Imports an external parameter of type string list.

Returns a token and should not be parsed.

Parameters:

scope - This parameter is required.

id - This parameter is required.

stringListParameterName - This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
public Grant grantRead(@NotNull
                                                          IGrantable grantee)

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Specified by:

grantRead in interface IParameter

Parameters:

grantee - This parameter is required.

grantWrite

@Stability(value=Stable)
 @NotNull
public Grant grantWrite(@NotNull
                                                           IGrantable grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Specified by:

grantWrite in interface IParameter

Parameters:

grantee - This parameter is required.

getParameterArn

@Stability(value=Stable)
 @NotNull
public String getParameterArn()

The ARN of the SSM Parameter resource.

Specified by:

getParameterArn in interface IParameter

getParameterName

@Stability(value=Stable)
 @NotNull
public String getParameterName()

The name of the SSM Parameter resource.

Specified by:

getParameterName in interface IParameter

getParameterType

@Stability(value=Stable)
 @NotNull
public String getParameterType()

The type of the SSM Parameter resource.

Specified by:

getParameterType in interface IParameter

getStringListValue

@Stability(value=Stable)
 @NotNull
public List<String> getStringListValue()

The parameter value.

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

Specified by:

getStringListValue in interface IStringListParameter

getEncryptionKey

@Stability(value=Stable)
 @Nullable
public IKey getEncryptionKey()

The encryption key that is used to encrypt this parameter.

• @default - default master key