@propulsionworks/cloudformation 0.1.40 → 0.1.41
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-arcregionswitch-plan.d.ts +94 -1
- package/out/exports/resources.generated/aws-autoscaling-autoscalinggroup.d.ts +18 -0
- package/out/exports/resources.generated/aws-cases-caserule.d.ts +24 -24
- package/out/exports/resources.generated/aws-cases-domain.d.ts +10 -6
- package/out/exports/resources.generated/aws-cases-field.d.ts +10 -10
- package/out/exports/resources.generated/aws-cases-layout.d.ts +30 -20
- package/out/exports/resources.generated/aws-cases-template.d.ts +32 -18
- package/out/exports/resources.generated/aws-connect-contactflowmodule.d.ts +2 -2
- package/out/exports/resources.generated/aws-ec2-clientvpnendpoint.d.ts +2 -0
- package/out/exports/resources.generated/aws-ec2-ec2fleet.d.ts +3 -1
- package/out/exports/resources.generated/aws-ec2-spotfleet.d.ts +3 -1
- package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +10 -0
- package/out/exports/resources.generated/aws-ecs-expressgatewayservice.d.ts +12 -0
- package/out/exports/resources.generated/aws-groundstation-dataflowendpointgroupv2.d.ts +42 -27
- package/out/exports/resources.generated/aws-iot-topicrule.d.ts +25 -0
- package/out/exports/resources.generated/aws-kafkaconnect-connector.d.ts +1 -1
- package/out/exports/resources.generated/aws-lex-bot.d.ts +6 -0
- package/out/exports/resources.generated/aws-logs-loggroup.d.ts +1 -0
- package/out/exports/resources.generated/aws-mediatailor-playbackconfiguration.d.ts +42 -0
- package/out/exports/resources.generated/aws-observabilityadmin-s3tableintegration.d.ts +10 -10
- package/out/exports/resources.generated/aws-observabilityadmin-telemetrypipelines.d.ts +20 -3
- package/out/exports/resources.generated/aws-odb-odbpeeringconnection.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-dashboard.d.ts +15 -2
- package/out/exports/resources.generated/aws-securityhub-connectorv2.d.ts +5 -5
- package/out/exports/resources.generated/aws-ses-multiregionendpoint.d.ts +1 -1
- package/out/exports/resources.generated/aws-ses-tenant.d.ts +11 -7
- package/out/exports/resources.generated/aws-ssm-maintenancewindowtask.d.ts +1 -1
- package/out/exports/resources.generated/aws-workspacesweb-usersettings.d.ts +1 -0
- package/package.json +1 -1
|
@@ -56,6 +56,10 @@ export type ARCRegionSwitchPlanProps = {
|
|
|
56
56
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-regions}
|
|
57
57
|
*/
|
|
58
58
|
Regions: string[];
|
|
59
|
+
/**
|
|
60
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-reportconfiguration}
|
|
61
|
+
*/
|
|
62
|
+
ReportConfiguration?: ReportConfiguration | undefined;
|
|
59
63
|
/**
|
|
60
64
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-tags}
|
|
61
65
|
*/
|
|
@@ -230,6 +234,61 @@ export type CustomActionLambdaConfiguration = {
|
|
|
230
234
|
*/
|
|
231
235
|
Ungraceful?: LambdaUngraceful | undefined;
|
|
232
236
|
};
|
|
237
|
+
/**
|
|
238
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html}
|
|
239
|
+
*/
|
|
240
|
+
export type DocumentDbConfiguration = {
|
|
241
|
+
/**
|
|
242
|
+
* @default "switchoverOnly"
|
|
243
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-behavior}
|
|
244
|
+
*/
|
|
245
|
+
Behavior: DocumentDbDefaultBehavior;
|
|
246
|
+
/**
|
|
247
|
+
* @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
|
|
248
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole}
|
|
249
|
+
*/
|
|
250
|
+
CrossAccountRole?: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns}
|
|
253
|
+
*/
|
|
254
|
+
DatabaseClusterArns: string[];
|
|
255
|
+
/**
|
|
256
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-externalid}
|
|
257
|
+
*/
|
|
258
|
+
ExternalId?: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* @pattern ^[A-Za-z][0-9A-Za-z-:._]*$
|
|
261
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier}
|
|
262
|
+
*/
|
|
263
|
+
GlobalClusterIdentifier: string;
|
|
264
|
+
/**
|
|
265
|
+
* @min 1
|
|
266
|
+
* @default 60
|
|
267
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes}
|
|
268
|
+
*/
|
|
269
|
+
TimeoutMinutes?: number | undefined;
|
|
270
|
+
/**
|
|
271
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful}
|
|
272
|
+
*/
|
|
273
|
+
Ungraceful?: DocumentDbUngraceful | undefined;
|
|
274
|
+
};
|
|
275
|
+
/**
|
|
276
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbdefaultbehavior.html}
|
|
277
|
+
*/
|
|
278
|
+
export type DocumentDbDefaultBehavior = "switchoverOnly" | "failover";
|
|
279
|
+
/**
|
|
280
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbungraceful.html}
|
|
281
|
+
*/
|
|
282
|
+
export type DocumentDbUngraceful = {
|
|
283
|
+
/**
|
|
284
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbungraceful.html#cfn-arcregionswitch-plan-documentdbungraceful-ungraceful}
|
|
285
|
+
*/
|
|
286
|
+
Ungraceful?: DocumentDbUngracefulBehavior | undefined;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbungracefulbehavior.html}
|
|
290
|
+
*/
|
|
291
|
+
export type DocumentDbUngracefulBehavior = "failover";
|
|
233
292
|
/**
|
|
234
293
|
* Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
|
|
235
294
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html}
|
|
@@ -462,11 +521,13 @@ export type ExecutionBlockConfiguration = {
|
|
|
462
521
|
EksResourceScalingConfig: EksResourceScalingConfiguration;
|
|
463
522
|
} | {
|
|
464
523
|
Route53HealthCheckConfig: Route53HealthCheckConfiguration;
|
|
524
|
+
} | {
|
|
525
|
+
DocumentDbConfig: DocumentDbConfiguration;
|
|
465
526
|
};
|
|
466
527
|
/**
|
|
467
528
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblocktype.html}
|
|
468
529
|
*/
|
|
469
|
-
export type ExecutionBlockType = "CustomActionLambda" | "ManualApproval" | "AuroraGlobalDatabase" | "EC2AutoScaling" | "ARCRoutingControl" | "ARCRegionSwitchPlan" | "Parallel" | "ECSServiceScaling" | "EKSResourceScaling" | "Route53HealthCheck";
|
|
530
|
+
export type ExecutionBlockType = "CustomActionLambda" | "ManualApproval" | "AuroraGlobalDatabase" | "EC2AutoScaling" | "ARCRoutingControl" | "ARCRegionSwitchPlan" | "Parallel" | "ECSServiceScaling" | "EKSResourceScaling" | "Route53HealthCheck" | "DocumentDb";
|
|
470
531
|
/**
|
|
471
532
|
* Configuration for Amazon Aurora global databases used in a Region switch plan.
|
|
472
533
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html}
|
|
@@ -649,6 +710,21 @@ export type RegionSwitchPlanConfiguration = {
|
|
|
649
710
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regiontorunin.html}
|
|
650
711
|
*/
|
|
651
712
|
export type RegionToRunIn = "activatingRegion" | "deactivatingRegion";
|
|
713
|
+
/**
|
|
714
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportconfiguration.html}
|
|
715
|
+
*/
|
|
716
|
+
export type ReportConfiguration = {
|
|
717
|
+
/**
|
|
718
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportconfiguration.html#cfn-arcregionswitch-plan-reportconfiguration-reportoutput}
|
|
719
|
+
*/
|
|
720
|
+
ReportOutput?: ReportOutputConfiguration[] | undefined;
|
|
721
|
+
};
|
|
722
|
+
/**
|
|
723
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportoutputconfiguration.html}
|
|
724
|
+
*/
|
|
725
|
+
export type ReportOutputConfiguration = {
|
|
726
|
+
S3Configuration: S3ReportOutputConfiguration;
|
|
727
|
+
};
|
|
652
728
|
/**
|
|
653
729
|
* The Amazon Route 53 health check configuration.
|
|
654
730
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html}
|
|
@@ -715,6 +791,23 @@ export type Route53ResourceRecordSet = {
|
|
|
715
791
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-routingcontrolstatechange.html}
|
|
716
792
|
*/
|
|
717
793
|
export type RoutingControlStateChange = "On" | "Off";
|
|
794
|
+
/**
|
|
795
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html}
|
|
796
|
+
*/
|
|
797
|
+
export type S3ReportOutputConfiguration = {
|
|
798
|
+
/**
|
|
799
|
+
* @pattern ^\d{12}$
|
|
800
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketowner}
|
|
801
|
+
*/
|
|
802
|
+
BucketOwner?: string | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* @minLength 3
|
|
805
|
+
* @maxLength 512
|
|
806
|
+
* @pattern ^(?:s3://)?[a-z0-9][a-z0-9-]{1,61}[a-z0-9](?:/[^/ ][^/]*)*/?$
|
|
807
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketpath}
|
|
808
|
+
*/
|
|
809
|
+
BucketPath?: string | undefined;
|
|
810
|
+
};
|
|
718
811
|
/**
|
|
719
812
|
* The service for a cross account role.
|
|
720
813
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html}
|
|
@@ -123,6 +123,7 @@ export type AutoScalingAutoScalingGroupProps = {
|
|
|
123
123
|
*/
|
|
124
124
|
InstanceId?: string | undefined;
|
|
125
125
|
/**
|
|
126
|
+
* The instance lifecycle policy for the Auto Scaling group.
|
|
126
127
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instancelifecyclepolicy}
|
|
127
128
|
*/
|
|
128
129
|
InstanceLifecyclePolicy?: InstanceLifecyclePolicy | undefined;
|
|
@@ -407,10 +408,14 @@ export type CpuPerformanceFactorRequest = {
|
|
|
407
408
|
References?: PerformanceFactorReferenceRequest[] | undefined;
|
|
408
409
|
};
|
|
409
410
|
/**
|
|
411
|
+
* The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a `Retained` state instead of automatic termination.
|
|
412
|
+
*
|
|
413
|
+
* For more information, see [Control instance retention with instance lifecycle policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-lifecycle-policy.html) in the *Amazon EC2 Auto Scaling User Guide* .
|
|
410
414
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancelifecyclepolicy.html}
|
|
411
415
|
*/
|
|
412
416
|
export type InstanceLifecyclePolicy = {
|
|
413
417
|
/**
|
|
418
|
+
* Specifies the conditions that trigger instance retention behavior. These triggers determine when instances should move to a `Retained` state instead of automatic termination. This allows you to maintain control over instance management when lifecycles transition and operations fail.
|
|
414
419
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancelifecyclepolicy.html#cfn-autoscaling-autoscalinggroup-instancelifecyclepolicy-retentiontriggers}
|
|
415
420
|
*/
|
|
416
421
|
RetentionTriggers?: RetentionTriggers | undefined;
|
|
@@ -782,6 +787,13 @@ export type LaunchTemplate = {
|
|
|
782
787
|
*/
|
|
783
788
|
export type LaunchTemplateOverrides = {
|
|
784
789
|
/**
|
|
790
|
+
* The ID of the Amazon Machine Image (AMI) to use for instances launched with this override. When using Instance Refresh with `ReplaceRootVolume` strategy, this specifies the AMI for root volume replacement operations.
|
|
791
|
+
*
|
|
792
|
+
* For `ReplaceRootVolume` operations:
|
|
793
|
+
*
|
|
794
|
+
* - All overrides in the `MixedInstancesPolicy` must specify an ImageId
|
|
795
|
+
* - The AMI must contain only a single root volume
|
|
796
|
+
* - Root volume replacement doesn't support multi-volume AMIs
|
|
785
797
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-imageid}
|
|
786
798
|
*/
|
|
787
799
|
ImageId?: string | undefined;
|
|
@@ -1107,10 +1119,16 @@ export type PerformanceFactorReferenceRequest = {
|
|
|
1107
1119
|
InstanceFamily?: string | undefined;
|
|
1108
1120
|
};
|
|
1109
1121
|
/**
|
|
1122
|
+
* Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.
|
|
1110
1123
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-retentiontriggers.html}
|
|
1111
1124
|
*/
|
|
1112
1125
|
export type RetentionTriggers = {
|
|
1113
1126
|
/**
|
|
1127
|
+
* Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).
|
|
1128
|
+
*
|
|
1129
|
+
* Set to `Retain` to move instances to a `Retained` state. Set to `Terminate` for default termination behavior.
|
|
1130
|
+
*
|
|
1131
|
+
* Retained instances don't count toward desired capacity and remain until you call `TerminateInstanceInAutoScalingGroup` .
|
|
1114
1132
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-retentiontriggers.html#cfn-autoscaling-autoscalinggroup-retentiontriggers-terminatehookabandon}
|
|
1115
1133
|
*/
|
|
1116
1134
|
TerminateHookAbandon?: string | undefined;
|
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Creates a new case rule. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
4
4
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html}
|
|
5
5
|
*/
|
|
6
6
|
export type CasesCaseRule = ResourceDefinitionWithAttributes<"AWS::Cases::CaseRule", CasesCaseRuleProps, CasesCaseRuleAttribs>;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Creates a new case rule. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html}
|
|
10
10
|
*/
|
|
11
11
|
export type CasesCaseRuleProps = {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Description of a case rule.
|
|
14
14
|
* @maxLength 255
|
|
15
15
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-description}
|
|
16
16
|
*/
|
|
17
17
|
Description?: string | undefined;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Unique identifier of a Cases domain.
|
|
20
20
|
* @minLength 1
|
|
21
21
|
* @maxLength 500
|
|
22
22
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-domainid}
|
|
23
23
|
*/
|
|
24
24
|
DomainId?: string | undefined;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Name of the case rule.
|
|
27
27
|
* @minLength 1
|
|
28
28
|
* @maxLength 100
|
|
29
29
|
* @pattern ^.*[\S]$
|
|
@@ -31,12 +31,12 @@ export type CasesCaseRuleProps = {
|
|
|
31
31
|
*/
|
|
32
32
|
Name: string;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Represents what rule type should take place, under what conditions.
|
|
35
35
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-rule}
|
|
36
36
|
*/
|
|
37
37
|
Rule: CaseRuleDetails;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* An array of key-value pairs to apply to this resource.
|
|
40
40
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-tags}
|
|
41
41
|
*/
|
|
42
42
|
Tags?: Tag[] | undefined;
|
|
@@ -46,34 +46,34 @@ export type CasesCaseRuleProps = {
|
|
|
46
46
|
*/
|
|
47
47
|
export type CasesCaseRuleAttribs = {
|
|
48
48
|
/**
|
|
49
|
-
* The Amazon Resource Name (ARN) of
|
|
49
|
+
* The Amazon Resource Name (ARN) of the case rule.
|
|
50
50
|
* @minLength 1
|
|
51
51
|
* @maxLength 500
|
|
52
52
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-caserulearn}
|
|
53
53
|
*/
|
|
54
54
|
CaseRuleArn: string;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* Unique identifier of a case rule.
|
|
57
57
|
* @minLength 1
|
|
58
58
|
* @maxLength 500
|
|
59
59
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-caseruleid}
|
|
60
60
|
*/
|
|
61
61
|
CaseRuleId: string;
|
|
62
62
|
/**
|
|
63
|
-
*
|
|
63
|
+
* Timestamp when the resource was created.
|
|
64
64
|
* @format date-time
|
|
65
65
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-createdtime}
|
|
66
66
|
*/
|
|
67
67
|
CreatedTime: string;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Timestamp when the resource was created or last modified.
|
|
70
70
|
* @format date-time
|
|
71
71
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html#cfn-cases-caserule-lastmodifiedtime}
|
|
72
72
|
*/
|
|
73
73
|
LastModifiedTime: string;
|
|
74
74
|
};
|
|
75
75
|
/**
|
|
76
|
-
*
|
|
76
|
+
* Boolean condition for a rule. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
77
77
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleancondition.html}
|
|
78
78
|
*/
|
|
79
79
|
export type BooleanCondition = {
|
|
@@ -82,17 +82,17 @@ export type BooleanCondition = {
|
|
|
82
82
|
NotEqualTo: BooleanOperands;
|
|
83
83
|
};
|
|
84
84
|
/**
|
|
85
|
-
* Boolean operands for a condition.
|
|
85
|
+
* Boolean operands for a condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
86
86
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html}
|
|
87
87
|
*/
|
|
88
88
|
export type BooleanOperands = {
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* Represents the left hand operand in the condition.
|
|
91
91
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html#cfn-cases-caserule-booleanoperands-operandone}
|
|
92
92
|
*/
|
|
93
93
|
OperandOne: OperandOne;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* Represents the right hand operand in the condition.
|
|
96
96
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html#cfn-cases-caserule-booleanoperands-operandtwo}
|
|
97
97
|
*/
|
|
98
98
|
OperandTwo: OperandTwo;
|
|
@@ -103,7 +103,7 @@ export type BooleanOperands = {
|
|
|
103
103
|
Result: boolean;
|
|
104
104
|
};
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* Represents what rule type should take place, under what conditions. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
107
107
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-caseruledetails.html}
|
|
108
108
|
*/
|
|
109
109
|
export type CaseRuleDetails = {
|
|
@@ -112,23 +112,23 @@ export type CaseRuleDetails = {
|
|
|
112
112
|
Hidden: HiddenCaseRule;
|
|
113
113
|
};
|
|
114
114
|
/**
|
|
115
|
-
*
|
|
115
|
+
* A rule that controls field visibility based on conditions. Fields can be shown or hidden dynamically based on values in other fields.
|
|
116
116
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.html}
|
|
117
117
|
*/
|
|
118
118
|
export type HiddenCaseRule = {
|
|
119
119
|
/**
|
|
120
|
-
*
|
|
120
|
+
* A list of conditions that determine field visibility.
|
|
121
121
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.html#cfn-cases-caserule-hiddencaserule-conditions}
|
|
122
122
|
*/
|
|
123
123
|
Conditions: BooleanCondition[];
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* Whether the field is hidden when no conditions match.
|
|
126
126
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.html#cfn-cases-caserule-hiddencaserule-defaultvalue}
|
|
127
127
|
*/
|
|
128
128
|
DefaultValue: boolean;
|
|
129
129
|
};
|
|
130
130
|
/**
|
|
131
|
-
*
|
|
131
|
+
* Represents the left hand operand in the condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
132
132
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandone.html}
|
|
133
133
|
*/
|
|
134
134
|
export type OperandOne = {
|
|
@@ -140,7 +140,7 @@ export type OperandOne = {
|
|
|
140
140
|
FieldId: string;
|
|
141
141
|
};
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* Represents the right hand operand in the condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
144
144
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.html}
|
|
145
145
|
*/
|
|
146
146
|
export type OperandTwo = {
|
|
@@ -164,17 +164,17 @@ export type OperandTwo = {
|
|
|
164
164
|
EmptyValue: Record<string, unknown>;
|
|
165
165
|
};
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* Required rule type, used to indicate whether a field is required. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
|
|
168
168
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.html}
|
|
169
169
|
*/
|
|
170
170
|
export type RequiredCaseRule = {
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
172
|
+
* List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule.
|
|
173
173
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.html#cfn-cases-caserule-requiredcaserule-conditions}
|
|
174
174
|
*/
|
|
175
175
|
Conditions: BooleanCondition[];
|
|
176
176
|
/**
|
|
177
|
-
* The
|
|
177
|
+
* The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.
|
|
178
178
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.html#cfn-cases-caserule-requiredcaserule-defaultvalue}
|
|
179
179
|
*/
|
|
180
180
|
DefaultValue: boolean;
|
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
|
|
4
|
+
*
|
|
5
|
+
* > This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect [CreateIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see [Onboard to Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam) .
|
|
4
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-domain.html}
|
|
5
7
|
*/
|
|
6
8
|
export type CasesDomain = ResourceDefinitionWithAttributes<"AWS::Cases::Domain", CasesDomainProps, CasesDomainAttribs>;
|
|
7
9
|
/**
|
|
8
|
-
*
|
|
10
|
+
* Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
|
|
11
|
+
*
|
|
12
|
+
* > This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect [CreateIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see [Onboard to Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam) .
|
|
9
13
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-domain.html}
|
|
10
14
|
*/
|
|
11
15
|
export type CasesDomainProps = {
|
|
12
16
|
/**
|
|
13
|
-
* The name
|
|
17
|
+
* The name of the domain.
|
|
14
18
|
* @minLength 1
|
|
15
19
|
* @maxLength 100
|
|
16
20
|
* @pattern ^.*[\S]$
|
|
@@ -18,7 +22,7 @@ export type CasesDomainProps = {
|
|
|
18
22
|
*/
|
|
19
23
|
Name: string;
|
|
20
24
|
/**
|
|
21
|
-
*
|
|
25
|
+
* An array of key-value pairs to apply to this resource.
|
|
22
26
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-domain.html#cfn-cases-domain-tags}
|
|
23
27
|
*/
|
|
24
28
|
Tags?: Tag[] | undefined;
|
|
@@ -28,7 +32,7 @@ export type CasesDomainProps = {
|
|
|
28
32
|
*/
|
|
29
33
|
export type CasesDomainAttribs = {
|
|
30
34
|
/**
|
|
31
|
-
* The
|
|
35
|
+
* The timestamp when the Cases domain was created.
|
|
32
36
|
* @format date-time
|
|
33
37
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-domain.html#cfn-cases-domain-createdtime}
|
|
34
38
|
*/
|
|
@@ -48,7 +52,7 @@ export type CasesDomainAttribs = {
|
|
|
48
52
|
*/
|
|
49
53
|
DomainId: string;
|
|
50
54
|
/**
|
|
51
|
-
* The
|
|
55
|
+
* The status of the Cases domain.
|
|
52
56
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-domain.html#cfn-cases-domain-domainstatus}
|
|
53
57
|
*/
|
|
54
58
|
DomainStatus: DomainStatus;
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
|
|
4
4
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html}
|
|
5
5
|
*/
|
|
6
6
|
export type CasesField = ResourceDefinitionWithAttributes<"AWS::Cases::Field", CasesFieldProps, CasesFieldAttribs>;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html}
|
|
10
10
|
*/
|
|
11
11
|
export type CasesFieldProps = {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Description of the field.
|
|
14
14
|
* @maxLength 255
|
|
15
15
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-description}
|
|
16
16
|
*/
|
|
@@ -23,7 +23,7 @@ export type CasesFieldProps = {
|
|
|
23
23
|
*/
|
|
24
24
|
DomainId?: string | undefined;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Name of the field.
|
|
27
27
|
* @minLength 1
|
|
28
28
|
* @maxLength 100
|
|
29
29
|
* @pattern ^.*[\S]$
|
|
@@ -31,12 +31,12 @@ export type CasesFieldProps = {
|
|
|
31
31
|
*/
|
|
32
32
|
Name: string;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* An array of key-value pairs to apply to this resource.
|
|
35
35
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-tags}
|
|
36
36
|
*/
|
|
37
37
|
Tags?: Tag[] | undefined;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Type of the field.
|
|
40
40
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-type}
|
|
41
41
|
*/
|
|
42
42
|
Type: FieldType;
|
|
@@ -46,7 +46,7 @@ export type CasesFieldProps = {
|
|
|
46
46
|
*/
|
|
47
47
|
export type CasesFieldAttribs = {
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Timestamp at which the resource was created.
|
|
50
50
|
* @format date-time
|
|
51
51
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-createdtime}
|
|
52
52
|
*/
|
|
@@ -59,20 +59,20 @@ export type CasesFieldAttribs = {
|
|
|
59
59
|
*/
|
|
60
60
|
FieldArn: string;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Unique identifier of the field.
|
|
63
63
|
* @minLength 1
|
|
64
64
|
* @maxLength 500
|
|
65
65
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-fieldid}
|
|
66
66
|
*/
|
|
67
67
|
FieldId: string;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Timestamp at which the resource was created or last modified.
|
|
70
70
|
* @format date-time
|
|
71
71
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-lastmodifiedtime}
|
|
72
72
|
*/
|
|
73
73
|
LastModifiedTime: string;
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* Namespace of the field.
|
|
76
76
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-namespace}
|
|
77
77
|
*/
|
|
78
78
|
Namespace: "System" | "Custom";
|