Package software.amazon.awscdk.services.ssm

Class StringListParameter

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.ssm.StringListParameter
All Implemented Interfaces:
IResource, IParameter, IStringListParameter, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.271Z") @Stability(Stable) public class StringListParameter extends Resource implements IStringListParameter, IParameter
Creates a new StringList SSM Parameter.

Example: 

 StringListParameter.valueForTypedListParameter(this, "/My/Public/Parameter", ParameterValueType.AWS_EC2_IMAGE_ID);

  • 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

    • fromListParameterAttributes

      @Stability(Stable) @NotNull public static IStringListParameter fromListParameterAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ListParameterAttributes attrs)
      Imports an external string list parameter with name and optional version.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • 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.

    • valueForTypedListParameter

      @Stability(Stable) @NotNull public static List<String> valueForTypedListParameter(@NotNull software.constructs.Construct scope, @NotNull String parameterName, @Nullable ParameterValueType type, @Nullable Number version)
      Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

      Parameters:
      scope - Some scope within a stack. This parameter is required.
      parameterName - The name of the SSM parameter. This parameter is required.
      type - the type of the SSM list parameter.
      version - The parameter version (recommended in order to ensure that the value won't change during deployment).

    • valueForTypedListParameter

      @Stability(Stable) @NotNull public static List<String> valueForTypedListParameter(@NotNull software.constructs.Construct scope, @NotNull String parameterName, @Nullable ParameterValueType type)
      Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

      Parameters:
      scope - Some scope within a stack. This parameter is required.
      parameterName - The name of the SSM parameter. This parameter is required.
      type - the type of the SSM list parameter.

    • valueForTypedListParameter

      @Stability(Stable) @NotNull public static List<String> valueForTypedListParameter(@NotNull software.constructs.Construct scope, @NotNull String parameterName)
      Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

      Parameters:
      scope - Some scope within a stack. This parameter is required.
      parameterName - The name of the SSM parameter. This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
      Grants read (DescribeParameter, GetParameters, 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