import * as pulumi from "@pulumi/pulumi"; /** * Use this data source to get information about one or more System Manager parameters in a specific hierarchy. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssm.getParametersByPath({ * path: "/site/newyork/department/", * }); * ``` * * > **Note:** When the `withDecryption` argument is set to `true`, the unencrypted values of `SecureString` parameters will be stored in the raw state as plain-text as per normal Terraform behavior. > **Note:** The data source follows the behavior of the [SSM API](https://docs.aws.amazon.com/sdk-for-go/api/service/ssm/#Parameter) to return a string value, regardless of parameter type. For `StringList` type where the value is returned as a comma-separated string with no spaces between comma, you may use the built-in split function to get values in a list. Example: `split(",", data.aws_ssm_parameter.subnets.value)` */ export declare function getParametersByPath(args: GetParametersByPathArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getParametersByPath. */ export interface GetParametersByPathArgs { /** * The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. **Note:** If the parameter name (e.g., `/my-app/my-param`) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., `/my-app/my-param/my-actual-param`). */ path: string; /** * Whether to retrieve all parameters within the hirerachy. Defaults to `false`. */ recursive?: boolean; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; /** * Whether to retrieve all parameters in the hierarchy, particularly those of `SecureString` type, with their value decrypted. Defaults to `true`. */ withDecryption?: boolean; } /** * A collection of values returned by getParametersByPath. */ export interface GetParametersByPathResult { /** * List that contains the ARNs of the retrieved parameters. */ readonly arns: string[]; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * A list that contains the names of the retrieved parameters. */ readonly names: string[]; readonly path: string; readonly recursive?: boolean; readonly region: string; /** * A list that contains the types (`String`, `StringList`, or `SecureString`) of retrieved parameters. */ readonly types: string[]; /** * A list that contains the retrieved parameter values. **Note:** This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of `SecureString` type. Use the `nonsensitive` function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved. */ readonly values: string[]; readonly withDecryption?: boolean; } /** * Use this data source to get information about one or more System Manager parameters in a specific hierarchy. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssm.getParametersByPath({ * path: "/site/newyork/department/", * }); * ``` * * > **Note:** When the `withDecryption` argument is set to `true`, the unencrypted values of `SecureString` parameters will be stored in the raw state as plain-text as per normal Terraform behavior. > **Note:** The data source follows the behavior of the [SSM API](https://docs.aws.amazon.com/sdk-for-go/api/service/ssm/#Parameter) to return a string value, regardless of parameter type. For `StringList` type where the value is returned as a comma-separated string with no spaces between comma, you may use the built-in split function to get values in a list. Example: `split(",", data.aws_ssm_parameter.subnets.value)` */ export declare function getParametersByPathOutput(args: GetParametersByPathOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getParametersByPath. */ export interface GetParametersByPathOutputArgs { /** * The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. **Note:** If the parameter name (e.g., `/my-app/my-param`) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., `/my-app/my-param/my-actual-param`). */ path: pulumi.Input; /** * Whether to retrieve all parameters within the hirerachy. Defaults to `false`. */ recursive?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Whether to retrieve all parameters in the hierarchy, particularly those of `SecureString` type, with their value decrypted. Defaults to `true`. */ withDecryption?: pulumi.Input; } //# sourceMappingURL=getParametersByPath.d.ts.map