Table of Contents

Class StringListParameter

Namespace
Amazon.CDK.AWS.SSM
Assembly
Amazon.CDK.AWS.SSM.dll

Creates a new StringList SSM Parameter.

public class StringListParameter : Resource, IStringListParameter, IParameter, IResource, IConstruct, IConstruct, IDependable
Inheritance
StringListParameter
Implements
IResource
IConstruct
IConstruct
IDependable

Examples

// Create a new SSM Parameter holding a String
             var param = new StringParameter(stack, "StringParameter", new StringParameterProps {
                 // description: 'Some user-friendly description',
                 // name: 'ParameterName',
                 StringValue = "Initial parameter value"
             });

             // Grant read access to some Role
             param.GrantRead(role);

             // Create a new SSM Parameter holding a StringList
             var listParameter = new StringListParameter(stack, "StringListParameter", new StringListParameterProps {
                 // description: 'Some user-friendly description',
                 // name: 'ParameterName',
                 StringListValue = new [] { "Initial parameter value A", "Initial parameter value B" }
             });

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: lit=test/integ.parameter.lit.ts infused

Constructors

StringListParameter(Construct, string, IStringListParameterProps) 

public StringListParameter(Construct scope, string id, IStringListParameterProps props)

Parameters

scope Construct
id string
props IStringListParameterProps

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

public virtual IKey? EncryptionKey { get; }

Property Value

IKey

Remarks

    ParameterArn

    The ARN of the SSM Parameter resource.

    public virtual string ParameterArn { get; }

    Property Value

    string

    ParameterName

    The name of the SSM Parameter resource.

    public virtual string ParameterName { get; }

    Property Value

    string

    ParameterType

    The type of the SSM Parameter resource.

    public virtual string ParameterType { get; }

    Property Value

    string

    StringListValue

    The parameter value.

    public virtual string[] StringListValue { get; }

    Property Value

    string[]

    Remarks

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

    Methods

    FromStringListParameterName(Construct, string, string)

    Imports an external parameter of type string list.

    public static IStringListParameter FromStringListParameterName(Construct scope, string id, string stringListParameterName)

    Parameters

    scope Construct
    id string
    stringListParameterName string

    Returns

    IStringListParameter

    Remarks

    Returns a token and should not be parsed.

    GrantRead(IGrantable)

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

    public virtual Grant GrantRead(IGrantable grantee)

    Parameters

    grantee IGrantable

    Returns

    Grant

    GrantWrite(IGrantable)

    Grants write (PutParameter) permissions on the SSM Parameter.

    public virtual Grant GrantWrite(IGrantable grantee)

    Parameters

    grantee IGrantable

    Returns

    Grant