StringListParameterProps Struct
Properties needed to create a StringList SSM Parameter.
| Source | aws-ssm/lib/parameter.ts |
|---|
Example
// Create a new SSM Parameter holding a String
const param = new ssm.StringParameter(this, 'StringParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringValue: 'Initial parameter value',
// allowedPattern: '.*',
});
// Grant read access to some Role
declare const role: iam.IRole;
param.grantRead(role);
// Create a new SSM Parameter holding a StringList
const listParameter = new ssm.StringListParameter(this, 'StringListParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringListValue: ['Initial parameter value A', 'Initial parameter value B'],
// allowedPattern: '.*',
});
# Grant read access to some Role
# role: iam.IRole
# Create a new SSM Parameter holding a String
param = ssm.StringParameter(self, "StringParameter",
# description: 'Some user-friendly description',
# name: 'ParameterName',
string_value="Initial parameter value"
)
param.grant_read(role)
# Create a new SSM Parameter holding a StringList
list_parameter = ssm.StringListParameter(self, "StringListParameter",
# description: 'Some user-friendly description',
# name: 'ParameterName',
string_list_value=["Initial parameter value A", "Initial parameter value B"]
)
// Grant read access to some Role
IRole role;
// Create a new SSM Parameter holding a String
StringParameter param = StringParameter.Builder.create(this, "StringParameter")
// description: 'Some user-friendly description',
// name: 'ParameterName',
.stringValue("Initial parameter value")
.build();
param.grantRead(role);
// Create a new SSM Parameter holding a StringList
StringListParameter listParameter = StringListParameter.Builder.create(this, "StringListParameter")
// description: 'Some user-friendly description',
// name: 'ParameterName',
.stringListValue(List.of("Initial parameter value A", "Initial parameter value B"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// 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" }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Grant read access to some Role
var role IRole
// Create a new SSM Parameter holding a String
param := ssm.NewStringParameter(this, jsii.String("StringParameter"), &StringParameterProps{
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringValue: jsii.String("Initial parameter value"),
})
param.grantRead(role)
// Create a new SSM Parameter holding a StringList
listParameter := ssm.NewStringListParameter(this, jsii.String("StringListParameter"), &StringListParameterProps{
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringListValue: []*string{
jsii.String("Initial parameter value A"),
jsii.String("Initial parameter value B"),
},
})
Properties
allowedPatternoptionalstringallowed_patternoptionalstrallowedPatternoptionalStringAllowedPatternoptionalstringAllowedPatternoptional*string #Default: no validation is performed
For example, for String types with values restricted to numbers, you can specify the following: ^\d+$
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string = none #parameterNameoptionalstringparameter_nameoptionalstrparameterNameoptionalStringParameterNameoptionalstringParameterNameoptional*string #Default: a name will be generated by CloudFormation
simpleNameoptionalbooleansimple_nameoptionalboolsimpleNameoptionalBooleanSimpleNameoptionalboolSimpleNameoptional*bool #Default: auto-detect based on parameterName
notes
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.
stringListValuestring[]string_list_valuetyping.List[str]stringListValueList<String>StringListValuestring[]StringListValue*[]*string required #It may not reference another parameter and {{}} cannot be used in the value.
tieroptionalParameterTiertieroptionalParameterTiertieroptionalParameterTierTieroptionalParameterTierTieroptionalParameterTier = undefined #