Show / Hide Table of Contents

Class StringListParameter

Creates a new StringList SSM Parameter.

Inheritance
System.Object
Construct
Resource
StringListParameter
Implements
IStringListParameter
IParameter
IResource
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public class StringListParameter : Resource, IStringListParameter, IParameter, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class StringListParameter
    Inherits Resource
    Implements IStringListParameter, IParameter, IResource, IConstruct, IConstruct, IDependable
Remarks

Resource: AWS::SSM::Parameter

Synopsis

Constructors

StringListParameter(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

StringListParameter(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

StringListParameter(Construct, String, IStringListParameterProps)

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

ParameterArn

The ARN of the SSM Parameter resource.

ParameterName

The name of the SSM Parameter resource.

ParameterType

The type of the SSM Parameter resource.

StringListValue

The parameter value.

Methods

FromStringListParameterName(Construct, String, String)

Imports an external parameter of type string list.

GrantRead(IGrantable)

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

GrantWrite(IGrantable)

Grants write (PutParameter) permissions on the SSM Parameter.

Constructors

StringListParameter(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected StringListParameter(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

StringListParameter(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected StringListParameter(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

StringListParameter(Construct, String, IStringListParameterProps)

public StringListParameter(Construct scope, string id, IStringListParameterProps props)
Parameters
scope Constructs.Construct
id System.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

    System.String

    ParameterName

    The name of the SSM Parameter resource.

    public virtual string ParameterName { get; }
    Property Value

    System.String

    ParameterType

    The type of the SSM Parameter resource.

    public virtual string ParameterType { get; }
    Property Value

    System.String

    StringListValue

    The parameter value.

    public virtual string[] StringListValue { get; }
    Property Value

    System.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 Constructs.Construct
    id System.String
    stringListParameterName System.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

    Implements

    IStringListParameter
    IParameter
    IResource
    IConstruct
    Constructs.IConstruct
    IDependable
    Back to top Generated by DocFX