Package 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:
IConstruct, IDependable, IResource, IParameter, IStringListParameter, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.833Z") @Stability(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();

  • Constructor Details

    • StringListParameter

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

    • StringListParameter

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

    • StringListParameter

      @Stability(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 Details

    • fromStringListParameterName

      @Stability(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(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(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(Stable) @NotNull public String getParameterArn()
      The ARN of the SSM Parameter resource.
      Specified by:
      getParameterArn in interface IParameter

    • getParameterName

      @Stability(Stable) @NotNull public String getParameterName()
      The name of the SSM Parameter resource.
      Specified by:
      getParameterName in interface IParameter

    • getParameterType

      @Stability(Stable) @NotNull public String getParameterType()
      The type of the SSM Parameter resource.
      Specified by:
      getParameterType in interface IParameter

    • getStringListValue

      @Stability(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(Stable) @Nullable public IKey getEncryptionKey()
      The encryption key that is used to encrypt this parameter.

      • @default - default master key