-
Notifications
You must be signed in to change notification settings - Fork 155
/
apiKey.ts
165 lines (155 loc) · 5.93 KB
/
apiKey.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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// *** 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";
import {RestApi} from "./restApi";
/**
* Provides an API Gateway API Key.
*
* > **NOTE:** Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now **required** to associate an API key with an API stage.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const myDemoApiKey = new aws.apigateway.ApiKey("MyDemoApiKey", {});
* ```
*
* > This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_api_key.html.markdown.
*/
export class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey {
return new ApiKey(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'aws:apigateway/apiKey:ApiKey';
/**
* Returns true if the given object is an instance of ApiKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is ApiKey {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ApiKey.__pulumiType;
}
/**
* The creation date of the API key
*/
public /*out*/ readonly createdDate!: pulumi.Output<string>;
/**
* The API key description. Defaults to "Managed by Pulumi".
*/
public readonly description!: pulumi.Output<string>;
/**
* Specifies whether the API key can be used by callers. Defaults to `true`.
*/
public readonly enabled!: pulumi.Output<boolean | undefined>;
/**
* The last update date of the API key
*/
public /*out*/ readonly lastUpdatedDate!: pulumi.Output<string>;
/**
* The name of the API key
*/
public readonly name!: pulumi.Output<string>;
/**
* The value of the API key. If not specified, it will be automatically generated by AWS on creation.
*/
public readonly value!: pulumi.Output<string>;
/**
* Create a ApiKey resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ApiKeyArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: ApiKeyArgs | ApiKeyState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as ApiKeyState | undefined;
inputs["createdDate"] = state ? state.createdDate : undefined;
inputs["description"] = state ? state.description : undefined;
inputs["enabled"] = state ? state.enabled : undefined;
inputs["lastUpdatedDate"] = state ? state.lastUpdatedDate : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["value"] = state ? state.value : undefined;
} else {
const args = argsOrState as ApiKeyArgs | undefined;
inputs["description"] = (args ? args.description : undefined) || "Managed by Pulumi";
inputs["enabled"] = args ? args.enabled : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["value"] = args ? args.value : undefined;
inputs["createdDate"] = undefined /*out*/;
inputs["lastUpdatedDate"] = undefined /*out*/;
}
if (!opts) {
opts = {}
}
if (!opts.version) {
opts.version = utilities.getVersion();
}
super(ApiKey.__pulumiType, name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
/**
* The creation date of the API key
*/
readonly createdDate?: pulumi.Input<string>;
/**
* The API key description. Defaults to "Managed by Pulumi".
*/
readonly description?: pulumi.Input<string>;
/**
* Specifies whether the API key can be used by callers. Defaults to `true`.
*/
readonly enabled?: pulumi.Input<boolean>;
/**
* The last update date of the API key
*/
readonly lastUpdatedDate?: pulumi.Input<string>;
/**
* The name of the API key
*/
readonly name?: pulumi.Input<string>;
/**
* The value of the API key. If not specified, it will be automatically generated by AWS on creation.
*/
readonly value?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
/**
* The API key description. Defaults to "Managed by Pulumi".
*/
readonly description?: pulumi.Input<string>;
/**
* Specifies whether the API key can be used by callers. Defaults to `true`.
*/
readonly enabled?: pulumi.Input<boolean>;
/**
* The name of the API key
*/
readonly name?: pulumi.Input<string>;
/**
* The value of the API key. If not specified, it will be automatically generated by AWS on creation.
*/
readonly value?: pulumi.Input<string>;
}