Class StringListParameter

Creates a new StringList SSM Parameter.

Inheritance

object

Resource

StringListParameter

Implements

IStringListParameter

IParameter

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StringListParameter : Resource, IStringListParameter, IParameter, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class StringListParameter Inherits Resource Implements IStringListParameter, IParameter, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

Examples

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

Synopsis

Constructors

StringListParameter(Construct, string, IStringListParameterProps)

Creates a new StringList SSM Parameter.

Properties

EncryptionKey	The encryption key that is used to encrypt this parameter.
PROPERTY_INJECTION_ID	Uniquely identifies this class.
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

FromListParameterAttributes(Construct, string, IListParameterAttributes)	Imports an external string list parameter with name and optional version.
FromStringListParameterName(Construct, string, string)	Imports an external parameter of type string list.
GrantRead(IGrantable)	Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
GrantWrite(IGrantable)	Grants write (PutParameter) permissions on the SSM Parameter.
ValueForTypedListParameter(Construct, string, ParameterValueType?, double?)	Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

Constructors

StringListParameter(Construct, string, IStringListParameterProps)

Creates a new StringList SSM Parameter.

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

Parameters

scope Construct

id string

props IStringListParameterProps

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

Examples

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

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

public virtual IKey? EncryptionKey { get; }

Property Value

IKey

Remarks

Default: - default master key

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

ParameterArn

The ARN of the SSM Parameter resource.

public virtual string ParameterArn { get; }

Property Value

string

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

ParameterName

The name of the SSM Parameter resource.

public virtual string ParameterName { get; }

Property Value

string

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

ParameterType

The type of the SSM Parameter resource.

public virtual string ParameterType { get; }

Property Value

string

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

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

FromListParameterAttributes(Construct, string, IListParameterAttributes)

Imports an external string list parameter with name and optional version.

public static IStringListParameter FromListParameterAttributes(Construct scope, string id, IListParameterAttributes attrs)

Parameters

scope Construct

id string

attrs IListParameterAttributes

Returns

IStringListParameter

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

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, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

GrantWrite(IGrantable)

Grants write (PutParameter) permissions on the SSM Parameter.

public virtual Grant GrantWrite(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

ValueForTypedListParameter(Construct, string, ParameterValueType?, double?)

Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

public static string[] ValueForTypedListParameter(Construct scope, string parameterName, ParameterValueType? type = null, double? version = null)

Parameters

scope Construct

Some scope within a stack.

parameterName string

The name of the SSM parameter.

type ParameterValueType?

the type of the SSM list parameter.

version double?

The parameter version (recommended in order to ensure that the value won't change during deployment).

Returns

string[]

Remarks

Resource: AWS::SSM::Parameter

ExampleMetadata: infused

Implements

IStringListParameter

IParameter

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware