Interface ICommonStringParameterAttributes
Common attributes for string parameters.
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICommonStringParameterAttributes
Syntax (vb)
Public Interface ICommonStringParameterAttributes
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var commonStringParameterAttributes = new CommonStringParameterAttributes {
ParameterName = "parameterName",
// the properties below are optional
SimpleName = false
};
Synopsis
Properties
ParameterName | The name of the parameter store value. |
SimpleName | Indicates if the parameter name is a simple name (i.e. does not include "/" separators). |
Properties
ParameterName
The name of the parameter store value.
string ParameterName { get; }
Property Value
System.String
Remarks
This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
SimpleName
Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
virtual Nullable<bool> SimpleName { get; }
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