Class StringListParameterProps
Properties needed to create a StringList SSM Parameter.
Inheritance
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StringListParameterProps : Object, IStringListParameterProps, IParameterOptions
Syntax (vb)
Public Class StringListParameterProps
Inherits Object
Implements IStringListParameterProps, IParameterOptions
Remarks
ExampleMetadata: infused
Examples
// Grant read access to some Role
IRole role;
// Create a new SSM Parameter holding a String
var param = new StringParameter(this, "StringParameter", new StringParameterProps {
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringValue = "Initial parameter value"
});
param.GrantRead(role);
// Create a new SSM Parameter holding a StringList
var listParameter = new StringListParameter(this, "StringListParameter", new StringListParameterProps {
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringListValue = new [] { "Initial parameter value A", "Initial parameter value B" }
});
Synopsis
Constructors
StringListParameterProps() |
Properties
AllowedPattern | A regular expression used to validate the parameter value. |
Description | Information about the parameter that you want to add to the system. |
ParameterName | The name of the parameter. |
SimpleName | Indicates if the parameter name is a simple name (i.e. does not include "/" separators). |
StringListValue | The values of the parameter. |
Tier | The tier of the string parameter. |
Constructors
StringListParameterProps()
public StringListParameterProps()
Properties
AllowedPattern
A regular expression used to validate the parameter value.
public string AllowedPattern { get; set; }
Property Value
System.String
Remarks
For example, for String types with values restricted to
numbers, you can specify the following: ^\d+$
Default: no validation is performed
Description
Information about the parameter that you want to add to the system.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: none
ParameterName
The name of the parameter.
public string ParameterName { get; set; }
Property Value
System.String
Remarks
Default: - a name will be generated by CloudFormation
SimpleName
Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
public Nullable<bool> SimpleName { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This is required only if parameterName
is a token, which means we
are unable to detect if the name is simple or "path-like" for the purpose
of rendering SSM parameter ARNs.
If parameterName
is not specified, simpleName
must be true
(or
undefined) since the name generated by AWS CloudFormation is always a
simple name.
Default: - auto-detect based on parameterName
StringListValue
The values of the parameter.
public string[] StringListValue { get; set; }
Property Value
System.String[]
Remarks
It may not reference another parameter and {{}}
cannot be used in the value.
Tier
The tier of the string parameter.
public Nullable<ParameterTier> Tier { get; set; }
Property Value
System.Nullable<ParameterTier>
Remarks
Default: - undefined