-
Notifications
You must be signed in to change notification settings - Fork 573
/
CreateMountTargetCommand.ts
253 lines (242 loc) · 12.2 KB
/
CreateMountTargetCommand.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
import {
CreateMountTargetRequest,
CreateMountTargetRequestFilterSensitiveLog,
MountTargetDescription,
MountTargetDescriptionFilterSensitiveLog,
} from "../models/models_0";
import {
deserializeAws_restJson1CreateMountTargetCommand,
serializeAws_restJson1CreateMountTargetCommand,
} from "../protocols/Aws_restJson1";
export interface CreateMountTargetCommandInput extends CreateMountTargetRequest {}
export interface CreateMountTargetCommandOutput extends MountTargetDescription, __MetadataBearer {}
/**
* <p>Creates a mount target for a file system. You can then mount the file system on EC2
* instances by using the mount target.</p>
* <p>You can create one mount target in each Availability Zone in your VPC. All EC2
* instances in a VPC within a given Availability Zone share a single mount target for a given
* file system. If you have multiple subnets in an Availability Zone, you create a mount target
* in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target
* in order to access their file system.</p>
* <p>You can create only one mount target for an EFS file system using One Zone storage
* classes. You must create that mount target in the same Availability Zone in which the file
* system is located. Use the <code>AvailabilityZoneName</code> and
* <code>AvailabiltyZoneId</code> properties in the <a>DescribeFileSystems</a>
* response object to get this information. Use the <code>subnetId</code> associated with the
* file system's Availability Zone when creating the mount target.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </p>
* <p>To create a mount target for a file system, the file system's lifecycle state must be
* <code>available</code>. For more information, see <a>DescribeFileSystems</a>.</p>
* <p>In the request, provide the following:</p>
* <ul>
* <li>
* <p>The file system ID for which you are creating the mount
* target.</p>
* </li>
* <li>
* <p>A subnet ID, which determines the following:</p>
* <ul>
* <li>
* <p>The VPC in which Amazon EFS creates the mount target</p>
* </li>
* <li>
* <p>The Availability Zone in which Amazon EFS creates the mount target</p>
* </li>
* <li>
* <p>The IP address range from which Amazon EFS selects the IP address of the mount target
* (if you don't specify an IP address in the request)</p>
* </li>
* </ul>
* </li>
* </ul>
* <p>After creating the mount target, Amazon EFS returns a response that includes, a
* <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when
* mounting the file system in an EC2 instance. You can also use the mount target's DNS name
* when mounting the file system. The EC2 instance on which you mount the file system by using
* the mount target can resolve the mount target's DNS name to its IP address. For more
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation">How it Works:
* Implementation Overview</a>. </p>
* <p>Note that you can create mount targets for a file system in only one VPC, and there can
* be only one mount target per Availability Zone. That is, if the file system already has one or
* more mount targets created for it, the subnet specified in the request to add another mount
* target must meet the following requirements:</p>
* <ul>
* <li>
* <p>Must belong to the same VPC as the subnets of the existing mount targets</p>
* </li>
* <li>
* <p>Must not be in the same Availability Zone as any of the subnets of the existing
* mount targets</p>
* </li>
* </ul>
* <p>If the request satisfies the requirements, Amazon EFS does the following:</p>
* <ul>
* <li>
* <p>Creates a new mount target in the specified subnet.</p>
* </li>
* <li>
* <p>Also creates a new network interface in the subnet as follows:</p>
* <ul>
* <li>
* <p>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP
* address to the network interface. Otherwise, Amazon EFS assigns a free address in the
* subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call
* does when a request does not specify a primary private IP address).</p>
* </li>
* <li>
* <p>If the request provides <code>SecurityGroups</code>, this network interface is
* associated with those security groups. Otherwise, it belongs to the default security
* group for the subnet's VPC.</p>
* </li>
* <li>
* <p>Assigns the description <code>Mount target <i>fsmt-id</i> for
* file system <i>fs-id</i>
* </code> where <code>
* <i>fsmt-id</i>
* </code> is the mount target ID, and <code>
* <i>fs-id</i>
* </code> is the <code>FileSystemId</code>.</p>
* </li>
* <li>
* <p>Sets the <code>requesterManaged</code> property of the network interface to
* <code>true</code>, and the <code>requesterId</code> value to
* <code>EFS</code>.</p>
* </li>
* </ul>
* <p>Each Amazon EFS mount target has one corresponding requester-managed EC2 network
* interface. After the network interface is created, Amazon EFS sets the
* <code>NetworkInterfaceId</code> field in the mount target's description to the
* network interface ID, and the <code>IpAddress</code> field to its address. If network
* interface creation fails, the entire <code>CreateMountTarget</code> operation
* fails.</p>
* </li>
* </ul>
* <note>
* <p>The <code>CreateMountTarget</code> call returns only after creating the network
* interface, but while the mount target state is still <code>creating</code>, you can check
* the mount target creation status by calling the <a>DescribeMountTargets</a> operation, which among other things returns the mount
* target state.</p>
* </note>
* <p>We recommend that you create a mount target in each of the Availability Zones. There
* are cost considerations for using a file system in an Availability Zone through a mount target
* created in another Availability Zone. For more information, see <a href="http://aws.amazon.com/efs/">Amazon EFS</a>. In addition, by always using a mount target local to the
* instance's Availability Zone, you eliminate a partial failure scenario. If the
* Availability Zone in which your mount target is created goes down, then you can't access
* your file system through that mount target. </p>
* <p>This operation requires permissions for the following action on the file
* system:</p>
* <ul>
* <li>
* <p>
* <code>elasticfilesystem:CreateMountTarget</code>
* </p>
* </li>
* </ul>
* <p>This operation also requires permissions for the following Amazon EC2
* actions:</p>
* <ul>
* <li>
* <p>
* <code>ec2:DescribeSubnets</code>
* </p>
* </li>
* <li>
* <p>
* <code>ec2:DescribeNetworkInterfaces</code>
* </p>
* </li>
* <li>
* <p>
* <code>ec2:CreateNetworkInterface</code>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { EFSClient, CreateMountTargetCommand } from "@aws-sdk/client-efs"; // ES Modules import
* // const { EFSClient, CreateMountTargetCommand } = require("@aws-sdk/client-efs"); // CommonJS import
* const client = new EFSClient(config);
* const command = new CreateMountTargetCommand(input);
* const response = await client.send(command);
* ```
*
* @see {@link CreateMountTargetCommandInput} for command's `input` shape.
* @see {@link CreateMountTargetCommandOutput} for command's `response` shape.
* @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
*
*/
export class CreateMountTargetCommand extends $Command<
CreateMountTargetCommandInput,
CreateMountTargetCommandOutput,
EFSClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
constructor(readonly input: CreateMountTargetCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: EFSClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<CreateMountTargetCommandInput, CreateMountTargetCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, CreateMountTargetCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "EFSClient";
const commandName = "CreateMountTargetCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: CreateMountTargetRequestFilterSensitiveLog,
outputFilterSensitiveLog: MountTargetDescriptionFilterSensitiveLog,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
private serialize(input: CreateMountTargetCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return serializeAws_restJson1CreateMountTargetCommand(input, context);
}
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateMountTargetCommandOutput> {
return deserializeAws_restJson1CreateMountTargetCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}