@awboost/cfn-resource-types 0.1.387 → 0.1.389
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/AWS-CloudWatch-Alarm.d.ts +6 -6
- package/lib/AWS-EC2-TransitGatewayConnectPeer.d.ts +123 -0
- package/lib/AWS-EC2-TransitGatewayConnectPeer.js +12 -0
- package/lib/AWS-ECR-Repository.d.ts +29 -1
- package/lib/AWS-ECR-RepositoryCreationTemplate.d.ts +23 -1
- package/lib/AWS-ElasticLoadBalancingV2-Listener.d.ts +4 -3
- package/lib/AWS-ElasticLoadBalancingV2-ListenerRule.d.ts +2 -2
- package/lib/AWS-ElasticLoadBalancingV2-LoadBalancer.d.ts +1 -1
- package/lib/AWS-EntityResolution-MatchingWorkflow.d.ts +25 -0
- package/lib/AWS-Glue-Job.d.ts +1 -1
- package/lib/AWS-IoTSiteWise-ComputationModel.d.ts +172 -0
- package/lib/AWS-IoTSiteWise-ComputationModel.js +12 -0
- package/lib/AWS-Logs-Destination.d.ts +23 -0
- package/lib/AWS-Logs-LogGroup.d.ts +1 -0
- package/lib/AWS-MediaPackageV2-Channel.d.ts +5 -0
- package/lib/AWS-RDS-DBInstance.d.ts +27 -0
- package/lib/AWS-S3-AccessPoint.d.ts +19 -0
- package/lib/AWS-SSM-Parameter.d.ts +8 -6
- package/lib/AWS-SSM-Parameter.js +1 -1
- package/lib/AWS-SageMaker-Cluster.d.ts +114 -1
- package/lib/AWS-SageMaker-ProcessingJob.d.ts +586 -0
- package/lib/AWS-SageMaker-ProcessingJob.js +12 -0
- package/package.json +1 -1
|
@@ -0,0 +1,586 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
|
+
/**
|
|
4
|
+
* Resource Type definition for AWS::SageMaker::ProcessingJob
|
|
5
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
|
|
6
|
+
*/
|
|
7
|
+
export type SageMakerProcessingJobProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* Configures the processing job to run a specified Docker container image.
|
|
10
|
+
*/
|
|
11
|
+
AppSpecification: AppSpecification;
|
|
12
|
+
/**
|
|
13
|
+
* Sets the environment variables in the Docker container
|
|
14
|
+
*/
|
|
15
|
+
Environment?: Environment;
|
|
16
|
+
/**
|
|
17
|
+
* Associates a SageMaker job as a trial component with an experiment and trial.
|
|
18
|
+
*/
|
|
19
|
+
ExperimentConfig?: ExperimentConfig;
|
|
20
|
+
/**
|
|
21
|
+
* Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
|
|
22
|
+
*/
|
|
23
|
+
NetworkConfig?: NetworkConfig;
|
|
24
|
+
/**
|
|
25
|
+
* An array of inputs configuring the data to download into the processing container.
|
|
26
|
+
* @minLength `0`
|
|
27
|
+
* @maxLength `10`
|
|
28
|
+
*/
|
|
29
|
+
ProcessingInputs?: ProcessingInputsObject[];
|
|
30
|
+
/**
|
|
31
|
+
* The name of the processing job. The name must be unique within an AWS Region in the AWS account.
|
|
32
|
+
* @minLength `1`
|
|
33
|
+
* @maxLength `63`
|
|
34
|
+
* @pattern `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`
|
|
35
|
+
*/
|
|
36
|
+
ProcessingJobName?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Configuration for uploading output from the processing container.
|
|
39
|
+
*/
|
|
40
|
+
ProcessingOutputConfig?: ProcessingOutputConfig;
|
|
41
|
+
/**
|
|
42
|
+
* Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
|
|
43
|
+
*/
|
|
44
|
+
ProcessingResources: ProcessingResources;
|
|
45
|
+
/**
|
|
46
|
+
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
|
|
47
|
+
* @minLength `20`
|
|
48
|
+
* @maxLength `2048`
|
|
49
|
+
* @pattern `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
|
|
50
|
+
*/
|
|
51
|
+
RoleArn: string;
|
|
52
|
+
/**
|
|
53
|
+
* Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
|
|
54
|
+
*/
|
|
55
|
+
StoppingCondition?: StoppingCondition;
|
|
56
|
+
/**
|
|
57
|
+
* (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the AWS Billing and Cost Management User Guide.
|
|
58
|
+
* @maxLength `50`
|
|
59
|
+
*/
|
|
60
|
+
Tags?: Tag[];
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Attribute type definition for `AWS::SageMaker::ProcessingJob`.
|
|
64
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#aws-resource-sagemaker-processingjob-return-values}
|
|
65
|
+
*/
|
|
66
|
+
export type SageMakerProcessingJobAttributes = {
|
|
67
|
+
/**
|
|
68
|
+
* The ARN of an AutoML job associated with this processing job.
|
|
69
|
+
* @maxLength `256`
|
|
70
|
+
*/
|
|
71
|
+
AutoMLJobArn: string;
|
|
72
|
+
/**
|
|
73
|
+
* The time at which the processing job was created.
|
|
74
|
+
*/
|
|
75
|
+
CreationTime: string;
|
|
76
|
+
/**
|
|
77
|
+
* An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
|
|
78
|
+
* @maxLength `1024`
|
|
79
|
+
* @pattern `[\S\s]*`
|
|
80
|
+
*/
|
|
81
|
+
ExitMessage: string;
|
|
82
|
+
/**
|
|
83
|
+
* A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
|
|
84
|
+
* @maxLength `1024`
|
|
85
|
+
*/
|
|
86
|
+
FailureReason: string;
|
|
87
|
+
/**
|
|
88
|
+
* The time at which the processing job was last modified.
|
|
89
|
+
*/
|
|
90
|
+
LastModifiedTime: string;
|
|
91
|
+
/**
|
|
92
|
+
* The ARN of a monitoring schedule for an endpoint associated with this processing job.
|
|
93
|
+
* @maxLength `256`
|
|
94
|
+
*/
|
|
95
|
+
MonitoringScheduleArn: string;
|
|
96
|
+
/**
|
|
97
|
+
* The time at which the processing job completed.
|
|
98
|
+
*/
|
|
99
|
+
ProcessingEndTime: string;
|
|
100
|
+
/**
|
|
101
|
+
* The Amazon Resource Name (ARN) of the processing job.
|
|
102
|
+
* @minLength `0`
|
|
103
|
+
* @maxLength `256`
|
|
104
|
+
* @pattern `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*`
|
|
105
|
+
*/
|
|
106
|
+
ProcessingJobArn: string;
|
|
107
|
+
/**
|
|
108
|
+
* Provides the status of a processing job.
|
|
109
|
+
*/
|
|
110
|
+
ProcessingJobStatus: "Completed" | "InProgress" | "Stopping" | "Stopped" | "Failed";
|
|
111
|
+
/**
|
|
112
|
+
* The time at which the processing job started.
|
|
113
|
+
*/
|
|
114
|
+
ProcessingStartTime: string;
|
|
115
|
+
/**
|
|
116
|
+
* The ARN of a training job associated with this processing job
|
|
117
|
+
* @maxLength `256`
|
|
118
|
+
*/
|
|
119
|
+
TrainingJobArn: string;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.AppSpecification`.
|
|
123
|
+
* Configures the processing job to run a specified Docker container image.
|
|
124
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html}
|
|
125
|
+
*/
|
|
126
|
+
export type AppSpecification = {
|
|
127
|
+
/**
|
|
128
|
+
* The arguments for a container used to run a processing job.
|
|
129
|
+
* @minLength `1`
|
|
130
|
+
* @maxLength `100`
|
|
131
|
+
*/
|
|
132
|
+
ContainerArguments?: string[];
|
|
133
|
+
/**
|
|
134
|
+
* The entrypoint for a container used to run a processing job.
|
|
135
|
+
* @minLength `1`
|
|
136
|
+
* @maxLength `100`
|
|
137
|
+
*/
|
|
138
|
+
ContainerEntrypoint?: string[];
|
|
139
|
+
/**
|
|
140
|
+
* The container image to be run by the processing job.
|
|
141
|
+
* @minLength `0`
|
|
142
|
+
* @maxLength `256`
|
|
143
|
+
* @pattern `.*`
|
|
144
|
+
*/
|
|
145
|
+
ImageUri: string;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.AthenaDatasetDefinition`.
|
|
149
|
+
* Configuration for Athena Dataset Definition input.
|
|
150
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html}
|
|
151
|
+
*/
|
|
152
|
+
export type AthenaDatasetDefinition = {
|
|
153
|
+
/**
|
|
154
|
+
* The name of the data catalog used in Athena query execution.
|
|
155
|
+
* @maxLength `256`
|
|
156
|
+
*/
|
|
157
|
+
Catalog: string;
|
|
158
|
+
/**
|
|
159
|
+
* The name of the database used in the Athena query execution.
|
|
160
|
+
* @maxLength `255`
|
|
161
|
+
* @pattern `.*`
|
|
162
|
+
*/
|
|
163
|
+
Database: string;
|
|
164
|
+
/**
|
|
165
|
+
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
|
|
166
|
+
* @minLength `0`
|
|
167
|
+
* @maxLength `2048`
|
|
168
|
+
* @pattern `[a-zA-Z0-9:/_-]*`
|
|
169
|
+
*/
|
|
170
|
+
KmsKeyId?: string;
|
|
171
|
+
/**
|
|
172
|
+
* The compression used for Athena query results.
|
|
173
|
+
*/
|
|
174
|
+
OutputCompression?: "GZIP" | "SNAPPY" | "ZLIB";
|
|
175
|
+
/**
|
|
176
|
+
* The data storage format for Athena query results.
|
|
177
|
+
*/
|
|
178
|
+
OutputFormat: "PARQUET" | "AVRO" | "ORC" | "JSON" | "TEXTFILE";
|
|
179
|
+
/**
|
|
180
|
+
* The location in Amazon S3 where Athena query results are stored.
|
|
181
|
+
* @minLength `0`
|
|
182
|
+
* @maxLength `1024`
|
|
183
|
+
* @pattern `(https|s3)://([^/]+)/?(.*)`
|
|
184
|
+
*/
|
|
185
|
+
OutputS3Uri: string;
|
|
186
|
+
/**
|
|
187
|
+
* The SQL query statements, to be executed.
|
|
188
|
+
* @maxLength `4096`
|
|
189
|
+
* @pattern `[\s\S]+`
|
|
190
|
+
*/
|
|
191
|
+
QueryString: string;
|
|
192
|
+
/**
|
|
193
|
+
* The name of the workgroup in which the Athena query is being started.
|
|
194
|
+
* @maxLength `128`
|
|
195
|
+
* @pattern `[a-zA-Z0-9._-]+`
|
|
196
|
+
*/
|
|
197
|
+
WorkGroup?: string;
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ClusterConfig`.
|
|
201
|
+
* Configuration for the cluster used to run a processing job.
|
|
202
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html}
|
|
203
|
+
*/
|
|
204
|
+
export type ClusterConfig = {
|
|
205
|
+
/**
|
|
206
|
+
* The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
|
|
207
|
+
* @min `1`
|
|
208
|
+
* @max `100`
|
|
209
|
+
*/
|
|
210
|
+
InstanceCount: number;
|
|
211
|
+
/**
|
|
212
|
+
* The ML compute instance type for the processing job.
|
|
213
|
+
*/
|
|
214
|
+
InstanceType: "ml.t3.medium" | "ml.t3.large" | "ml.t3.xlarge" | "ml.t3.2xlarge" | "ml.m4.xlarge" | "ml.m4.2xlarge" | "ml.m4.4xlarge" | "ml.m4.10xlarge" | "ml.m4.16xlarge" | "ml.c4.xlarge" | "ml.c4.2xlarge" | "ml.c4.4xlarge" | "ml.c4.8xlarge" | "ml.c5.xlarge" | "ml.c5.2xlarge" | "ml.c5.4xlarge" | "ml.c5.9xlarge" | "ml.c5.18xlarge" | "ml.m5.large" | "ml.m5.xlarge" | "ml.m5.2xlarge" | "ml.m5.4xlarge" | "ml.m5.12xlarge" | "ml.m5.24xlarge" | "ml.r5.large" | "ml.r5.xlarge" | "ml.r5.2xlarge" | "ml.r5.4xlarge" | "ml.r5.8xlarge" | "ml.r5.12xlarge" | "ml.r5.16xlarge" | "ml.r5.24xlarge" | "ml.g4dn.xlarge" | "ml.g4dn.2xlarge" | "ml.g4dn.4xlarge" | "ml.g4dn.8xlarge" | "ml.g4dn.12xlarge" | "ml.g4dn.16xlarge" | "ml.g5.xlarge" | "ml.g5.2xlarge" | "ml.g5.4xlarge" | "ml.g5.8xlarge" | "ml.g5.16xlarge" | "ml.g5.12xlarge" | "ml.g5.24xlarge" | "ml.g5.48xlarge" | "ml.r5d.large" | "ml.r5d.xlarge" | "ml.r5d.2xlarge" | "ml.r5d.4xlarge" | "ml.r5d.8xlarge" | "ml.r5d.12xlarge" | "ml.r5d.16xlarge" | "ml.r5d.24xlarge" | "ml.g6.xlarge" | "ml.g6.2xlarge" | "ml.g6.4xlarge" | "ml.g6.8xlarge" | "ml.g6.12xlarge" | "ml.g6.16xlarge" | "ml.g6.24xlarge" | "ml.g6.48xlarge" | "ml.g6e.xlarge" | "ml.g6e.2xlarge" | "ml.g6e.4xlarge" | "ml.g6e.8xlarge" | "ml.g6e.12xlarge" | "ml.g6e.16xlarge" | "ml.g6e.24xlarge" | "ml.g6e.48xlarge" | "ml.m6i.large" | "ml.m6i.xlarge" | "ml.m6i.2xlarge" | "ml.m6i.4xlarge" | "ml.m6i.8xlarge" | "ml.m6i.12xlarge" | "ml.m6i.16xlarge" | "ml.m6i.24xlarge" | "ml.m6i.32xlarge" | "ml.c6i.xlarge" | "ml.c6i.2xlarge" | "ml.c6i.4xlarge" | "ml.c6i.8xlarge" | "ml.c6i.12xlarge" | "ml.c6i.16xlarge" | "ml.c6i.24xlarge" | "ml.c6i.32xlarge" | "ml.m7i.large" | "ml.m7i.xlarge" | "ml.m7i.2xlarge" | "ml.m7i.4xlarge" | "ml.m7i.8xlarge" | "ml.m7i.12xlarge" | "ml.m7i.16xlarge" | "ml.m7i.24xlarge" | "ml.m7i.48xlarge" | "ml.c7i.large" | "ml.c7i.xlarge" | "ml.c7i.2xlarge" | "ml.c7i.4xlarge" | "ml.c7i.8xlarge" | "ml.c7i.12xlarge" | "ml.c7i.16xlarge" | "ml.c7i.24xlarge" | "ml.c7i.48xlarge" | "ml.r7i.large" | "ml.r7i.xlarge" | "ml.r7i.2xlarge" | "ml.r7i.4xlarge" | "ml.r7i.8xlarge" | "ml.r7i.12xlarge" | "ml.r7i.16xlarge" | "ml.r7i.24xlarge" | "ml.r7i.48xlarge";
|
|
215
|
+
/**
|
|
216
|
+
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
|
|
217
|
+
* @minLength `0`
|
|
218
|
+
* @maxLength `2048`
|
|
219
|
+
* @pattern `[a-zA-Z0-9:/_-]*`
|
|
220
|
+
*/
|
|
221
|
+
VolumeKmsKeyId?: string;
|
|
222
|
+
/**
|
|
223
|
+
* The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
|
|
224
|
+
* @min `1`
|
|
225
|
+
* @max `16384`
|
|
226
|
+
*/
|
|
227
|
+
VolumeSizeInGB: number;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.DatasetDefinition`.
|
|
231
|
+
* Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either `AthenaDatasetDefinition` or `RedshiftDatasetDefinition` types.
|
|
232
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html}
|
|
233
|
+
*/
|
|
234
|
+
export type DatasetDefinition = {
|
|
235
|
+
/**
|
|
236
|
+
* Configuration for Athena Dataset Definition input.
|
|
237
|
+
*/
|
|
238
|
+
AthenaDatasetDefinition?: AthenaDatasetDefinition;
|
|
239
|
+
/**
|
|
240
|
+
* Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
|
|
241
|
+
*/
|
|
242
|
+
DataDistributionType?: "FullyReplicated" | "ShardedByS3Key";
|
|
243
|
+
/**
|
|
244
|
+
* Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
|
|
245
|
+
*/
|
|
246
|
+
InputMode?: "File" | "Pipe";
|
|
247
|
+
/**
|
|
248
|
+
* The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).
|
|
249
|
+
* @minLength `0`
|
|
250
|
+
* @maxLength `256`
|
|
251
|
+
* @pattern `.*`
|
|
252
|
+
*/
|
|
253
|
+
LocalPath?: string;
|
|
254
|
+
/**
|
|
255
|
+
* Configuration for Redshift Dataset Definition input.
|
|
256
|
+
*/
|
|
257
|
+
RedshiftDatasetDefinition?: RedshiftDatasetDefinition;
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.Environment`.
|
|
261
|
+
* Sets the environment variables in the Docker container
|
|
262
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-environment.html}
|
|
263
|
+
*/
|
|
264
|
+
export type Environment = Record<string, string>;
|
|
265
|
+
/**
|
|
266
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ExperimentConfig`.
|
|
267
|
+
* Associates a SageMaker job as a trial component with an experiment and trial.
|
|
268
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html}
|
|
269
|
+
*/
|
|
270
|
+
export type ExperimentConfig = {
|
|
271
|
+
/**
|
|
272
|
+
* The name of an existing experiment to associate with the trial component.
|
|
273
|
+
* @maxLength `120`
|
|
274
|
+
* @pattern `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}`
|
|
275
|
+
*/
|
|
276
|
+
ExperimentName?: string;
|
|
277
|
+
/**
|
|
278
|
+
* The name of the experiment run to associate with the trial component.
|
|
279
|
+
* @maxLength `120`
|
|
280
|
+
* @pattern `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}`
|
|
281
|
+
*/
|
|
282
|
+
RunName?: string;
|
|
283
|
+
/**
|
|
284
|
+
* The display name for the trial component. If this key isn't specified, the display name is the trial component name.
|
|
285
|
+
* @maxLength `120`
|
|
286
|
+
* @pattern `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}`
|
|
287
|
+
*/
|
|
288
|
+
TrialComponentDisplayName?: string;
|
|
289
|
+
/**
|
|
290
|
+
* The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
|
|
291
|
+
* @maxLength `120`
|
|
292
|
+
* @pattern `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}`
|
|
293
|
+
*/
|
|
294
|
+
TrialName?: string;
|
|
295
|
+
};
|
|
296
|
+
/**
|
|
297
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.FeatureStoreOutput`.
|
|
298
|
+
* Configuration for processing job outputs in Amazon SageMaker Feature Store.
|
|
299
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-featurestoreoutput.html}
|
|
300
|
+
*/
|
|
301
|
+
export type FeatureStoreOutput = {
|
|
302
|
+
/**
|
|
303
|
+
* The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.
|
|
304
|
+
* @maxLength `64`
|
|
305
|
+
* @pattern `[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}`
|
|
306
|
+
*/
|
|
307
|
+
FeatureGroupName: string;
|
|
308
|
+
};
|
|
309
|
+
/**
|
|
310
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.NetworkConfig`.
|
|
311
|
+
* Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
|
|
312
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html}
|
|
313
|
+
*/
|
|
314
|
+
export type NetworkConfig = {
|
|
315
|
+
/**
|
|
316
|
+
* Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
|
|
317
|
+
*/
|
|
318
|
+
EnableInterContainerTrafficEncryption?: boolean;
|
|
319
|
+
/**
|
|
320
|
+
* Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
|
|
321
|
+
*/
|
|
322
|
+
EnableNetworkIsolation?: boolean;
|
|
323
|
+
/**
|
|
324
|
+
* Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
|
|
325
|
+
*/
|
|
326
|
+
VpcConfig?: VpcConfig;
|
|
327
|
+
};
|
|
328
|
+
/**
|
|
329
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ProcessingInputsObject`.
|
|
330
|
+
* The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
|
|
331
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html}
|
|
332
|
+
*/
|
|
333
|
+
export type ProcessingInputsObject = {
|
|
334
|
+
/**
|
|
335
|
+
* When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
|
|
336
|
+
*/
|
|
337
|
+
AppManaged?: boolean;
|
|
338
|
+
/**
|
|
339
|
+
* Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either `AthenaDatasetDefinition` or `RedshiftDatasetDefinition` types.
|
|
340
|
+
*/
|
|
341
|
+
DatasetDefinition?: DatasetDefinition;
|
|
342
|
+
/**
|
|
343
|
+
* The name for the processing job input.
|
|
344
|
+
*/
|
|
345
|
+
InputName: string;
|
|
346
|
+
/**
|
|
347
|
+
* Configuration for downloading input data from Amazon S3 into the processing container.
|
|
348
|
+
*/
|
|
349
|
+
S3Input?: S3Input;
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ProcessingOutputConfig`.
|
|
353
|
+
* Configuration for uploading output from the processing container.
|
|
354
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputconfig.html}
|
|
355
|
+
*/
|
|
356
|
+
export type ProcessingOutputConfig = {
|
|
357
|
+
/**
|
|
358
|
+
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
|
|
359
|
+
* @maxLength `2048`
|
|
360
|
+
* @pattern `[a-zA-Z0-9:/_-]*`
|
|
361
|
+
*/
|
|
362
|
+
KmsKeyId?: string;
|
|
363
|
+
/**
|
|
364
|
+
* An array of outputs configuring the data to upload from the processing container.
|
|
365
|
+
* @maxLength `10`
|
|
366
|
+
*/
|
|
367
|
+
Outputs: ProcessingOutputsObject[];
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ProcessingOutputsObject`.
|
|
371
|
+
* Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
|
|
372
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html}
|
|
373
|
+
*/
|
|
374
|
+
export type ProcessingOutputsObject = {
|
|
375
|
+
/**
|
|
376
|
+
* When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
|
|
377
|
+
*/
|
|
378
|
+
AppManaged?: boolean;
|
|
379
|
+
/**
|
|
380
|
+
* Configuration for processing job outputs in Amazon SageMaker Feature Store.
|
|
381
|
+
*/
|
|
382
|
+
FeatureStoreOutput?: FeatureStoreOutput;
|
|
383
|
+
/**
|
|
384
|
+
* The name for the processing job output.
|
|
385
|
+
*/
|
|
386
|
+
OutputName: string;
|
|
387
|
+
/**
|
|
388
|
+
* Configuration for uploading output data to Amazon S3 from the processing container.
|
|
389
|
+
*/
|
|
390
|
+
S3Output?: S3Output;
|
|
391
|
+
};
|
|
392
|
+
/**
|
|
393
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.ProcessingResources`.
|
|
394
|
+
* Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
|
|
395
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingresources.html}
|
|
396
|
+
*/
|
|
397
|
+
export type ProcessingResources = {
|
|
398
|
+
/**
|
|
399
|
+
* Configuration for the cluster used to run a processing job.
|
|
400
|
+
*/
|
|
401
|
+
ClusterConfig: ClusterConfig;
|
|
402
|
+
};
|
|
403
|
+
/**
|
|
404
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.RedshiftDatasetDefinition`.
|
|
405
|
+
* Configuration for Redshift Dataset Definition input.
|
|
406
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html}
|
|
407
|
+
*/
|
|
408
|
+
export type RedshiftDatasetDefinition = {
|
|
409
|
+
/**
|
|
410
|
+
* The Redshift cluster Identifier.
|
|
411
|
+
* @maxLength `63`
|
|
412
|
+
* @pattern `.*`
|
|
413
|
+
*/
|
|
414
|
+
ClusterId: string;
|
|
415
|
+
/**
|
|
416
|
+
* The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
|
|
417
|
+
* @minLength `20`
|
|
418
|
+
* @maxLength `2048`
|
|
419
|
+
* @pattern `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
|
|
420
|
+
*/
|
|
421
|
+
ClusterRoleArn: string;
|
|
422
|
+
/**
|
|
423
|
+
* The name of the Redshift database used in Redshift query execution.
|
|
424
|
+
* @maxLength `64`
|
|
425
|
+
* @pattern `.*`
|
|
426
|
+
*/
|
|
427
|
+
Database: string;
|
|
428
|
+
/**
|
|
429
|
+
* The database user name used in Redshift query execution.
|
|
430
|
+
* @maxLength `128`
|
|
431
|
+
* @pattern `.*`
|
|
432
|
+
*/
|
|
433
|
+
DbUser: string;
|
|
434
|
+
/**
|
|
435
|
+
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
|
|
436
|
+
* @minLength `0`
|
|
437
|
+
* @maxLength `2048`
|
|
438
|
+
* @pattern `[a-zA-Z0-9:/_-]*`
|
|
439
|
+
*/
|
|
440
|
+
KmsKeyId?: string;
|
|
441
|
+
/**
|
|
442
|
+
* The compression used for Redshift query results.
|
|
443
|
+
*/
|
|
444
|
+
OutputCompression?: "None" | "GZIP" | "SNAPPY" | "ZSTD" | "BZIP2";
|
|
445
|
+
/**
|
|
446
|
+
* The data storage format for Redshift query results.
|
|
447
|
+
*/
|
|
448
|
+
OutputFormat: "PARQUET" | "CSV";
|
|
449
|
+
/**
|
|
450
|
+
* The location in Amazon S3 where the Redshift query results are stored.
|
|
451
|
+
* @minLength `0`
|
|
452
|
+
* @maxLength `1024`
|
|
453
|
+
* @pattern `(https|s3)://([^/]+)/?(.*)`
|
|
454
|
+
*/
|
|
455
|
+
OutputS3Uri: string;
|
|
456
|
+
/**
|
|
457
|
+
* The SQL query statements to be executed.
|
|
458
|
+
* @maxLength `4096`
|
|
459
|
+
* @pattern `[\s\S]+`
|
|
460
|
+
*/
|
|
461
|
+
QueryString: string;
|
|
462
|
+
};
|
|
463
|
+
/**
|
|
464
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.S3Input`.
|
|
465
|
+
* Configuration for downloading input data from Amazon S3 into the processing container.
|
|
466
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html}
|
|
467
|
+
*/
|
|
468
|
+
export type S3Input = {
|
|
469
|
+
/**
|
|
470
|
+
* The local path in your container where you want Amazon SageMaker to write input data to. `LocalPath` is an absolute path to the input data and must begin with `/opt/ml/processing/`. LocalPath is a required parameter when `AppManaged` is `False` (default).
|
|
471
|
+
* @minLength `0`
|
|
472
|
+
* @maxLength `256`
|
|
473
|
+
* @pattern `.*`
|
|
474
|
+
*/
|
|
475
|
+
LocalPath?: string;
|
|
476
|
+
/**
|
|
477
|
+
* Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. `Gzip` can only be used when `Pipe` mode is specified as the `S3InputMode`. In `Pipe` mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
|
|
478
|
+
*/
|
|
479
|
+
S3CompressionType?: "None" | "Gzip";
|
|
480
|
+
/**
|
|
481
|
+
* Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
|
|
482
|
+
*/
|
|
483
|
+
S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key";
|
|
484
|
+
/**
|
|
485
|
+
* Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
|
|
486
|
+
*/
|
|
487
|
+
S3DataType: "ManifestFile" | "S3Prefix";
|
|
488
|
+
/**
|
|
489
|
+
* Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
|
|
490
|
+
*/
|
|
491
|
+
S3InputMode?: "File" | "Pipe";
|
|
492
|
+
/**
|
|
493
|
+
* The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
|
|
494
|
+
* @minLength `0`
|
|
495
|
+
* @maxLength `1024`
|
|
496
|
+
* @pattern `(https|s3)://([^/]+)/?(.*)`
|
|
497
|
+
*/
|
|
498
|
+
S3Uri: string;
|
|
499
|
+
};
|
|
500
|
+
/**
|
|
501
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.S3Output`.
|
|
502
|
+
* Configuration for uploading output data to Amazon S3 from the processing container.
|
|
503
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3output.html}
|
|
504
|
+
*/
|
|
505
|
+
export type S3Output = {
|
|
506
|
+
/**
|
|
507
|
+
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.
|
|
508
|
+
* @minLength `0`
|
|
509
|
+
* @maxLength `256`
|
|
510
|
+
* @pattern `.*`
|
|
511
|
+
*/
|
|
512
|
+
LocalPath?: string;
|
|
513
|
+
/**
|
|
514
|
+
* Whether to upload the results of the processing job continuously or after the job completes.
|
|
515
|
+
*/
|
|
516
|
+
S3UploadMode: "Continuous" | "EndOfJob";
|
|
517
|
+
/**
|
|
518
|
+
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
|
|
519
|
+
* @minLength `0`
|
|
520
|
+
* @maxLength `1024`
|
|
521
|
+
* @pattern `(https|s3)://([^/]+)/?(.*)`
|
|
522
|
+
*/
|
|
523
|
+
S3Uri: string;
|
|
524
|
+
};
|
|
525
|
+
/**
|
|
526
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.StoppingCondition`.
|
|
527
|
+
* Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
|
|
528
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-stoppingcondition.html}
|
|
529
|
+
*/
|
|
530
|
+
export type StoppingCondition = {
|
|
531
|
+
/**
|
|
532
|
+
* Specifies the maximum runtime in seconds.
|
|
533
|
+
* @min `1`
|
|
534
|
+
* @max `777600`
|
|
535
|
+
*/
|
|
536
|
+
MaxRuntimeInSeconds: number;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.Tag`.
|
|
540
|
+
* A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.
|
|
541
|
+
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).
|
|
542
|
+
For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources(https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html). For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy(https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).
|
|
543
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-tag.html}
|
|
544
|
+
*/
|
|
545
|
+
export type Tag = {
|
|
546
|
+
/**
|
|
547
|
+
* The tag key. Tag keys must be unique per resource.
|
|
548
|
+
* @maxLength `128`
|
|
549
|
+
* @pattern `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
|
|
550
|
+
*/
|
|
551
|
+
Key: string;
|
|
552
|
+
/**
|
|
553
|
+
* The tag value.
|
|
554
|
+
* @maxLength `256`
|
|
555
|
+
* @pattern `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
|
|
556
|
+
*/
|
|
557
|
+
Value: string;
|
|
558
|
+
};
|
|
559
|
+
/**
|
|
560
|
+
* Type definition for `AWS::SageMaker::ProcessingJob.VpcConfig`.
|
|
561
|
+
* Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
|
|
562
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html}
|
|
563
|
+
*/
|
|
564
|
+
export type VpcConfig = {
|
|
565
|
+
/**
|
|
566
|
+
* The VPC security group IDs, in the form 'sg-xxxxxxxx'. Specify the security groups for the VPC that is specified in the 'Subnets' field.
|
|
567
|
+
* @minLength `1`
|
|
568
|
+
* @maxLength `5`
|
|
569
|
+
*/
|
|
570
|
+
SecurityGroupIds: string[];
|
|
571
|
+
/**
|
|
572
|
+
* The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see https://docs.aws.amazon.com/sagemaker/latest/dg/regions-quotas.html
|
|
573
|
+
* @minLength `1`
|
|
574
|
+
* @maxLength `16`
|
|
575
|
+
*/
|
|
576
|
+
Subnets: string[];
|
|
577
|
+
};
|
|
578
|
+
/**
|
|
579
|
+
* Resource Type definition for AWS::SageMaker::ProcessingJob
|
|
580
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
|
|
581
|
+
*/
|
|
582
|
+
export declare class SageMakerProcessingJob extends $Resource<"AWS::SageMaker::ProcessingJob", SageMakerProcessingJobProperties, SageMakerProcessingJobAttributes> {
|
|
583
|
+
static readonly Type = "AWS::SageMaker::ProcessingJob";
|
|
584
|
+
constructor(logicalId: string, properties: SageMakerProcessingJobProperties, options?: $ResourceOptions);
|
|
585
|
+
}
|
|
586
|
+
//# sourceMappingURL=AWS-SageMaker-ProcessingJob.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
/**
|
|
3
|
+
* Resource Type definition for AWS::SageMaker::ProcessingJob
|
|
4
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
|
|
5
|
+
*/
|
|
6
|
+
export class SageMakerProcessingJob extends $Resource {
|
|
7
|
+
static Type = "AWS::SageMaker::ProcessingJob";
|
|
8
|
+
constructor(logicalId, properties, options) {
|
|
9
|
+
super(logicalId, SageMakerProcessingJob.Type, properties, options);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=AWS-SageMaker-ProcessingJob.js.map
|