@propulsionworks/cloudformation 0.1.20 → 0.1.22
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/out/exports/resources.generated/aws-apigateway-deployment.d.ts +1 -1
- package/out/exports/resources.generated/aws-appconfig-configurationprofile.d.ts +3 -3
- package/out/exports/resources.generated/aws-appconfig-deployment.d.ts +5 -0
- package/out/exports/resources.generated/aws-appintegrations-application.d.ts +52 -0
- package/out/exports/resources.generated/aws-aps-resourcepolicy.d.ts +22 -0
- package/out/exports/resources.generated/aws-arcregionswitch-plan.d.ts +132 -0
- package/out/exports/resources.generated/aws-athena-datacatalog.d.ts +15 -6
- package/out/exports/resources.generated/aws-athena-workgroup.d.ts +3 -3
- package/out/exports/resources.generated/aws-batch-jobdefinition.d.ts +2 -2
- package/out/exports/resources.generated/aws-batch-jobqueue.d.ts +7 -0
- package/out/exports/resources.generated/aws-batch-serviceenvironment.d.ts +1 -1
- package/out/exports/resources.generated/aws-billingconductor-customlineitem.d.ts +2 -2
- package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +4 -0
- package/out/exports/resources.generated/aws-codebuild-project.d.ts +17 -0
- package/out/exports/resources.generated/aws-codepipeline-webhook.d.ts +1 -0
- package/out/exports/resources.generated/aws-connect-user.d.ts +5 -0
- package/out/exports/resources.generated/aws-deadline-fleet.d.ts +16 -0
- package/out/exports/resources.generated/aws-deadline-monitor.d.ts +6 -1
- package/out/exports/resources.generated/aws-docdb-dbcluster.d.ts +5 -1
- package/out/exports/resources.generated/aws-dynamodb-globaltable.d.ts +4 -0
- package/out/exports/resources.generated/aws-dynamodb-table.d.ts +4 -0
- package/out/exports/resources.generated/aws-ec2-ec2fleet.d.ts +1 -1
- package/out/exports/resources.generated/aws-ec2-ippoolroutetableassociation.d.ts +33 -0
- package/out/exports/resources.generated/aws-ec2-launchtemplate.d.ts +7 -53
- package/out/exports/resources.generated/aws-ec2-natgateway.d.ts +1 -1
- package/out/exports/resources.generated/aws-ec2-transitgatewayconnectpeer.d.ts +5 -4
- package/out/exports/resources.generated/aws-ec2-volume.d.ts +2 -0
- package/out/exports/resources.generated/aws-ecr-repository.d.ts +2 -0
- package/out/exports/resources.generated/aws-ecr-repositorycreationtemplate.d.ts +2 -2
- package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +0 -2
- package/out/exports/resources.generated/aws-eks-addon.d.ts +10 -0
- package/out/exports/resources.generated/aws-eks-cluster.d.ts +5 -0
- package/out/exports/resources.generated/aws-elasticloadbalancingv2-loadbalancer.d.ts +2 -1
- package/out/exports/resources.generated/aws-entityresolution-matchingworkflow.d.ts +16 -0
- package/out/exports/resources.generated/aws-evs-environment.d.ts +1 -9
- package/out/exports/resources.generated/aws-fsx-filesystem.d.ts +8 -0
- package/out/exports/resources.generated/aws-glue-job.d.ts +19 -8
- package/out/exports/resources.generated/aws-glue-tableoptimizer.d.ts +18 -1
- package/out/exports/resources.generated/aws-guardduty-threatentityset.d.ts +89 -0
- package/out/exports/resources.generated/aws-guardduty-trustedentityset.d.ts +89 -0
- package/out/exports/resources.generated/aws-imagebuilder-component.d.ts +1 -1
- package/out/exports/resources.generated/aws-imagebuilder-containerrecipe.d.ts +2 -2
- package/out/exports/resources.generated/aws-imagebuilder-distributionconfiguration.d.ts +1 -1
- package/out/exports/resources.generated/aws-imagebuilder-imagerecipe.d.ts +4 -2
- package/out/exports/resources.generated/aws-imagebuilder-workflow.d.ts +1 -1
- package/out/exports/resources.generated/aws-inspectorv2-codesecurityintegration.d.ts +160 -0
- package/out/exports/resources.generated/aws-inspectorv2-codesecurityscanconfiguration.d.ts +121 -0
- package/out/exports/resources.generated/aws-iot-mitigationaction.d.ts +2 -2
- package/out/exports/resources.generated/aws-iotsitewise-assetmodel.d.ts +46 -2
- package/out/exports/resources.generated/aws-ivs-playbackrestrictionpolicy.d.ts +2 -2
- package/out/exports/resources.generated/aws-ivs-stage.d.ts +54 -0
- package/out/exports/resources.generated/aws-kinesisfirehose-deliverystream.d.ts +1 -1
- package/out/exports/resources.generated/aws-lambda-permission.d.ts +2 -2
- package/out/exports/resources.generated/aws-lambda-url.d.ts +1 -1
- package/out/exports/resources.generated/aws-lambda-version.d.ts +1 -1
- package/out/exports/resources.generated/aws-logs-destination.d.ts +1 -1
- package/out/exports/resources.generated/aws-mediapackagev2-originendpoint.d.ts +18 -0
- package/out/exports/resources.generated/aws-networkfirewall-firewall.d.ts +36 -6
- package/out/exports/resources.generated/aws-networkfirewall-firewallpolicy.d.ts +16 -9
- package/out/exports/resources.generated/aws-networkfirewall-loggingconfiguration.d.ts +8 -8
- package/out/exports/resources.generated/aws-networkfirewall-rulegroup.d.ts +36 -22
- package/out/exports/resources.generated/aws-networkfirewall-vpcendpointassociation.d.ts +3 -3
- package/out/exports/resources.generated/aws-observabilityadmin-organizationtelemetryrule.d.ts +137 -0
- package/out/exports/resources.generated/aws-observabilityadmin-telemetryrule.d.ts +132 -0
- package/out/exports/resources.generated/aws-omics-workflowversion.d.ts +2 -2
- package/out/exports/resources.generated/aws-opensearchservice-domain.d.ts +21 -0
- package/out/exports/resources.generated/aws-opsworks-app.d.ts +4 -4
- package/out/exports/resources.generated/aws-opsworks-elasticloadbalancerattachment.d.ts +1 -1
- package/out/exports/resources.generated/aws-opsworks-instance.d.ts +14 -14
- package/out/exports/resources.generated/aws-opsworks-layer.d.ts +8 -8
- package/out/exports/resources.generated/aws-opsworks-stack.d.ts +25 -25
- package/out/exports/resources.generated/aws-opsworkscm-server.d.ts +2 -2
- package/out/exports/resources.generated/aws-pcs-cluster.d.ts +4 -0
- package/out/exports/resources.generated/aws-qbusiness-webexperience.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-dataset.d.ts +6 -6
- package/out/exports/resources.generated/aws-rds-dbcluster.d.ts +5 -0
- package/out/exports/resources.generated/aws-rds-dbinstance.d.ts +4 -29
- package/out/exports/resources.generated/aws-rds-dbproxy.d.ts +2 -2
- package/out/exports/resources.generated/aws-s3-accesspoint.d.ts +1 -1
- package/out/exports/resources.generated/aws-s3express-accesspoint.d.ts +1 -0
- package/out/exports/resources.generated/aws-s3tables-tablebucketpolicy.d.ts +2 -2
- package/out/exports/resources.generated/aws-s3tables-tablepolicy.d.ts +2 -2
- package/out/exports/resources.generated/aws-sagemaker-cluster.d.ts +101 -2
- package/out/exports/resources.generated/aws-sagemaker-domain.d.ts +0 -6
- package/out/exports/resources.generated/aws-sagemaker-processingjob.d.ts +72 -46
- package/out/exports/resources.generated/aws-sqs-queue.d.ts +2 -1
- package/out/exports/resources.generated/aws-synthetics-canary.d.ts +28 -0
- package/out/exports/resources.generated/aws-verifiedpermissions-policystore.d.ts +3 -5
- package/out/exports/resources.generated/aws-workspacesweb-portal.d.ts +7 -0
- package/out/exports/resources.generated/aws-workspacesweb-sessionlogger.d.ts +125 -0
- package/package.json +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { ResourceDefinition, PolicyDocument } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
* Creates a new
|
|
3
|
+
* Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see [Adding a table bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add) in the *Amazon Simple Storage Service User Guide* .
|
|
4
4
|
*
|
|
5
5
|
* - **Permissions** - You must have the `s3tables:PutTableBucketPolicy` permission to use this operation.
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html}
|
|
7
7
|
*/
|
|
8
8
|
export type S3TablesTableBucketPolicy = ResourceDefinition<"AWS::S3Tables::TableBucketPolicy", S3TablesTableBucketPolicyProps>;
|
|
9
9
|
/**
|
|
10
|
-
* Creates a new
|
|
10
|
+
* Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see [Adding a table bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add) in the *Amazon Simple Storage Service User Guide* .
|
|
11
11
|
*
|
|
12
12
|
* - **Permissions** - You must have the `s3tables:PutTableBucketPolicy` permission to use this operation.
|
|
13
13
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
* Creates a new
|
|
3
|
+
* Creates a new table policy or replaces an existing table policy for a table. For more information, see [Adding a table policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add) in the *Amazon Simple Storage Service User Guide* .
|
|
4
4
|
*
|
|
5
5
|
* - **Permissions** - You must have the `s3tables:PutTablePolicy` permission to use this operation.
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html}
|
|
7
7
|
*/
|
|
8
8
|
export type S3TablesTablePolicy = ResourceDefinitionWithAttributes<"AWS::S3Tables::TablePolicy", S3TablesTablePolicyProps, S3TablesTablePolicyAttribs>;
|
|
9
9
|
/**
|
|
10
|
-
* Creates a new
|
|
10
|
+
* Creates a new table policy or replaces an existing table policy for a table. For more information, see [Adding a table policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add) in the *Amazon Simple Storage Service User Guide* .
|
|
11
11
|
*
|
|
12
12
|
* - **Permissions** - You must have the `s3tables:PutTablePolicy` permission to use this operation.
|
|
13
13
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html}
|
|
@@ -22,6 +22,11 @@ export type SageMakerClusterProps = {
|
|
|
22
22
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups}
|
|
23
23
|
*/
|
|
24
24
|
InstanceGroups?: ClusterInstanceGroup[] | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* Determines the scaling strategy for the SageMaker HyperPod cluster. When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.
|
|
27
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode}
|
|
28
|
+
*/
|
|
29
|
+
NodeProvisioningMode?: "Continuous" | undefined;
|
|
25
30
|
/**
|
|
26
31
|
* Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values are `Automatic` for enabling and `None` for disabling.
|
|
27
32
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery}
|
|
@@ -79,6 +84,38 @@ export type SageMakerClusterAttribs = {
|
|
|
79
84
|
*/
|
|
80
85
|
FailureMessage: string;
|
|
81
86
|
};
|
|
87
|
+
/**
|
|
88
|
+
* The details of the alarm to monitor during the AMI update.
|
|
89
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-alarmdetails.html}
|
|
90
|
+
*/
|
|
91
|
+
export type AlarmDetails = {
|
|
92
|
+
/**
|
|
93
|
+
* The name of the alarm.
|
|
94
|
+
* @minLength 1
|
|
95
|
+
* @maxLength 256
|
|
96
|
+
* @pattern (?!\s*$).+
|
|
97
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-alarmdetails.html#cfn-sagemaker-cluster-alarmdetails-alarmname}
|
|
98
|
+
*/
|
|
99
|
+
AlarmName: string;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.
|
|
103
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html}
|
|
104
|
+
*/
|
|
105
|
+
export type CapacitySizeConfig = {
|
|
106
|
+
/**
|
|
107
|
+
* Specifies whether SageMaker should process the update by amount or percentage of instances.
|
|
108
|
+
* @pattern INSTANCE_COUNT|CAPACITY_PERCENTAGE
|
|
109
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html#cfn-sagemaker-cluster-capacitysizeconfig-type}
|
|
110
|
+
*/
|
|
111
|
+
Type: string;
|
|
112
|
+
/**
|
|
113
|
+
* Specifies the amount or percentage of instances SageMaker updates at a time.
|
|
114
|
+
* @min 1
|
|
115
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html#cfn-sagemaker-cluster-capacitysizeconfig-value}
|
|
116
|
+
*/
|
|
117
|
+
Value: number;
|
|
118
|
+
};
|
|
82
119
|
/**
|
|
83
120
|
* Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620) .
|
|
84
121
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html}
|
|
@@ -102,6 +139,11 @@ export type ClusterInstanceGroup = {
|
|
|
102
139
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole}
|
|
103
140
|
*/
|
|
104
141
|
ExecutionRole: string;
|
|
142
|
+
/**
|
|
143
|
+
* AMI Id to be used for launching EC2 instances - HyperPodPublicAmiId or CustomAmiId
|
|
144
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-imageid}
|
|
145
|
+
*/
|
|
146
|
+
ImageId?: string | undefined;
|
|
105
147
|
/**
|
|
106
148
|
* The number of instances in an instance group of the SageMaker HyperPod cluster.
|
|
107
149
|
* @min 0
|
|
@@ -138,6 +180,10 @@ export type ClusterInstanceGroup = {
|
|
|
138
180
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-overridevpcconfig}
|
|
139
181
|
*/
|
|
140
182
|
OverrideVpcConfig?: VpcConfig | undefined;
|
|
183
|
+
/**
|
|
184
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-scheduledupdateconfig}
|
|
185
|
+
*/
|
|
186
|
+
ScheduledUpdateConfig?: ScheduledUpdateConfig | undefined;
|
|
141
187
|
/**
|
|
142
188
|
* The number of threads per CPU core you specified under `CreateCluster` .
|
|
143
189
|
* @min 1
|
|
@@ -262,6 +308,27 @@ export type ClusterRestrictedInstanceGroup = {
|
|
|
262
308
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deephealthchecktype.html}
|
|
263
309
|
*/
|
|
264
310
|
export type DeepHealthCheckType = "InstanceStress" | "InstanceConnectivity";
|
|
311
|
+
/**
|
|
312
|
+
* The configuration to use when updating the AMI versions.
|
|
313
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html}
|
|
314
|
+
*/
|
|
315
|
+
export type DeploymentConfig = {
|
|
316
|
+
/**
|
|
317
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-autorollbackconfiguration}
|
|
318
|
+
*/
|
|
319
|
+
AutoRollbackConfiguration?: AlarmDetails[] | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-rollingupdatepolicy}
|
|
322
|
+
*/
|
|
323
|
+
RollingUpdatePolicy?: RollingUpdatePolicy | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* The duration in seconds that SageMaker waits before updating more instances in the cluster.
|
|
326
|
+
* @min 0
|
|
327
|
+
* @max 3600
|
|
328
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-waitintervalinseconds}
|
|
329
|
+
*/
|
|
330
|
+
WaitIntervalInSeconds?: number | undefined;
|
|
331
|
+
};
|
|
265
332
|
/**
|
|
266
333
|
* The configuration for the restricted instance groups (RIG) environment.
|
|
267
334
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-environmentconfig.html}
|
|
@@ -279,14 +346,14 @@ export type EnvironmentConfig = {
|
|
|
279
346
|
*/
|
|
280
347
|
export type FSxLustreConfig = {
|
|
281
348
|
/**
|
|
282
|
-
* The throughput capacity of the FSx for Lustre file system, measured in MB/s per TiB of storage.
|
|
349
|
+
* The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
|
|
283
350
|
* @min 125
|
|
284
351
|
* @max 1000
|
|
285
352
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput}
|
|
286
353
|
*/
|
|
287
354
|
PerUnitStorageThroughput: number;
|
|
288
355
|
/**
|
|
289
|
-
* The storage capacity of the FSx for Lustre file system, specified in gibibytes (GiB).
|
|
356
|
+
* The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
|
|
290
357
|
* @min 1200
|
|
291
358
|
* @max 100800
|
|
292
359
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-sizeingib}
|
|
@@ -304,6 +371,38 @@ export type Orchestrator = {
|
|
|
304
371
|
*/
|
|
305
372
|
Eks: ClusterOrchestratorEksConfig;
|
|
306
373
|
};
|
|
374
|
+
/**
|
|
375
|
+
* The policy that SageMaker uses when updating the AMI versions of the cluster.
|
|
376
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html}
|
|
377
|
+
*/
|
|
378
|
+
export type RollingUpdatePolicy = {
|
|
379
|
+
/**
|
|
380
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html#cfn-sagemaker-cluster-rollingupdatepolicy-maximumbatchsize}
|
|
381
|
+
*/
|
|
382
|
+
MaximumBatchSize: CapacitySizeConfig;
|
|
383
|
+
/**
|
|
384
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html#cfn-sagemaker-cluster-rollingupdatepolicy-rollbackmaximumbatchsize}
|
|
385
|
+
*/
|
|
386
|
+
RollbackMaximumBatchSize?: CapacitySizeConfig | undefined;
|
|
387
|
+
};
|
|
388
|
+
/**
|
|
389
|
+
* The configuration object of the schedule that SageMaker follows when updating the AMI.
|
|
390
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html}
|
|
391
|
+
*/
|
|
392
|
+
export type ScheduledUpdateConfig = {
|
|
393
|
+
/**
|
|
394
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html#cfn-sagemaker-cluster-scheduledupdateconfig-deploymentconfig}
|
|
395
|
+
*/
|
|
396
|
+
DeploymentConfig?: DeploymentConfig | undefined;
|
|
397
|
+
/**
|
|
398
|
+
* A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
|
|
399
|
+
* @minLength 1
|
|
400
|
+
* @maxLength 256
|
|
401
|
+
* @pattern cron\((?:[0-5][0-9]|[0-9]|) (?:[01][0-9]|2[0-3]|[0-9]) (?:[1-9]|0[1-9]|[12][0-9]|3[01]|\?) (?:[1-9]|0[1-9]|1[0-2]|\*|\*/(?:[1-9]|1[0-2])|) (?:MON|TUE|WED|THU|FRI|SAT|SUN|[1-7]|\?|L|(?:[1-7]#[1-5])|(?:[1-7]L)) (?:20[2-9][0-9]|\*|)\)
|
|
402
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html#cfn-sagemaker-cluster-scheduledupdateconfig-scheduleexpression}
|
|
403
|
+
*/
|
|
404
|
+
ScheduleExpression: string;
|
|
405
|
+
};
|
|
307
406
|
/**
|
|
308
407
|
* 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 [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
|
|
309
408
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html}
|
|
@@ -857,12 +857,6 @@ export type UnifiedStudioSettings = {
|
|
|
857
857
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projects3path}
|
|
858
858
|
*/
|
|
859
859
|
ProjectS3Path?: string | undefined;
|
|
860
|
-
/**
|
|
861
|
-
* The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the AWS IAM Identity Center.
|
|
862
|
-
* @pattern ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+$
|
|
863
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-singlesignonapplicationarn}
|
|
864
|
-
*/
|
|
865
|
-
SingleSignOnApplicationArn?: string | undefined;
|
|
866
860
|
/**
|
|
867
861
|
* Sets whether you can access the domain in Amazon SageMaker Studio:
|
|
868
862
|
*
|
|
@@ -1,26 +1,36 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see [Process Data and Evaluate Models](https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html) .
|
|
4
|
+
*
|
|
5
|
+
* Also, note the following details specific to processing jobs created using CloudFormation stacks:
|
|
6
|
+
*
|
|
7
|
+
* - When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the [StopProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopProcessingJob.html) API but not deleted. Any tags associated with the processing job are deleted using the [DeleteTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) API.
|
|
8
|
+
* - If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified `ProcessingJobName` value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an `AlreadyExists` error. To prevent this, we recommend that you don't specify the optional `ProcessingJobName` property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the `ProcessingJobName` and redeploy the stack to recover from a failed rollback.
|
|
4
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
|
|
5
10
|
*/
|
|
6
11
|
export type SageMakerProcessingJob = ResourceDefinitionWithAttributes<"AWS::SageMaker::ProcessingJob", SageMakerProcessingJobProps, SageMakerProcessingJobAttribs>;
|
|
7
12
|
/**
|
|
8
|
-
*
|
|
13
|
+
* An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see [Process Data and Evaluate Models](https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html) .
|
|
14
|
+
*
|
|
15
|
+
* Also, note the following details specific to processing jobs created using CloudFormation stacks:
|
|
16
|
+
*
|
|
17
|
+
* - When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the [StopProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopProcessingJob.html) API but not deleted. Any tags associated with the processing job are deleted using the [DeleteTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) API.
|
|
18
|
+
* - If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified `ProcessingJobName` value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an `AlreadyExists` error. To prevent this, we recommend that you don't specify the optional `ProcessingJobName` property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the `ProcessingJobName` and redeploy the stack to recover from a failed rollback.
|
|
9
19
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
|
|
10
20
|
*/
|
|
11
21
|
export type SageMakerProcessingJobProps = {
|
|
12
22
|
/**
|
|
13
|
-
*
|
|
23
|
+
* Configuration to run a processing job in a specified container image.
|
|
14
24
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-appspecification}
|
|
15
25
|
*/
|
|
16
26
|
AppSpecification: AppSpecification;
|
|
17
27
|
/**
|
|
18
|
-
* Sets the environment variables in the Docker container
|
|
28
|
+
* Sets the environment variables in the Docker container.
|
|
19
29
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-environment}
|
|
20
30
|
*/
|
|
21
31
|
Environment?: Record<string, string> | undefined;
|
|
22
32
|
/**
|
|
23
|
-
* Associates a SageMaker job as a trial component with an experiment and trial.
|
|
33
|
+
* Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) API.
|
|
24
34
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-experimentconfig}
|
|
25
35
|
*/
|
|
26
36
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
@@ -30,12 +40,12 @@ export type SageMakerProcessingJobProps = {
|
|
|
30
40
|
*/
|
|
31
41
|
NetworkConfig?: NetworkConfig | undefined;
|
|
32
42
|
/**
|
|
33
|
-
*
|
|
43
|
+
* List of input configurations for the processing job.
|
|
34
44
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processinginputs}
|
|
35
45
|
*/
|
|
36
46
|
ProcessingInputs?: ProcessingInputsObject[] | undefined;
|
|
37
47
|
/**
|
|
38
|
-
* The name of the processing job.
|
|
48
|
+
* The name of the processing job. If you don't provide a job name, then a unique name is automatically created for the job.
|
|
39
49
|
* @minLength 1
|
|
40
50
|
* @maxLength 63
|
|
41
51
|
* @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
|
|
@@ -43,7 +53,7 @@ export type SageMakerProcessingJobProps = {
|
|
|
43
53
|
*/
|
|
44
54
|
ProcessingJobName?: string | undefined;
|
|
45
55
|
/**
|
|
46
|
-
*
|
|
56
|
+
* Contains information about the output location for the compiled model and the target device that the model runs on. `TargetDevice` and `TargetPlatform` are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the `TargetDevice` list, use `TargetPlatform` to describe the platform of your edge device and `CompilerOptions` if there are specific settings that are required or recommended to use for particular TargetPlatform.
|
|
47
57
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingoutputconfig}
|
|
48
58
|
*/
|
|
49
59
|
ProcessingOutputConfig?: ProcessingOutputConfig | undefined;
|
|
@@ -53,7 +63,7 @@ export type SageMakerProcessingJobProps = {
|
|
|
53
63
|
*/
|
|
54
64
|
ProcessingResources: ProcessingResources;
|
|
55
65
|
/**
|
|
56
|
-
* The
|
|
66
|
+
* The ARN of the role used to create the processing job.
|
|
57
67
|
* @minLength 20
|
|
58
68
|
* @maxLength 2048
|
|
59
69
|
* @pattern arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
|
|
@@ -66,7 +76,7 @@ export type SageMakerProcessingJobProps = {
|
|
|
66
76
|
*/
|
|
67
77
|
StoppingCondition?: StoppingCondition | undefined;
|
|
68
78
|
/**
|
|
69
|
-
*
|
|
79
|
+
* 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* .
|
|
70
80
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-tags}
|
|
71
81
|
*/
|
|
72
82
|
Tags?: Tag[] | undefined;
|
|
@@ -76,18 +86,18 @@ export type SageMakerProcessingJobProps = {
|
|
|
76
86
|
*/
|
|
77
87
|
export type SageMakerProcessingJobAttribs = {
|
|
78
88
|
/**
|
|
79
|
-
* The ARN of
|
|
89
|
+
* The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
|
|
80
90
|
* @maxLength 256
|
|
81
91
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-automljobarn}
|
|
82
92
|
*/
|
|
83
93
|
AutoMLJobArn: string;
|
|
84
94
|
/**
|
|
85
|
-
* The time
|
|
95
|
+
* The time the processing job was created.
|
|
86
96
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-creationtime}
|
|
87
97
|
*/
|
|
88
98
|
CreationTime: string;
|
|
89
99
|
/**
|
|
90
|
-
*
|
|
100
|
+
* A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
|
|
91
101
|
* @maxLength 1024
|
|
92
102
|
* @pattern [\S\s]*
|
|
93
103
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-exitmessage}
|
|
@@ -100,7 +110,7 @@ export type SageMakerProcessingJobAttribs = {
|
|
|
100
110
|
*/
|
|
101
111
|
FailureReason: string;
|
|
102
112
|
/**
|
|
103
|
-
* The time
|
|
113
|
+
* The time the processing job was last modified.
|
|
104
114
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-lastmodifiedtime}
|
|
105
115
|
*/
|
|
106
116
|
LastModifiedTime: string;
|
|
@@ -111,12 +121,12 @@ export type SageMakerProcessingJobAttribs = {
|
|
|
111
121
|
*/
|
|
112
122
|
MonitoringScheduleArn: string;
|
|
113
123
|
/**
|
|
114
|
-
* The time
|
|
124
|
+
* The time that the processing job ended.
|
|
115
125
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingendtime}
|
|
116
126
|
*/
|
|
117
127
|
ProcessingEndTime: string;
|
|
118
128
|
/**
|
|
119
|
-
* The
|
|
129
|
+
* The ARN of the processing job.
|
|
120
130
|
* @minLength 0
|
|
121
131
|
* @maxLength 256
|
|
122
132
|
* @pattern arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
|
|
@@ -124,24 +134,24 @@ export type SageMakerProcessingJobAttribs = {
|
|
|
124
134
|
*/
|
|
125
135
|
ProcessingJobArn: string;
|
|
126
136
|
/**
|
|
127
|
-
*
|
|
137
|
+
* The status of the processing job.
|
|
128
138
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingjobstatus}
|
|
129
139
|
*/
|
|
130
140
|
ProcessingJobStatus: "Completed" | "InProgress" | "Stopping" | "Stopped" | "Failed";
|
|
131
141
|
/**
|
|
132
|
-
* The time
|
|
142
|
+
* The time that the processing job started.
|
|
133
143
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingstarttime}
|
|
134
144
|
*/
|
|
135
145
|
ProcessingStartTime: string;
|
|
136
146
|
/**
|
|
137
|
-
* The ARN of
|
|
147
|
+
* The ARN of the training job associated with this processing job.
|
|
138
148
|
* @maxLength 256
|
|
139
149
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-trainingjobarn}
|
|
140
150
|
*/
|
|
141
151
|
TrainingJobArn: string;
|
|
142
152
|
};
|
|
143
153
|
/**
|
|
144
|
-
*
|
|
154
|
+
* Configuration to run a processing job in a specified container image.
|
|
145
155
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html}
|
|
146
156
|
*/
|
|
147
157
|
export type AppSpecification = {
|
|
@@ -183,7 +193,7 @@ export type AthenaDatasetDefinition = {
|
|
|
183
193
|
*/
|
|
184
194
|
Database: string;
|
|
185
195
|
/**
|
|
186
|
-
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
|
|
196
|
+
* The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
|
|
187
197
|
* @minLength 0
|
|
188
198
|
* @maxLength 2048
|
|
189
199
|
* @pattern [a-zA-Z0-9:/_-]*
|
|
@@ -241,7 +251,13 @@ export type ClusterConfig = {
|
|
|
241
251
|
*/
|
|
242
252
|
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";
|
|
243
253
|
/**
|
|
244
|
-
* 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.
|
|
254
|
+
* 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.
|
|
255
|
+
*
|
|
256
|
+
* > Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a `VolumeKmsKeyId` when using an instance type with local storage.
|
|
257
|
+
* >
|
|
258
|
+
* > For a list of instance types that support local instance storage, see [Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .
|
|
259
|
+
* >
|
|
260
|
+
* > For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) .
|
|
245
261
|
* @minLength 0
|
|
246
262
|
* @maxLength 2048
|
|
247
263
|
* @pattern [a-zA-Z0-9:/_-]*
|
|
@@ -250,6 +266,10 @@ export type ClusterConfig = {
|
|
|
250
266
|
VolumeKmsKeyId?: string | undefined;
|
|
251
267
|
/**
|
|
252
268
|
* The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
|
|
269
|
+
*
|
|
270
|
+
* > Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a `VolumeSizeInGB` greater than the total size of the local instance storage.
|
|
271
|
+
* >
|
|
272
|
+
* > For a list of instance types that support local instance storage, including the total size per instance type, see [Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .
|
|
253
273
|
* @min 1
|
|
254
274
|
* @max 16384
|
|
255
275
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-volumesizeingb}
|
|
@@ -267,17 +287,17 @@ export type DatasetDefinition = {
|
|
|
267
287
|
*/
|
|
268
288
|
AthenaDatasetDefinition?: AthenaDatasetDefinition | undefined;
|
|
269
289
|
/**
|
|
270
|
-
* Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
|
|
290
|
+
* Whether the generated dataset is `FullyReplicated` or `ShardedByS3Key` (default).
|
|
271
291
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-datadistributiontype}
|
|
272
292
|
*/
|
|
273
293
|
DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
|
|
274
294
|
/**
|
|
275
|
-
* 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.
|
|
295
|
+
* 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.
|
|
276
296
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-inputmode}
|
|
277
297
|
*/
|
|
278
298
|
InputMode?: "File" | "Pipe" | undefined;
|
|
279
299
|
/**
|
|
280
|
-
* 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).
|
|
300
|
+
* 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).
|
|
281
301
|
* @minLength 0
|
|
282
302
|
* @maxLength 256
|
|
283
303
|
* @pattern .*
|
|
@@ -291,7 +311,7 @@ export type DatasetDefinition = {
|
|
|
291
311
|
RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined;
|
|
292
312
|
};
|
|
293
313
|
/**
|
|
294
|
-
* Associates a SageMaker job as a trial component with an experiment and trial.
|
|
314
|
+
* Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) API.
|
|
295
315
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html}
|
|
296
316
|
*/
|
|
297
317
|
export type ExperimentConfig = {
|
|
@@ -343,7 +363,7 @@ export type FeatureStoreOutput = {
|
|
|
343
363
|
*/
|
|
344
364
|
export type NetworkConfig = {
|
|
345
365
|
/**
|
|
346
|
-
* 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.
|
|
366
|
+
* 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.
|
|
347
367
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html#cfn-sagemaker-processingjob-networkconfig-enableintercontainertrafficencryption}
|
|
348
368
|
*/
|
|
349
369
|
EnableInterContainerTrafficEncryption?: boolean | undefined;
|
|
@@ -353,18 +373,18 @@ export type NetworkConfig = {
|
|
|
353
373
|
*/
|
|
354
374
|
EnableNetworkIsolation?: boolean | undefined;
|
|
355
375
|
/**
|
|
356
|
-
* 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
|
|
376
|
+
* 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 [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
|
|
357
377
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html#cfn-sagemaker-processingjob-networkconfig-vpcconfig}
|
|
358
378
|
*/
|
|
359
379
|
VpcConfig?: VpcConfig | undefined;
|
|
360
380
|
};
|
|
361
381
|
/**
|
|
362
|
-
* The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
|
|
382
|
+
* The inputs for a processing job. The processing input must specify exactly one of either `S3Input` or `DatasetDefinition` types.
|
|
363
383
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html}
|
|
364
384
|
*/
|
|
365
385
|
export type ProcessingInputsObject = {
|
|
366
386
|
/**
|
|
367
|
-
* 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.
|
|
387
|
+
* 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.
|
|
368
388
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-appmanaged}
|
|
369
389
|
*/
|
|
370
390
|
AppManaged?: boolean | undefined;
|
|
@@ -390,7 +410,7 @@ export type ProcessingInputsObject = {
|
|
|
390
410
|
*/
|
|
391
411
|
export type ProcessingOutputConfig = {
|
|
392
412
|
/**
|
|
393
|
-
* 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.
|
|
413
|
+
* 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.
|
|
394
414
|
* @maxLength 2048
|
|
395
415
|
* @pattern [a-zA-Z0-9:/_-]*
|
|
396
416
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputconfig.html#cfn-sagemaker-processingjob-processingoutputconfig-kmskeyid}
|
|
@@ -403,12 +423,12 @@ export type ProcessingOutputConfig = {
|
|
|
403
423
|
Outputs: ProcessingOutputsObject[];
|
|
404
424
|
};
|
|
405
425
|
/**
|
|
406
|
-
* Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
|
|
426
|
+
* Describes the results of a processing job. The processing output must specify exactly one of either `S3Output` or `FeatureStoreOutput` types.
|
|
407
427
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html}
|
|
408
428
|
*/
|
|
409
429
|
export type ProcessingOutputsObject = {
|
|
410
430
|
/**
|
|
411
|
-
* 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.
|
|
431
|
+
* 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.
|
|
412
432
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html#cfn-sagemaker-processingjob-processingoutputsobject-appmanaged}
|
|
413
433
|
*/
|
|
414
434
|
AppManaged?: boolean | undefined;
|
|
@@ -434,7 +454,7 @@ export type ProcessingOutputsObject = {
|
|
|
434
454
|
*/
|
|
435
455
|
export type ProcessingResources = {
|
|
436
456
|
/**
|
|
437
|
-
*
|
|
457
|
+
* The configuration for the resources in a cluster used to run the processing job.
|
|
438
458
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingresources.html#cfn-sagemaker-processingjob-processingresources-clusterconfig}
|
|
439
459
|
*/
|
|
440
460
|
ClusterConfig: ClusterConfig;
|
|
@@ -474,7 +494,7 @@ export type RedshiftDatasetDefinition = {
|
|
|
474
494
|
*/
|
|
475
495
|
DbUser: string;
|
|
476
496
|
/**
|
|
477
|
-
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
|
|
497
|
+
* The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
|
|
478
498
|
* @minLength 0
|
|
479
499
|
* @maxLength 2048
|
|
480
500
|
* @pattern [a-zA-Z0-9:/_-]*
|
|
@@ -513,7 +533,7 @@ export type RedshiftDatasetDefinition = {
|
|
|
513
533
|
*/
|
|
514
534
|
export type S3Input = {
|
|
515
535
|
/**
|
|
516
|
-
* 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
|
|
536
|
+
* 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).
|
|
517
537
|
* @minLength 0
|
|
518
538
|
* @maxLength 256
|
|
519
539
|
* @pattern .*
|
|
@@ -521,22 +541,22 @@ export type S3Input = {
|
|
|
521
541
|
*/
|
|
522
542
|
LocalPath?: string | undefined;
|
|
523
543
|
/**
|
|
524
|
-
* 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
|
|
544
|
+
* 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.
|
|
525
545
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3compressiontype}
|
|
526
546
|
*/
|
|
527
547
|
S3CompressionType?: "None" | "Gzip" | undefined;
|
|
528
548
|
/**
|
|
529
|
-
* Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated
|
|
549
|
+
* 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.
|
|
530
550
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3datadistributiontype}
|
|
531
551
|
*/
|
|
532
552
|
S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
|
|
533
553
|
/**
|
|
534
|
-
* 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.
|
|
554
|
+
* 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.
|
|
535
555
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3datatype}
|
|
536
556
|
*/
|
|
537
557
|
S3DataType: "ManifestFile" | "S3Prefix";
|
|
538
558
|
/**
|
|
539
|
-
* 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.
|
|
559
|
+
* 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.
|
|
540
560
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3inputmode}
|
|
541
561
|
*/
|
|
542
562
|
S3InputMode?: "File" | "Pipe" | undefined;
|
|
@@ -555,7 +575,7 @@ export type S3Input = {
|
|
|
555
575
|
*/
|
|
556
576
|
export type S3Output = {
|
|
557
577
|
/**
|
|
558
|
-
* 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.
|
|
578
|
+
* 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.
|
|
559
579
|
* @minLength 0
|
|
560
580
|
* @maxLength 256
|
|
561
581
|
* @pattern .*
|
|
@@ -568,7 +588,7 @@ export type S3Output = {
|
|
|
568
588
|
*/
|
|
569
589
|
S3UploadMode: "Continuous" | "EndOfJob";
|
|
570
590
|
/**
|
|
571
|
-
*
|
|
591
|
+
* The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
|
|
572
592
|
* @minLength 0
|
|
573
593
|
* @maxLength 1024
|
|
574
594
|
* @pattern (https|s3)://([^/]+)/?(.*)
|
|
@@ -582,7 +602,13 @@ export type S3Output = {
|
|
|
582
602
|
*/
|
|
583
603
|
export type StoppingCondition = {
|
|
584
604
|
/**
|
|
585
|
-
*
|
|
605
|
+
* The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
|
|
606
|
+
*
|
|
607
|
+
* For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
|
|
608
|
+
*
|
|
609
|
+
* For all other jobs, if the job does not complete during this time, SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
|
|
610
|
+
*
|
|
611
|
+
* The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
|
|
586
612
|
* @min 1
|
|
587
613
|
* @max 777600
|
|
588
614
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-stoppingcondition.html#cfn-sagemaker-processingjob-stoppingcondition-maxruntimeinseconds}
|
|
@@ -590,17 +616,17 @@ export type StoppingCondition = {
|
|
|
590
616
|
MaxRuntimeInSeconds: number;
|
|
591
617
|
};
|
|
592
618
|
/**
|
|
593
|
-
* 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
|
|
619
|
+
* 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 [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
|
|
594
620
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html}
|
|
595
621
|
*/
|
|
596
622
|
export type VpcConfig = {
|
|
597
623
|
/**
|
|
598
|
-
* The VPC security group IDs, in the form
|
|
624
|
+
* The VPC security group IDs, in the form `sg-xxxxxxxx` . Specify the security groups for the VPC that is specified in the `Subnets` field.
|
|
599
625
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html#cfn-sagemaker-processingjob-vpcconfig-securitygroupids}
|
|
600
626
|
*/
|
|
601
627
|
SecurityGroupIds: string[];
|
|
602
628
|
/**
|
|
603
|
-
* 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/
|
|
629
|
+
* 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 [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
|
|
604
630
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html#cfn-sagemaker-processingjob-vpcconfig-subnets}
|
|
605
631
|
*/
|
|
606
632
|
Subnets: string[];
|
|
@@ -78,7 +78,8 @@ export type SQSQueueProps = {
|
|
|
78
78
|
*/
|
|
79
79
|
KmsMasterKeyId?: string | undefined;
|
|
80
80
|
/**
|
|
81
|
-
* The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer
|
|
81
|
+
* The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer from 1,024 bytes (1 KiB) to 1,048,576 bytes (1 MiB).
|
|
82
|
+
* Default: 1,048,576 bytes (1 MiB).
|
|
82
83
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize}
|
|
83
84
|
*/
|
|
84
85
|
MaximumMessageSize?: number | undefined;
|