Skip to content

Data Source: awsSsmParameter

Provides an SSM Parameter data source.

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.dataAwsSsmParameter.DataAwsSsmParameter(this, "foo", {
  name: "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:

  • name - (Required) Name of the parameter.
  • withDecryption - (Optional) Whether to return decrypted secureString value. Defaults to true.

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

  • arn - ARN of the parameter.
  • name - Name of the parameter.
  • type - Type of the parameter. Valid types are string, stringList and secureString.
  • value - Value of the parameter. This value is always marked as sensitive in the Terraform plan output, regardless of type. In Terraform CLI version 0.15 and later, this may require additional configuration handling for certain scenarios. For more information, see the Terraform v0.15 Upgrade Guide.
  • version - Version of the parameter.