class StringListParameter (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SSM.StringListParameter |
![]() | software.amazon.awscdk.services.ssm.StringListParameter |
![]() | aws_cdk.aws_ssm.StringListParameter |
![]() | @aws-cdk/aws-ssm » StringListParameter |
Implements
IConstruct
, IConstruct
, IDependable
, IResource
, IString
, IParameter
Creates a new StringList SSM Parameter.
Example
// Create a new SSM Parameter holding a String
const param = new ssm.StringParameter(stack, 'StringParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringValue: 'Initial parameter value',
// allowedPattern: '.*',
});
// Grant read access to some Role
param.grantRead(role);
// Create a new SSM Parameter holding a StringList
const listParameter = new ssm.StringListParameter(stack, 'StringListParameter', {
// description: 'Some user-friendly description',
// name: 'ParameterName',
stringListValue: ['Initial parameter value A', 'Initial parameter value B'],
// allowedPattern: '.*',
});
Initializer
new StringListParameter(scope: Construct, id: string, props: StringListParameterProps)
Parameters
- scope
Construct
- id
string
- props
String
List Parameter Props
Construct Props
Name | Type | Description |
---|---|---|
string | string[] | The values of the parameter. |
allowed | string | A regular expression used to validate the parameter value. |
description? | string | Information about the parameter that you want to add to the system. |
parameter | string | The name of the parameter. |
simple | boolean | Indicates of the parameter name is a simple name (i.e. does not include "/" separators). |
tier? | Parameter | The tier of the string parameter. |
stringListValue
Type:
string[]
The values of the parameter.
It may not reference another parameter and {{}}
cannot be used in the value.
allowedPattern?
Type:
string
(optional, default: no validation is performed)
A regular expression used to validate the parameter value.
For example, for String types with values restricted to
numbers, you can specify the following: ^\d+$
description?
Type:
string
(optional, default: none)
Information about the parameter that you want to add to the system.
parameterName?
Type:
string
(optional, default: a name will be generated by CloudFormation)
The name of the parameter.
simpleName?
Type:
boolean
(optional, default: auto-detect based on parameterName
)
Indicates of the parameter name is a simple name (i.e. does not include "/" separators).
This is only 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.
tier?
Type:
Parameter
(optional, default: undefined)
The tier of the string parameter.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Construct | The construct tree node associated with this construct. |
parameter | string | The ARN of the SSM Parameter resource. |
parameter | string | The name of the SSM Parameter resource. |
parameter | string | The type of the SSM Parameter resource. |
stack | Stack | The stack in which this resource is defined. |
string | string[] | The parameter value. |
encryption | IKey | The encryption key that is used to encrypt this parameter. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Construct
The construct tree node associated with this construct.
parameterArn
Type:
string
The ARN of the SSM Parameter resource.
parameterName
Type:
string
The name of the SSM Parameter resource.
parameterType
Type:
string
The type of the SSM Parameter resource.
stack
Type:
Stack
The stack in which this resource is defined.
stringListValue
Type:
string[]
The parameter value.
Value must not nest another parameter. Do not use {{}} in the value. Values in the array
cannot contain commas (,
).
encryptionKey?
Type:
IKey
(optional)
The encryption key that is used to encrypt this parameter.
- @default - default master key
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter. |
grant | Grants write (PutParameter) permissions on the SSM Parameter. |
to | Returns a string representation of this construct. |
static from | Imports an external parameter of type string list. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
grantWrite(grantee)
public grantWrite(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grants write (PutParameter) permissions on the SSM Parameter.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromStringListParameterName(scope, id, stringListParameterName)
public static fromStringListParameterName(scope: Construct, id: string, stringListParameterName: string): IStringListParameter
Parameters
- scope
Construct
- id
string
- stringListParameterName
string
Returns
Imports an external parameter of type string list.
Returns a token and should not be parsed.