-
Notifications
You must be signed in to change notification settings - Fork 155
/
getParameter.ts
101 lines (96 loc) · 2.85 KB
/
getParameter.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "../utilities";
/**
* Provides an SSM Parameter data source.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo",
* });
* ```
*
* > **Note:** The unencrypted value of a SecureString will be stored in the raw state as plain-text.
*/
export function getParameter(args: GetParameterArgs, opts?: pulumi.InvokeOptions): Promise<GetParameterResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("aws:ssm/getParameter:getParameter", {
"name": args.name,
"withDecryption": args.withDecryption,
}, opts);
}
/**
* A collection of arguments for invoking getParameter.
*/
export interface GetParameterArgs {
/**
* Name of the parameter.
*/
name: string;
/**
* Whether to return decrypted `SecureString` value. Defaults to `true`.
*
* In addition to all arguments above, the following attributes are exported:
*/
withDecryption?: boolean;
}
/**
* A collection of values returned by getParameter.
*/
export interface GetParameterResult {
readonly arn: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly insecureValue: string;
readonly name: string;
readonly type: string;
readonly value: string;
readonly version: number;
readonly withDecryption?: boolean;
}
/**
* Provides an SSM Parameter data source.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo",
* });
* ```
*
* > **Note:** The unencrypted value of a SecureString will be stored in the raw state as plain-text.
*/
export function getParameterOutput(args: GetParameterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetParameterResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("aws:ssm/getParameter:getParameter", {
"name": args.name,
"withDecryption": args.withDecryption,
}, opts);
}
/**
* A collection of arguments for invoking getParameter.
*/
export interface GetParameterOutputArgs {
/**
* Name of the parameter.
*/
name: pulumi.Input<string>;
/**
* Whether to return decrypted `SecureString` value. Defaults to `true`.
*
* In addition to all arguments above, the following attributes are exported:
*/
withDecryption?: pulumi.Input<boolean>;
}