interface CommonStringParameterAttributes
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SSM.CommonStringParameterAttributes |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsssm#CommonStringParameterAttributes |
![]() | software.amazon.awscdk.services.ssm.CommonStringParameterAttributes |
![]() | aws_cdk.aws_ssm.CommonStringParameterAttributes |
![]() | aws-cdk-lib » aws_ssm » CommonStringParameterAttributes |
Common attributes for string parameters.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const commonStringParameterAttributes: ssm.CommonStringParameterAttributes = {
parameterName: 'parameterName',
// the properties below are optional
simpleName: false,
};
Properties
Name | Type | Description |
---|---|---|
parameter | string | The name of the parameter store value. |
simple | boolean | Indicates whether the parameter name is a simple name. |
parameterName
Type:
string
The name of the parameter store value.
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?
Type:
boolean
(optional, default: auto-detect based on parameterName
)
Indicates whether the parameter name is a simple name.
A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN.
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.