SecureStringParameterAttributes¶
-
class
aws_cdk.aws_ssm.
SecureStringParameterAttributes
(*, parameter_name, simple_name=None, version, encryption_key=None)¶ Bases:
aws_cdk.aws_ssm.CommonStringParameterAttributes
Attributes for secure string parameters.
- Parameters
parameter_name (
str
) – 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).simple_name (
Optional
[bool
]) – Indicates of the parameter name is a simple name (i.e. does not include “/” separators). This is only required only ifparameterName
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. IfparameterName
is not specified,simpleName
must betrue
(or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based onparameterName
version (
Union
[int
,float
]) – The version number of the value you wish to retrieve. This is required for secure strings.encryption_key (
Optional
[IKey
]) – The encryption key that is used to encrypt this parameter. Default: - default master key
Attributes
-
encryption_key
¶ The encryption key that is used to encrypt this parameter.
- Default
default master key
- Return type
Optional
[IKey
]
-
parameter_name
¶ 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).
- Return type
str
-
simple_name
¶ 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 betrue
(or undefined) since the name generated by AWS CloudFormation is always a simple name.- Default
auto-detect based on
parameterName
- Return type
Optional
[bool
]
-
version
¶ The version number of the value you wish to retrieve.
This is required for secure strings.
- Return type
Union
[int
,float
]