@awboost/cfn-resource-types 0.1.138 → 0.1.139

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.
@@ -0,0 +1,307 @@
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
+ * Definition of AWS::MediaLive::SignalMap Resource Type
5
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html}
6
+ */
7
+ export type MediaLiveSignalMapProperties = {
8
+ CloudWatchAlarmTemplateGroupIdentifiers?: string[];
9
+ /**
10
+ * A resource's optional description.
11
+ * @minLength `0`
12
+ * @maxLength `1024`
13
+ */
14
+ Description?: string;
15
+ /**
16
+ * A top-level supported AWS resource ARN to discovery a signal map from.
17
+ * @minLength `1`
18
+ * @maxLength `2048`
19
+ */
20
+ DiscoveryEntryPointArn: string;
21
+ EventBridgeRuleTemplateGroupIdentifiers?: string[];
22
+ /**
23
+ * If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
24
+ */
25
+ ForceRediscovery?: boolean;
26
+ /**
27
+ * A resource's name. Names must be unique within the scope of a resource type in a specific region.
28
+ * @minLength `1`
29
+ * @maxLength `255`
30
+ * @pattern `^[^\s]+$`
31
+ */
32
+ Name: string;
33
+ /**
34
+ * Represents the tags associated with a resource.
35
+ */
36
+ Tags?: TagMap;
37
+ };
38
+ /**
39
+ * Attribute type definition for `AWS::MediaLive::SignalMap`.
40
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#aws-resource-medialive-signalmap-return-values}
41
+ */
42
+ export type MediaLiveSignalMapAttributes = {
43
+ /**
44
+ * A signal map's ARN (Amazon Resource Name)
45
+ * @pattern `^arn:.+:medialive:.+:signal-map:.+$`
46
+ */
47
+ Arn: string;
48
+ CloudWatchAlarmTemplateGroupIds: string[];
49
+ CreatedAt: string;
50
+ /**
51
+ * Error message associated with a failed creation or failed update attempt of a signal map.
52
+ * @minLength `1`
53
+ * @maxLength `2048`
54
+ */
55
+ ErrorMessage: string;
56
+ EventBridgeRuleTemplateGroupIds: string[];
57
+ /**
58
+ * A map representing an incomplete AWS media workflow as a graph.
59
+ */
60
+ FailedMediaResourceMap: Record<string, {
61
+ Destinations: {
62
+ /**
63
+ * The ARN of a resource used in AWS media workflows.
64
+ * @minLength `1`
65
+ * @maxLength `2048`
66
+ * @pattern `^arn.+$`
67
+ */
68
+ Arn: string;
69
+ /**
70
+ * The logical name of an AWS media resource.
71
+ * @minLength `1`
72
+ * @maxLength `256`
73
+ */
74
+ Name: string;
75
+ }[];
76
+ /**
77
+ * The logical name of an AWS media resource.
78
+ * @minLength `1`
79
+ * @maxLength `256`
80
+ */
81
+ Name: string;
82
+ Sources: {
83
+ /**
84
+ * The ARN of a resource used in AWS media workflows.
85
+ * @minLength `1`
86
+ * @maxLength `2048`
87
+ * @pattern `^arn.+$`
88
+ */
89
+ Arn: string;
90
+ /**
91
+ * The logical name of an AWS media resource.
92
+ * @minLength `1`
93
+ * @maxLength `256`
94
+ */
95
+ Name: string;
96
+ }[];
97
+ }>;
98
+ /**
99
+ * A signal map's id.
100
+ * @minLength `7`
101
+ * @maxLength `11`
102
+ * @pattern `^(aws-)?[0-9]{7}$`
103
+ */
104
+ Id: string;
105
+ Identifier: string;
106
+ LastDiscoveredAt: string;
107
+ /**
108
+ * Represents the latest successful monitor deployment of a signal map.
109
+ */
110
+ LastSuccessfulMonitorDeployment: {
111
+ /**
112
+ * URI associated with a signal map's monitor deployment.
113
+ * @minLength `1`
114
+ * @maxLength `2048`
115
+ */
116
+ DetailsUri: string;
117
+ /**
118
+ * A signal map's monitor deployment status.
119
+ */
120
+ Status: SignalMapMonitorDeploymentStatus;
121
+ };
122
+ /**
123
+ * A map representing an AWS media workflow as a graph.
124
+ */
125
+ MediaResourceMap: Record<string, {
126
+ Destinations: {
127
+ /**
128
+ * The ARN of a resource used in AWS media workflows.
129
+ * @minLength `1`
130
+ * @maxLength `2048`
131
+ * @pattern `^arn.+$`
132
+ */
133
+ Arn: string;
134
+ /**
135
+ * The logical name of an AWS media resource.
136
+ * @minLength `1`
137
+ * @maxLength `256`
138
+ */
139
+ Name: string;
140
+ }[];
141
+ /**
142
+ * The logical name of an AWS media resource.
143
+ * @minLength `1`
144
+ * @maxLength `256`
145
+ */
146
+ Name: string;
147
+ Sources: {
148
+ /**
149
+ * The ARN of a resource used in AWS media workflows.
150
+ * @minLength `1`
151
+ * @maxLength `2048`
152
+ * @pattern `^arn.+$`
153
+ */
154
+ Arn: string;
155
+ /**
156
+ * The logical name of an AWS media resource.
157
+ * @minLength `1`
158
+ * @maxLength `256`
159
+ */
160
+ Name: string;
161
+ }[];
162
+ }>;
163
+ ModifiedAt: string;
164
+ /**
165
+ * If true, there are pending monitor changes for this signal map that can be deployed.
166
+ */
167
+ MonitorChangesPendingDeployment: boolean;
168
+ /**
169
+ * Represents the latest monitor deployment of a signal map.
170
+ */
171
+ MonitorDeployment: {
172
+ /**
173
+ * URI associated with a signal map's monitor deployment.
174
+ * @minLength `1`
175
+ * @maxLength `2048`
176
+ */
177
+ DetailsUri: string;
178
+ /**
179
+ * Error message associated with a failed monitor deployment of a signal map.
180
+ * @minLength `1`
181
+ * @maxLength `2048`
182
+ */
183
+ ErrorMessage: string;
184
+ /**
185
+ * A signal map's monitor deployment status.
186
+ */
187
+ Status: SignalMapMonitorDeploymentStatus;
188
+ };
189
+ /**
190
+ * A signal map's current status which is dependent on its lifecycle actions or associated jobs.
191
+ */
192
+ Status: SignalMapStatus;
193
+ };
194
+ /**
195
+ * Type definition for `AWS::MediaLive::SignalMap.FailedMediaResourceMap`.
196
+ * A map representing an incomplete AWS media workflow as a graph.
197
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-failedmediaresourcemap.html}
198
+ */
199
+ export type FailedMediaResourceMap = Record<string, MediaResource>;
200
+ /**
201
+ * Type definition for `AWS::MediaLive::SignalMap.MediaResource`.
202
+ * An AWS resource used in media workflows.
203
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresource.html}
204
+ */
205
+ export type MediaResource = {
206
+ Destinations?: MediaResourceNeighbor[];
207
+ /**
208
+ * The logical name of an AWS media resource.
209
+ * @minLength `1`
210
+ * @maxLength `256`
211
+ */
212
+ Name?: string;
213
+ Sources?: MediaResourceNeighbor[];
214
+ };
215
+ /**
216
+ * Type definition for `AWS::MediaLive::SignalMap.MediaResourceMap`.
217
+ * A map representing an AWS media workflow as a graph.
218
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresourcemap.html}
219
+ */
220
+ export type MediaResourceMap = Record<string, MediaResource>;
221
+ /**
222
+ * Type definition for `AWS::MediaLive::SignalMap.MediaResourceNeighbor`.
223
+ * A direct source or destination neighbor to an AWS media resource.
224
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresourceneighbor.html}
225
+ */
226
+ export type MediaResourceNeighbor = {
227
+ /**
228
+ * The ARN of a resource used in AWS media workflows.
229
+ * @minLength `1`
230
+ * @maxLength `2048`
231
+ * @pattern `^arn.+$`
232
+ */
233
+ Arn: string;
234
+ /**
235
+ * The logical name of an AWS media resource.
236
+ * @minLength `1`
237
+ * @maxLength `256`
238
+ */
239
+ Name?: string;
240
+ };
241
+ /**
242
+ * Type definition for `AWS::MediaLive::SignalMap.MonitorDeployment`.
243
+ * Represents the latest monitor deployment of a signal map.
244
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-monitordeployment.html}
245
+ */
246
+ export type MonitorDeployment = {
247
+ /**
248
+ * URI associated with a signal map's monitor deployment.
249
+ * @minLength `1`
250
+ * @maxLength `2048`
251
+ */
252
+ DetailsUri?: string;
253
+ /**
254
+ * Error message associated with a failed monitor deployment of a signal map.
255
+ * @minLength `1`
256
+ * @maxLength `2048`
257
+ */
258
+ ErrorMessage?: string;
259
+ /**
260
+ * A signal map's monitor deployment status.
261
+ */
262
+ Status: SignalMapMonitorDeploymentStatus;
263
+ };
264
+ /**
265
+ * Type definition for `AWS::MediaLive::SignalMap.SignalMapMonitorDeploymentStatus`.
266
+ * A signal map's monitor deployment status.
267
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-signalmapmonitordeploymentstatus.html}
268
+ */
269
+ export type SignalMapMonitorDeploymentStatus = "NOT_DEPLOYED" | "DRY_RUN_DEPLOYMENT_COMPLETE" | "DRY_RUN_DEPLOYMENT_FAILED" | "DRY_RUN_DEPLOYMENT_IN_PROGRESS" | "DEPLOYMENT_COMPLETE" | "DEPLOYMENT_FAILED" | "DEPLOYMENT_IN_PROGRESS" | "DELETE_COMPLETE" | "DELETE_FAILED" | "DELETE_IN_PROGRESS";
270
+ /**
271
+ * Type definition for `AWS::MediaLive::SignalMap.SignalMapStatus`.
272
+ * A signal map's current status which is dependent on its lifecycle actions or associated jobs.
273
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-signalmapstatus.html}
274
+ */
275
+ export type SignalMapStatus = "CREATE_IN_PROGRESS" | "CREATE_COMPLETE" | "CREATE_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_REVERTED" | "UPDATE_FAILED" | "READY" | "NOT_READY";
276
+ /**
277
+ * Type definition for `AWS::MediaLive::SignalMap.SuccessfulMonitorDeployment`.
278
+ * Represents the latest successful monitor deployment of a signal map.
279
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-successfulmonitordeployment.html}
280
+ */
281
+ export type SuccessfulMonitorDeployment = {
282
+ /**
283
+ * URI associated with a signal map's monitor deployment.
284
+ * @minLength `1`
285
+ * @maxLength `2048`
286
+ */
287
+ DetailsUri: string;
288
+ /**
289
+ * A signal map's monitor deployment status.
290
+ */
291
+ Status: SignalMapMonitorDeploymentStatus;
292
+ };
293
+ /**
294
+ * Type definition for `AWS::MediaLive::SignalMap.TagMap`.
295
+ * Represents the tags associated with a resource.
296
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-tagmap.html}
297
+ */
298
+ export type TagMap = Record<string, string>;
299
+ /**
300
+ * Definition of AWS::MediaLive::SignalMap Resource Type
301
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html}
302
+ */
303
+ export declare class MediaLiveSignalMap extends $Resource<"AWS::MediaLive::SignalMap", MediaLiveSignalMapProperties, MediaLiveSignalMapAttributes> {
304
+ static readonly Type = "AWS::MediaLive::SignalMap";
305
+ constructor(logicalId: string, properties: MediaLiveSignalMapProperties, options?: $ResourceOptions);
306
+ }
307
+ //# sourceMappingURL=AWS-MediaLive-SignalMap.d.ts.map
@@ -0,0 +1,12 @@
1
+ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
+ /**
3
+ * Definition of AWS::MediaLive::SignalMap Resource Type
4
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html}
5
+ */
6
+ export class MediaLiveSignalMap extends $Resource {
7
+ static Type = "AWS::MediaLive::SignalMap";
8
+ constructor(logicalId, properties, options) {
9
+ super(logicalId, MediaLiveSignalMap.Type, properties, options);
10
+ }
11
+ }
12
+ //# sourceMappingURL=AWS-MediaLive-SignalMap.js.map
@@ -150,6 +150,7 @@ export type AnalysisDefinition = {
150
150
  * @maxLength `200`
151
151
  */
152
152
  ParameterDeclarations?: ParameterDeclaration[];
153
+ QueryExecutionOptions?: QueryExecutionOptions;
153
154
  /**
154
155
  * @minLength `0`
155
156
  * @maxLength `20`
@@ -5098,6 +5099,18 @@ export type PrimaryValueDisplayType = "HIDDEN" | "COMPARISON" | "ACTUAL";
5098
5099
  export type ProgressBarOptions = {
5099
5100
  Visibility?: Visibility;
5100
5101
  };
5102
+ /**
5103
+ * Type definition for `AWS::QuickSight::Analysis.QueryExecutionMode`.
5104
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-queryexecutionmode.html}
5105
+ */
5106
+ export type QueryExecutionMode = "AUTO" | "MANUAL";
5107
+ /**
5108
+ * Type definition for `AWS::QuickSight::Analysis.QueryExecutionOptions`.
5109
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-queryexecutionoptions.html}
5110
+ */
5111
+ export type QueryExecutionOptions = {
5112
+ QueryExecutionMode?: QueryExecutionMode;
5113
+ };
5101
5114
  /**
5102
5115
  * Type definition for `AWS::QuickSight::Analysis.RadarChartAggregatedFieldWells`.
5103
5116
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html}
@@ -5110,6 +5110,18 @@ export type PrimaryValueDisplayType = "HIDDEN" | "COMPARISON" | "ACTUAL";
5110
5110
  export type ProgressBarOptions = {
5111
5111
  Visibility?: Visibility;
5112
5112
  };
5113
+ /**
5114
+ * Type definition for `AWS::QuickSight::Template.QueryExecutionMode`.
5115
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionmode.html}
5116
+ */
5117
+ export type QueryExecutionMode = "AUTO" | "MANUAL";
5118
+ /**
5119
+ * Type definition for `AWS::QuickSight::Template.QueryExecutionOptions`.
5120
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionoptions.html}
5121
+ */
5122
+ export type QueryExecutionOptions = {
5123
+ QueryExecutionMode?: QueryExecutionMode;
5124
+ };
5113
5125
  /**
5114
5126
  * Type definition for `AWS::QuickSight::Template.RadarChartAggregatedFieldWells`.
5115
5127
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html}
@@ -6702,6 +6714,7 @@ export type TemplateVersionDefinition = {
6702
6714
  * @maxLength `200`
6703
6715
  */
6704
6716
  ParameterDeclarations?: ParameterDeclaration[];
6717
+ QueryExecutionOptions?: QueryExecutionOptions;
6705
6718
  /**
6706
6719
  * @minLength `0`
6707
6720
  * @maxLength `20`
@@ -5,16 +5,49 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html}
6
6
  */
7
7
  export type SNSSubscriptionProperties = {
8
- DeliveryPolicy?: Record<string, any>;
8
+ /**
9
+ * The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic.
10
+ */
11
+ DeliveryPolicy?: Record<string, any> | string;
12
+ /**
13
+ * The subscription's endpoint. The endpoint value depends on the protocol that you specify.
14
+ */
9
15
  Endpoint?: string;
10
- FilterPolicy?: Record<string, any>;
16
+ /**
17
+ * The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.
18
+ */
19
+ FilterPolicy?: Record<string, any> | string;
20
+ /**
21
+ * This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
22
+ */
11
23
  FilterPolicyScope?: string;
24
+ /**
25
+ * The subscription's protocol.
26
+ */
12
27
  Protocol: string;
28
+ /**
29
+ * When set to true, enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints.
30
+ */
13
31
  RawMessageDelivery?: boolean;
14
- RedrivePolicy?: Record<string, any>;
32
+ /**
33
+ * When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors are held in the dead-letter queue for further analysis or reprocessing.
34
+ */
35
+ RedrivePolicy?: Record<string, any> | string;
36
+ /**
37
+ * For cross-region subscriptions, the region in which the topic resides.If no region is specified, AWS CloudFormation uses the region of the caller as the default.
38
+ */
15
39
  Region?: string;
16
- ReplayPolicy?: Record<string, any>;
40
+ /**
41
+ * Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
42
+ */
43
+ ReplayPolicy?: Record<string, any> | string;
44
+ /**
45
+ * This property applies only to Amazon Data Firehose delivery stream subscriptions.
46
+ */
17
47
  SubscriptionRoleArn?: string;
48
+ /**
49
+ * The ARN of the topic to subscribe to.
50
+ */
18
51
  TopicArn: string;
19
52
  };
20
53
  /**
@@ -22,7 +55,10 @@ export type SNSSubscriptionProperties = {
22
55
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#aws-resource-sns-subscription-return-values}
23
56
  */
24
57
  export type SNSSubscriptionAttributes = {
25
- Id: string;
58
+ /**
59
+ * Arn of the subscription
60
+ */
61
+ Arn: string;
26
62
  };
27
63
  /**
28
64
  * Resource Type definition for AWS::SNS::Subscription
@@ -0,0 +1,241 @@
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::Cluster
5
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html}
6
+ */
7
+ export type SageMakerClusterProperties = {
8
+ /**
9
+ * The name of the HyperPod Cluster.
10
+ * @minLength `1`
11
+ * @maxLength `63`
12
+ * @pattern `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`
13
+ */
14
+ ClusterName?: string;
15
+ /**
16
+ * The instance groups of the SageMaker HyperPod cluster.
17
+ * @minLength `1`
18
+ */
19
+ InstanceGroups: ClusterInstanceGroup[];
20
+ /**
21
+ * If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
22
+ */
23
+ NodeRecovery?: "Automatic" | "None";
24
+ /**
25
+ * Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
26
+ */
27
+ Orchestrator?: Orchestrator;
28
+ /**
29
+ * Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
30
+ * @maxLength `50`
31
+ */
32
+ Tags?: Tag[];
33
+ /**
34
+ * 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.
35
+ */
36
+ VpcConfig?: VpcConfig;
37
+ };
38
+ /**
39
+ * Attribute type definition for `AWS::SageMaker::Cluster`.
40
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#aws-resource-sagemaker-cluster-return-values}
41
+ */
42
+ export type SageMakerClusterAttributes = {
43
+ /**
44
+ * The Amazon Resource Name (ARN) of the HyperPod Cluster.
45
+ * @maxLength `256`
46
+ * @pattern `^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$`
47
+ */
48
+ ClusterArn: string;
49
+ /**
50
+ * The status of the HyperPod Cluster.
51
+ */
52
+ ClusterStatus: "Creating" | "Deleting" | "Failed" | "InService" | "RollingBack" | "SystemUpdating" | "Updating";
53
+ /**
54
+ * The time at which the HyperPod cluster was created.
55
+ */
56
+ CreationTime: string;
57
+ /**
58
+ * The failure message of the HyperPod Cluster.
59
+ */
60
+ FailureMessage: string;
61
+ /**
62
+ * The instance groups of the SageMaker HyperPod cluster.
63
+ * @minLength `1`
64
+ */
65
+ InstanceGroups: {
66
+ /**
67
+ * The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
68
+ * @min `0`
69
+ */
70
+ CurrentCount: number;
71
+ }[];
72
+ };
73
+ /**
74
+ * Type definition for `AWS::SageMaker::Cluster.ClusterEbsVolumeConfig`.
75
+ * Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
76
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html}
77
+ */
78
+ export type ClusterEbsVolumeConfig = {
79
+ /**
80
+ * The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
81
+ * @min `1`
82
+ * @max `16384`
83
+ */
84
+ VolumeSizeInGB?: number;
85
+ };
86
+ /**
87
+ * Type definition for `AWS::SageMaker::Cluster.ClusterInstanceGroup`.
88
+ * Details of an instance group in a SageMaker HyperPod cluster.
89
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html}
90
+ */
91
+ export type ClusterInstanceGroup = {
92
+ /**
93
+ * The execution role for the instance group to assume.
94
+ * @minLength `20`
95
+ * @maxLength `2048`
96
+ * @pattern `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`
97
+ */
98
+ ExecutionRole: string;
99
+ /**
100
+ * The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
101
+ * @min `1`
102
+ */
103
+ InstanceCount: number;
104
+ /**
105
+ * The name of the instance group of a SageMaker HyperPod cluster.
106
+ * @minLength `1`
107
+ * @maxLength `63`
108
+ * @pattern `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`
109
+ */
110
+ InstanceGroupName: string;
111
+ /**
112
+ * The instance storage configuration for the instance group.
113
+ * @maxLength `1`
114
+ */
115
+ InstanceStorageConfigs?: ClusterInstanceStorageConfig[];
116
+ /**
117
+ * The instance type of the instance group of a SageMaker HyperPod cluster.
118
+ */
119
+ InstanceType: string;
120
+ /**
121
+ * The lifecycle configuration for a SageMaker HyperPod cluster.
122
+ */
123
+ LifeCycleConfig: ClusterLifeCycleConfig;
124
+ /**
125
+ * Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.
126
+ */
127
+ OnStartDeepHealthChecks?: DeepHealthCheckType[];
128
+ /**
129
+ * The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
130
+ * @min `1`
131
+ * @max `2`
132
+ */
133
+ ThreadsPerCore?: number;
134
+ };
135
+ /**
136
+ * Type definition for `AWS::SageMaker::Cluster.ClusterInstanceStorageConfig`.
137
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html}
138
+ */
139
+ export type ClusterInstanceStorageConfig = {
140
+ /**
141
+ * Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
142
+ */
143
+ EbsVolumeConfig?: ClusterEbsVolumeConfig;
144
+ };
145
+ /**
146
+ * Type definition for `AWS::SageMaker::Cluster.ClusterLifeCycleConfig`.
147
+ * The lifecycle configuration for a SageMaker HyperPod cluster.
148
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html}
149
+ */
150
+ export type ClusterLifeCycleConfig = {
151
+ /**
152
+ * The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
153
+ * @minLength `1`
154
+ * @maxLength `128`
155
+ * @pattern `^[\S\s]+$`
156
+ */
157
+ OnCreate: string;
158
+ /**
159
+ * An Amazon S3 bucket path where your lifecycle scripts are stored.
160
+ * @maxLength `1024`
161
+ * @pattern `^(https|s3)://([^/]+)/?(.*)$`
162
+ */
163
+ SourceS3Uri: string;
164
+ };
165
+ /**
166
+ * Type definition for `AWS::SageMaker::Cluster.ClusterOrchestratorEksConfig`.
167
+ * Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,
168
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html}
169
+ */
170
+ export type ClusterOrchestratorEksConfig = {
171
+ /**
172
+ * The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
173
+ */
174
+ ClusterArn: string;
175
+ };
176
+ /**
177
+ * Type definition for `AWS::SageMaker::Cluster.DeepHealthCheckType`.
178
+ * The type of deep health check(s) to be performed on the instances in the SageMaker HyperPod cluster instance group.
179
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deephealthchecktype.html}
180
+ */
181
+ export type DeepHealthCheckType = "InstanceStress" | "InstanceConnectivity";
182
+ /**
183
+ * Type definition for `AWS::SageMaker::Cluster.Orchestrator`.
184
+ * Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
185
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html}
186
+ */
187
+ export type Orchestrator = {
188
+ /**
189
+ * Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,
190
+ */
191
+ Eks: ClusterOrchestratorEksConfig;
192
+ };
193
+ /**
194
+ * Type definition for `AWS::SageMaker::Cluster.Tag`.
195
+ * A key-value pair to associate with a resource.
196
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-tag.html}
197
+ */
198
+ export type Tag = {
199
+ /**
200
+ * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
201
+ * @minLength `1`
202
+ * @maxLength `128`
203
+ * @pattern `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
204
+ */
205
+ Key: string;
206
+ /**
207
+ * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
208
+ * @minLength `0`
209
+ * @maxLength `256`
210
+ * @pattern `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
211
+ */
212
+ Value: string;
213
+ };
214
+ /**
215
+ * Type definition for `AWS::SageMaker::Cluster.VpcConfig`.
216
+ * 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.
217
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html}
218
+ */
219
+ export type VpcConfig = {
220
+ /**
221
+ * The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
222
+ * @minLength `1`
223
+ * @maxLength `5`
224
+ */
225
+ SecurityGroupIds: string[];
226
+ /**
227
+ * The ID of the subnets in the VPC to which you want to connect your training job or model.
228
+ * @minLength `1`
229
+ * @maxLength `16`
230
+ */
231
+ Subnets: string[];
232
+ };
233
+ /**
234
+ * Resource Type definition for AWS::SageMaker::Cluster
235
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html}
236
+ */
237
+ export declare class SageMakerCluster extends $Resource<"AWS::SageMaker::Cluster", SageMakerClusterProperties, SageMakerClusterAttributes> {
238
+ static readonly Type = "AWS::SageMaker::Cluster";
239
+ constructor(logicalId: string, properties: SageMakerClusterProperties, options?: $ResourceOptions);
240
+ }
241
+ //# sourceMappingURL=AWS-SageMaker-Cluster.d.ts.map