Skip to content

Data Source: awsSsmParametersByPath

Provides SSM Parameters by path.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsSsmParametersByPath.DataAwsSsmParametersByPath(this, "foo", {
  path: "/foo",
});

\~> Note: The unencrypted value of a SecureString will be stored in the raw state as plain-text. Read more about sensitive data in state.

\~> Note: The data source is currently following the behavior of the SSM API to return a string value, regardless of parameter type. For type stringList, we can use the built-in split() function to get values in a list. Example: split(",",DataAwsSsmParameterSubnetsValue)

Argument Reference

The following arguments are supported:

  • path - (Required) Prefix path of the parameter.
  • withDecryption - (Optional) Whether to return decrypted secureString value. Defaults to true.
  • recursive - (Optional) Whether to recursively return parameters under path. Defaults to false.

In addition to all arguments above, the following attributes are exported:

  • arns - ARNs of the parameters.
  • names - Names of the parameters.
  • types - Types of the parameters.
  • values - Value of the parameters.