SecureStringParameterAttributes

class aws_cdk.aws_ssm.SecureStringParameterAttributes(*, parameter_name, simple_name=None, encryption_key=None, version=None)

Bases: 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 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

  • encryption_key (Optional[IKey]) – The encryption key that is used to encrypt this parameter. Default: - default master key

  • version (Union[int, float, None]) – The version number of the value you wish to retrieve. Default: - AWS CloudFormation uses the latest version of the parameter

ExampleMetadata

lit=test/integ.parameter-store-string.lit.ts infused

Example:

# Retrieve the latest value of the non-secret parameter
# with name "/My/String/Parameter".
string_value = ssm.StringParameter.from_string_parameter_attributes(self, "MyValue",
    parameter_name="/My/Public/Parameter"
).string_value
string_value_version_from_token = ssm.StringParameter.from_string_parameter_attributes(self, "MyValueVersionFromToken",
    parameter_name="/My/Public/Parameter",
    # parameter version from token
    version=parameter_version
).string_value

# Retrieve a specific version of the secret (SecureString) parameter.
# 'version' is always required.
secret_value = ssm.StringParameter.from_secure_string_parameter_attributes(self, "MySecureValue",
    parameter_name="/My/Secret/Parameter",
    version=5
)
secret_value_version_from_token = ssm.StringParameter.from_secure_string_parameter_attributes(self, "MySecureValueVersionFromToken",
    parameter_name="/My/Secret/Parameter",
    # parameter version from token
    version=parameter_version
)

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 be true (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.

Default
  • AWS CloudFormation uses the latest version of the parameter

Return type

Union[int, float, None]