StringListParameter

class aws_cdk.aws_ssm.StringListParameter(scope, id, *, string_list_value, allowed_pattern=None, description=None, parameter_name=None, simple_name=None)

Bases: aws_cdk.core.Resource

Creates a new StringList SSM Parameter.

resource: :resource:: AWS::SSM::Parameter

__init__(scope, id, *, string_list_value, allowed_pattern=None, description=None, parameter_name=None, simple_name=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • string_list_value (List[str]) – The values of the parameter. It may not reference another parameter and {{}} cannot be used in the value.

  • allowed_pattern (Optional[str]) – 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+$ Default: no validation is performed

  • description (Optional[str]) – Information about the parameter that you want to add to the system. Default: none

  • parameter_name (Optional[str]) – The name of the parameter. Default: - a name will be generated by CloudFormation

  • simple_name (Optional[bool]) – 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. Default: - auto-detect based on parameterName

Return type

None

Methods

grant_read(grantee)

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters

grantee (IGrantable) –

Return type

Grant

grant_write(grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters

grantee (IGrantable) –

Return type

Grant

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

encryption_key

The encryption key that is used to encrypt this parameter.

  • @default - default master key

Return type

Optional[IKey]

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

parameter_arn

The ARN of the SSM Parameter resource.

Return type

str

parameter_name

The name of the SSM Parameter resource.

Return type

str

parameter_type

The type of the SSM Parameter resource.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

string_list_value

The parameter value.

Value must not nest another parameter. Do not use {{}} in the value. Values in the array cannot contain commas (,).

Return type

List[str]

Static Methods

classmethod from_string_list_parameter_name(scope, id, string_list_parameter_name)

Imports an external parameter of type string list.

Returns a token and should not be parsed.

Parameters
  • scope (Construct) –

  • id (str) –

  • string_list_parameter_name (str) –

Return type

IStringListParameter

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool