@propulsionworks/cloudformation 0.1.16 → 0.1.17

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.
Files changed (27) hide show
  1. package/out/exports/resources.generated/aws-aiops-investigationgroup.d.ts +53 -13
  2. package/out/exports/resources.generated/aws-arczonalshift-zonalautoshiftconfiguration.d.ts +2 -0
  3. package/out/exports/resources.generated/aws-cassandra-table.d.ts +11 -4
  4. package/out/exports/resources.generated/aws-certificatemanager-certificate.d.ts +4 -0
  5. package/out/exports/resources.generated/aws-cloudformation-hookdefaultversion.d.ts +1 -1
  6. package/out/exports/resources.generated/aws-cloudformation-hooktypeconfig.d.ts +1 -1
  7. package/out/exports/resources.generated/aws-cloudformation-macro.d.ts +1 -0
  8. package/out/exports/resources.generated/aws-cloudformation-stack.d.ts +4 -4
  9. package/out/exports/resources.generated/aws-cloudformation-stackset.d.ts +37 -37
  10. package/out/exports/resources.generated/aws-cloudformation-waitcondition.d.ts +3 -2
  11. package/out/exports/resources.generated/aws-cloudformation-waitconditionhandle.d.ts +1 -1
  12. package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +3 -1
  13. package/out/exports/resources.generated/aws-datasync-locationefs.d.ts +1 -1
  14. package/out/exports/resources.generated/aws-ec2-customergateway.d.ts +1 -1
  15. package/out/exports/resources.generated/aws-ec2-vpnconnection.d.ts +2 -2
  16. package/out/exports/resources.generated/aws-ecs-taskdefinition.d.ts +0 -3
  17. package/out/exports/resources.generated/aws-fsx-filesystem.d.ts +25 -7
  18. package/out/exports/resources.generated/aws-glue-job.d.ts +1 -1
  19. package/out/exports/resources.generated/aws-kinesis-streamconsumer.d.ts +1 -1
  20. package/out/exports/resources.generated/aws-odb-cloudautonomousvmcluster.d.ts +19 -5
  21. package/out/exports/resources.generated/aws-odb-cloudexadatainfrastructure.d.ts +16 -4
  22. package/out/exports/resources.generated/aws-odb-cloudvmcluster.d.ts +28 -10
  23. package/out/exports/resources.generated/aws-odb-odbnetwork.d.ts +13 -3
  24. package/out/exports/resources.generated/aws-quicksight-custompermissions.d.ts +6 -0
  25. package/out/exports/resources.generated/aws-s3tables-table.d.ts +21 -9
  26. package/out/exports/resources.generated/aws-timestream-influxdbinstance.d.ts +1 -1
  27. package/package.json +1 -1
@@ -91,7 +91,7 @@ export type Ec2Config = {
91
91
  */
92
92
  SecurityGroupArns: string[];
93
93
  /**
94
- * Specifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) for managing traffic during your transfer.
94
+ * Specifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces.html) for managing traffic during your transfer.
95
95
  *
96
96
  * The subnet must be located:
97
97
  *
@@ -40,7 +40,7 @@ export type EC2CustomerGatewayProps = {
40
40
  */
41
41
  DeviceName?: string | undefined;
42
42
  /**
43
- * IPv4 address for the customer gateway device's outside interface. The address must be static. If `OutsideIpAddressType` in your VPN connection options is set to `PrivateIpv4` , you can use an RFC6598 or RFC1918 private IPv4 address. If `OutsideIpAddressType` is set to `PublicIpv4` , you can use a public IPv4 address.
43
+ * The IP address for the customer gateway device's outside interface. The address must be static. If `OutsideIpAddressType` in your VPN connection options is set to `PrivateIpv4` , you can use an RFC6598 or RFC1918 private IPv4 address. If `OutsideIpAddressType` is set to `Ipv6` , you can use an IPv6 address.
44
44
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress}
45
45
  */
46
46
  IpAddress: string;
@@ -48,9 +48,9 @@ export type EC2VPNConnectionProps = {
48
48
  */
49
49
  LocalIpv6NetworkCidr?: string | undefined;
50
50
  /**
51
- * The type of IPv4 address assigned to the outside interface of the customer gateway device.
51
+ * The type of IP address assigned to the outside interface of the customer gateway device.
52
52
  *
53
- * Valid values: `PrivateIpv4` | `PublicIpv4`
53
+ * Valid values: `PrivateIpv4` | `PublicIpv4` | `Ipv6`
54
54
  *
55
55
  * Default: `PublicIpv4`
56
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-outsideipaddresstype}
@@ -883,17 +883,14 @@ export type HostVolumeProperties = {
883
883
  SourcePath?: string | undefined;
884
884
  };
885
885
  /**
886
- * Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*.
887
886
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html}
888
887
  */
889
888
  export type InferenceAccelerator = {
890
889
  /**
891
- * The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).
892
890
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicename}
893
891
  */
894
892
  DeviceName?: string | undefined;
895
893
  /**
896
- * The Elastic Inference accelerator type to use.
897
894
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicetype}
898
895
  */
899
896
  DeviceType?: string | undefined;
@@ -52,11 +52,13 @@ export type FSxFileSystemProps = {
52
52
  * - Amazon FSx for NetApp ONTAP
53
53
  * - Amazon FSx for OpenZFS
54
54
  * - Amazon FSx for Windows File Server
55
+ *
56
+ * If this ID isn't specified, the Amazon FSx-managed key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com//kms/latest/APIReference/API_Encrypt.html) in the *AWS Key Management Service API Reference* .
55
57
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid}
56
58
  */
57
59
  KmsKeyId?: string | undefined;
58
60
  /**
59
- * The Lustre configuration for the file system being created.
61
+ * The Lustre configuration for the file system being created. This configuration is required if the `FileSystemType` is set to `LUSTRE` .
60
62
  *
61
63
  * > The following parameters are not supported when creating Lustre file systems with a data repository association.
62
64
  * >
@@ -68,12 +70,12 @@ export type FSxFileSystemProps = {
68
70
  */
69
71
  LustreConfiguration?: LustreConfiguration | undefined;
70
72
  /**
71
- * The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
73
+ * The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. This configuration is required if the `FileSystemType` is set to `ONTAP` .
72
74
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-ontapconfiguration}
73
75
  */
74
76
  OntapConfiguration?: OntapConfiguration | undefined;
75
77
  /**
76
- * The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
78
+ * The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. This configuration is required if the `FileSystemType` is set to `OPENZFS` .
77
79
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-openzfsconfiguration}
78
80
  */
79
81
  OpenZFSConfiguration?: OpenZFSConfiguration | undefined;
@@ -130,9 +132,7 @@ export type FSxFileSystemProps = {
130
132
  */
131
133
  Tags?: Tag[] | undefined;
132
134
  /**
133
- * The configuration object for the Microsoft Windows file system you are creating.
134
- *
135
- * This value is required if `FileSystemType` is set to `WINDOWS` .
135
+ * The configuration object for the Microsoft Windows file system you are creating. This configuration is required if `FileSystemType` is set to `WINDOWS` .
136
136
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration}
137
137
  */
138
138
  WindowsConfiguration?: WindowsConfiguration | undefined;
@@ -231,14 +231,21 @@ export type ClientConfigurations = {
231
231
  Options?: string[] | undefined;
232
232
  };
233
233
  /**
234
+ * The configuration for the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.
234
235
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.html}
235
236
  */
236
237
  export type DataReadCacheConfiguration = {
237
238
  /**
239
+ * Required if `SizingMode` is set to `USER_PROVISIONED` . Specifies the size of the file system's SSD read cache, in gibibytes (GiB).
238
240
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.html#cfn-fsx-filesystem-datareadcacheconfiguration-sizegib}
239
241
  */
240
242
  SizeGiB?: number | undefined;
241
243
  /**
244
+ * Specifies how the provisioned SSD read cache is sized, as follows:
245
+ *
246
+ * - Set to `NO_CACHE` if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
247
+ * - Set to `USER_PROVISIONED` to specify the exact size of your SSD read cache.
248
+ * - Set to `PROPORTIONAL_TO_THROUGHPUT_CAPACITY` to have your SSD read cache automatically sized based on your throughput capacity.
242
249
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.html#cfn-fsx-filesystem-datareadcacheconfiguration-sizingmode}
243
250
  */
244
251
  SizingMode?: string | undefined;
@@ -312,6 +319,7 @@ export type LustreConfiguration = {
312
319
  */
313
320
  DataCompressionType?: string | undefined;
314
321
  /**
322
+ * Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required when `StorageType` is set to `INTELLIGENT_TIERING` .
315
323
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration}
316
324
  */
317
325
  DataReadCacheConfiguration?: DataReadCacheConfiguration | undefined;
@@ -338,6 +346,9 @@ export type LustreConfiguration = {
338
346
  */
339
347
  DriveCacheType?: string | undefined;
340
348
  /**
349
+ * (Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.
350
+ *
351
+ * (Default = `false` )
341
352
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-efaenabled}
342
353
  */
343
354
  EfaEnabled?: boolean | undefined;
@@ -367,6 +378,7 @@ export type LustreConfiguration = {
367
378
  */
368
379
  ImportedFileChunkSize?: number | undefined;
369
380
  /**
381
+ * The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a `PERSISTENT_2` deployment type.
370
382
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-metadataconfiguration}
371
383
  */
372
384
  MetadataConfiguration?: MetadataConfiguration | undefined;
@@ -382,6 +394,7 @@ export type LustreConfiguration = {
382
394
  */
383
395
  PerUnitStorageThroughput?: number | undefined;
384
396
  /**
397
+ * Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.
385
398
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-throughputcapacity}
386
399
  */
387
400
  ThroughputCapacity?: number | undefined;
@@ -394,14 +407,17 @@ export type LustreConfiguration = {
394
407
  WeeklyMaintenanceStartTime?: string | undefined;
395
408
  };
396
409
  /**
410
+ * The configuration that allows you to specify the performance of metadata operations for an FSx for Lustre file system.
397
411
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.html}
398
412
  */
399
413
  export type MetadataConfiguration = {
400
414
  /**
415
+ * The number of Metadata IOPS provisioned for the file system.
401
416
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.html#cfn-fsx-filesystem-metadataconfiguration-iops}
402
417
  */
403
418
  Iops?: number | undefined;
404
419
  /**
420
+ * Specifies whether the file system is using the AUTOMATIC setting of metadata IOPS or if it is using a USER_PROVISIONED value.
405
421
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.html#cfn-fsx-filesystem-metadataconfiguration-mode}
406
422
  */
407
423
  Mode?: string | undefined;
@@ -592,7 +608,9 @@ export type OpenZFSConfiguration = {
592
608
  */
593
609
  RouteTableIds?: string[] | undefined;
594
610
  /**
595
- * Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the `DeploymentType` that you choose, as follows:
611
+ * Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Required if you are creating a new file system.
612
+ *
613
+ * Valid values depend on the `DeploymentType` that you choose, as follows:
596
614
  *
597
615
  * - For `MULTI_AZ_1` and `SINGLE_AZ_2` , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
598
616
  * - For `SINGLE_AZ_1` , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
@@ -161,7 +161,7 @@ export type GlueJobProps = {
161
161
  *
162
162
  * - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
163
163
  * - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
164
- * - For the `G.4X` worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
164
+ * - For the `G.4X` worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Spain), Europe (Stockholm), and South America (São Paulo).
165
165
  * - For the `G.8X` worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for the `G.4X` worker type.
166
166
  * - For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 or later streaming jobs.
167
167
  * - For the `Z.2X` worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
@@ -34,7 +34,7 @@ export type KinesisStreamConsumerProps = {
34
34
  */
35
35
  StreamARN: string;
36
36
  /**
37
- * An arbitrary set of tags (keyvalue pairs) to associate with the Kinesis consumer.
37
+ * An array of tags to be added to a specified Kinesis resource. A tag consists of a required key and an optional value. You can specify up to 50 tag key-value pairs.
38
38
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-tags}
39
39
  */
40
40
  Tags?: Tag[] | undefined;
@@ -1,26 +1,32 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ODB::CloudAutonomousVmCluster resource creates a Cloud Autonomous VM Cluster
3
+ * The `AWS::ODB::CloudAutonomousVmCluster` resource creates an Autonomous VM cluster. An Autonomous VM cluster provides the infrastructure for running Autonomous Databases.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html}
5
5
  */
6
6
  export type ODBCloudAutonomousVmCluster = ResourceDefinitionWithAttributes<"AWS::ODB::CloudAutonomousVmCluster", ODBCloudAutonomousVmClusterProps, ODBCloudAutonomousVmClusterAttribs>;
7
7
  /**
8
- * The AWS::ODB::CloudAutonomousVmCluster resource creates a Cloud Autonomous VM Cluster
8
+ * The `AWS::ODB::CloudAutonomousVmCluster` resource creates an Autonomous VM cluster. An Autonomous VM cluster provides the infrastructure for running Autonomous Databases.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html}
10
10
  */
11
11
  export type ODBCloudAutonomousVmClusterProps = {
12
12
  /**
13
13
  * The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
14
+ *
15
+ * Required when creating an Autonomous VM cluster.
14
16
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-autonomousdatastoragesizeintbs}
15
17
  */
16
18
  AutonomousDataStorageSizeInTBs?: number | undefined;
17
19
  /**
18
20
  * The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
21
+ *
22
+ * Required when creating an Autonomous VM cluster.
19
23
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cloudexadatainfrastructureid}
20
24
  */
21
25
  CloudExadataInfrastructureId?: string | undefined;
22
26
  /**
23
27
  * The number of CPU cores enabled per node in the Autonomous VM cluster.
28
+ *
29
+ * Required when creating an Autonomous VM cluster.
24
30
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cpucorecountpernode}
25
31
  */
26
32
  CpuCoreCountPerNode?: number | undefined;
@@ -36,6 +42,8 @@ export type ODBCloudAutonomousVmClusterProps = {
36
42
  Description?: string | undefined;
37
43
  /**
38
44
  * The display name of the Autonomous VM cluster.
45
+ *
46
+ * Required when creating an Autonomous VM cluster.
39
47
  * @minLength 1
40
48
  * @maxLength 255
41
49
  * @pattern ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$
@@ -43,12 +51,12 @@ export type ODBCloudAutonomousVmClusterProps = {
43
51
  */
44
52
  DisplayName?: string | undefined;
45
53
  /**
46
- * Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
54
+ * Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
47
55
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-ismtlsenabledvmcluster}
48
56
  */
49
57
  IsMtlsEnabledVmCluster?: boolean | undefined;
50
58
  /**
51
- * The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE.
59
+ * The Oracle license model that applies to the Autonomous VM cluster. Valid values are `LICENSE_INCLUDED` or `BRING_YOUR_OWN_LICENSE` .
52
60
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-licensemodel}
53
61
  */
54
62
  LicenseModel?: "BRING_YOUR_OWN_LICENSE" | "LICENSE_INCLUDED" | undefined;
@@ -59,11 +67,15 @@ export type ODBCloudAutonomousVmClusterProps = {
59
67
  MaintenanceWindow?: MaintenanceWindow | undefined;
60
68
  /**
61
69
  * The amount of memory allocated per Oracle Compute Unit, in GB.
70
+ *
71
+ * Required when creating an Autonomous VM cluster.
62
72
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-memoryperoraclecomputeunitingbs}
63
73
  */
64
74
  MemoryPerOracleComputeUnitInGBs?: number | undefined;
65
75
  /**
66
76
  * The unique identifier of the ODB network associated with this Autonomous VM cluster.
77
+ *
78
+ * Required when creating an Autonomous VM cluster.
67
79
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-odbnetworkid}
68
80
  */
69
81
  OdbNetworkId?: string | undefined;
@@ -82,7 +94,7 @@ export type ODBCloudAutonomousVmClusterProps = {
82
94
  */
83
95
  ScanListenerPortTls?: number | undefined;
84
96
  /**
85
- * The tags associated with the Autonomous VM cluster.
97
+ * Tags to assign to the Autonomous Vm Cluster.
86
98
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-tags}
87
99
  */
88
100
  Tags?: Tag[] | undefined;
@@ -95,6 +107,8 @@ export type ODBCloudAutonomousVmClusterProps = {
95
107
  TimeZone?: string | undefined;
96
108
  /**
97
109
  * The total number of Autonomous Container Databases that can be created with the allocated local storage.
110
+ *
111
+ * Required when creating an Autonomous VM cluster.
98
112
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-totalcontainerdatabases}
99
113
  */
100
114
  TotalContainerDatabases?: number | undefined;
@@ -1,16 +1,18 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ODB::CloudExadataInfrastructure resource creates an Exadata Infrastructure
3
+ * The `AWS::ODB::CloudExadataInfrastructure` resource creates an Exadata infrastructure. An Exadata infrastructure provides the underlying compute and storage resources for Oracle Database workloads.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html}
5
5
  */
6
6
  export type ODBCloudExadataInfrastructure = ResourceDefinitionWithAttributes<"AWS::ODB::CloudExadataInfrastructure", ODBCloudExadataInfrastructureProps, ODBCloudExadataInfrastructureAttribs>;
7
7
  /**
8
- * The AWS::ODB::CloudExadataInfrastructure resource creates an Exadata Infrastructure
8
+ * The `AWS::ODB::CloudExadataInfrastructure` resource creates an Exadata infrastructure. An Exadata infrastructure provides the underlying compute and storage resources for Oracle Database workloads.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html}
10
10
  */
11
11
  export type ODBCloudExadataInfrastructureProps = {
12
12
  /**
13
13
  * The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
14
+ *
15
+ * Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.
14
16
  * @minLength 1
15
17
  * @maxLength 255
16
18
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-availabilityzone}
@@ -18,6 +20,8 @@ export type ODBCloudExadataInfrastructureProps = {
18
20
  AvailabilityZone?: string | undefined;
19
21
  /**
20
22
  * The AZ ID of the AZ where the Exadata infrastructure is located.
23
+ *
24
+ * Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.
21
25
  * @minLength 1
22
26
  * @maxLength 255
23
27
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-availabilityzoneid}
@@ -25,6 +29,8 @@ export type ODBCloudExadataInfrastructureProps = {
25
29
  AvailabilityZoneId?: string | undefined;
26
30
  /**
27
31
  * The number of database servers for the Exadata infrastructure.
32
+ *
33
+ * Required when creating an Exadata infrastructure.
28
34
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-computecount}
29
35
  */
30
36
  ComputeCount?: number | undefined;
@@ -34,7 +40,7 @@ export type ODBCloudExadataInfrastructureProps = {
34
40
  */
35
41
  CustomerContactsToSendToOCI?: CustomerContact[] | undefined;
36
42
  /**
37
- * The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
43
+ * The database server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.
38
44
  * @minLength 1
39
45
  * @maxLength 255
40
46
  * @pattern ^[a-zA-Z0-9_\/.=-]+$
@@ -43,6 +49,8 @@ export type ODBCloudExadataInfrastructureProps = {
43
49
  DatabaseServerType?: string | undefined;
44
50
  /**
45
51
  * The user-friendly name for the Exadata infrastructure.
52
+ *
53
+ * Required when creating an Exadata infrastructure.
46
54
  * @minLength 1
47
55
  * @maxLength 255
48
56
  * @pattern ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$
@@ -51,6 +59,8 @@ export type ODBCloudExadataInfrastructureProps = {
51
59
  DisplayName?: string | undefined;
52
60
  /**
53
61
  * The model name of the Exadata infrastructure.
62
+ *
63
+ * Required when creating an Exadata infrastructure.
54
64
  * @minLength 1
55
65
  * @maxLength 255
56
66
  * @pattern ^[a-zA-Z0-9_\/.=-]+$
@@ -59,11 +69,13 @@ export type ODBCloudExadataInfrastructureProps = {
59
69
  Shape?: string | undefined;
60
70
  /**
61
71
  * The number of storage servers that are activated for the Exadata infrastructure.
72
+ *
73
+ * Required when creating an Exadata infrastructure.
62
74
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-storagecount}
63
75
  */
64
76
  StorageCount?: number | undefined;
65
77
  /**
66
- * The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
78
+ * The storage server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.
67
79
  * @minLength 1
68
80
  * @maxLength 255
69
81
  * @pattern ^[a-zA-Z0-9_\/.=-]+$
@@ -1,16 +1,18 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ODB::CloudVmCluster resource creates a Cloud VM Cluster
3
+ * The `AWS::ODB::CloudVmCluster` resource creates a VM cluster on the specified Exadata infrastructure in the Oracle Database. A VM cluster provides the compute resources for Oracle Database workloads.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html}
5
5
  */
6
6
  export type ODBCloudVmCluster = ResourceDefinitionWithAttributes<"AWS::ODB::CloudVmCluster", ODBCloudVmClusterProps, ODBCloudVmClusterAttribs>;
7
7
  /**
8
- * The AWS::ODB::CloudVmCluster resource creates a Cloud VM Cluster
8
+ * The `AWS::ODB::CloudVmCluster` resource creates a VM cluster on the specified Exadata infrastructure in the Oracle Database. A VM cluster provides the compute resources for Oracle Database workloads.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html}
10
10
  */
11
11
  export type ODBCloudVmClusterProps = {
12
12
  /**
13
13
  * The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
14
+ *
15
+ * Required when creating a VM cluster.
14
16
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-cloudexadatainfrastructureid}
15
17
  */
16
18
  CloudExadataInfrastructureId?: string | undefined;
@@ -24,13 +26,15 @@ export type ODBCloudVmClusterProps = {
24
26
  ClusterName?: string | undefined;
25
27
  /**
26
28
  * The number of CPU cores enabled on the VM cluster.
29
+ *
30
+ * Required when creating a VM cluster.
27
31
  * @min 0
28
32
  * @max 368
29
33
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-cpucorecount}
30
34
  */
31
35
  CpuCoreCount?: number | undefined;
32
36
  /**
33
- * Information about the data collection options enabled for a VM cluster.
37
+ * The set of diagnostic collection options enabled for the VM cluster.
34
38
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-datacollectionoptions}
35
39
  */
36
40
  DataCollectionOptions?: DataCollectionOptions | undefined;
@@ -51,6 +55,8 @@ export type ODBCloudVmClusterProps = {
51
55
  DbServers?: string[] | undefined;
52
56
  /**
53
57
  * The user-friendly name for the VM cluster.
58
+ *
59
+ * Required when creating a VM cluster.
54
60
  * @minLength 1
55
61
  * @maxLength 255
56
62
  * @pattern ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$
@@ -59,6 +65,8 @@ export type ODBCloudVmClusterProps = {
59
65
  DisplayName?: string | undefined;
60
66
  /**
61
67
  * The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
68
+ *
69
+ * Required when creating a VM cluster.
62
70
  * @minLength 1
63
71
  * @maxLength 255
64
72
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-giversion}
@@ -66,6 +74,8 @@ export type ODBCloudVmClusterProps = {
66
74
  GiVersion?: string | undefined;
67
75
  /**
68
76
  * The host name for the VM cluster.
77
+ *
78
+ * Required when creating a VM cluster.
69
79
  * @minLength 1
70
80
  * @maxLength 12
71
81
  * @pattern ^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$
@@ -73,12 +83,12 @@ export type ODBCloudVmClusterProps = {
73
83
  */
74
84
  Hostname?: string | undefined;
75
85
  /**
76
- * Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
86
+ * Specifies whether database backups to local Exadata storage are enabled for the VM cluster.
77
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-islocalbackupenabled}
78
88
  */
79
89
  IsLocalBackupEnabled?: boolean | undefined;
80
90
  /**
81
- * Indicates whether the VM cluster is configured with a sparse disk group.
91
+ * Specifies whether the VM cluster is configured with a sparse disk group.
82
92
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-issparsediskgroupenabled}
83
93
  */
84
94
  IsSparseDiskgroupEnabled?: boolean | undefined;
@@ -94,11 +104,17 @@ export type ODBCloudVmClusterProps = {
94
104
  MemorySizeInGBs?: number | undefined;
95
105
  /**
96
106
  * The unique identifier of the ODB network for the VM cluster.
107
+ *
108
+ * Required when creating a VM cluster.
97
109
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-odbnetworkid}
98
110
  */
99
111
  OdbNetworkId?: string | undefined;
100
112
  /**
101
- * Property description not available.
113
+ * The port number for TCP connections to the single client access name (SCAN) listener.
114
+ *
115
+ * Valid values: `1024–8999` with the following exceptions: `2484` , `6100` , `6200` , `7060` , `7070` , `7085` , and `7879`
116
+ *
117
+ * Default: `1521`
102
118
  * @min 1024
103
119
  * @max 8999
104
120
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-scanlistenerporttcp}
@@ -106,6 +122,8 @@ export type ODBCloudVmClusterProps = {
106
122
  ScanListenerPortTcp?: number | undefined;
107
123
  /**
108
124
  * The public key portion of one or more key pairs used for SSH access to the VM cluster.
125
+ *
126
+ * Required when creating a VM cluster.
109
127
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-sshpublickeys}
110
128
  */
111
129
  SshPublicKeys?: string[] | undefined;
@@ -149,7 +167,7 @@ export type ODBCloudVmClusterAttribs = {
149
167
  */
150
168
  ComputeModel: string;
151
169
  /**
152
- * The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
170
+ * The type of redundancy configured for the VM cluster. `NORMAL` is 2-way redundancy. `HIGH` is 3-way redundancy.
153
171
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-diskredundancy}
154
172
  */
155
173
  DiskRedundancy: string;
@@ -215,17 +233,17 @@ export type ODBCloudVmClusterAttribs = {
215
233
  */
216
234
  export type DataCollectionOptions = {
217
235
  /**
218
- * Indicates whether diagnostic collection is enabled for the VM cluster.
236
+ * Specifies whether diagnostic collection is enabled for the VM cluster.
219
237
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-isdiagnosticseventsenabled}
220
238
  */
221
239
  IsDiagnosticsEventsEnabled?: boolean | undefined;
222
240
  /**
223
- * Indicates whether health monitoring is enabled for the VM cluster.
241
+ * Specifies whether health monitoring is enabled for the VM cluster.
224
242
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-ishealthmonitoringenabled}
225
243
  */
226
244
  IsHealthMonitoringEnabled?: boolean | undefined;
227
245
  /**
228
- * Indicates whether incident logs are enabled for the cloud VM cluster.
246
+ * Specifies whether incident logs are enabled for the VM cluster.
229
247
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-isincidentlogsenabled}
230
248
  */
231
249
  IsIncidentLogsEnabled?: boolean | undefined;
@@ -1,16 +1,18 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ODB::OdbNetwork resource creates an ODB Network
3
+ * The `AWS::ODB::OdbNetwork` resource creates an ODB network. An ODB network provides the networking foundation for Oracle Database resources.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html}
5
5
  */
6
6
  export type ODBOdbNetwork = ResourceDefinitionWithAttributes<"AWS::ODB::OdbNetwork", ODBOdbNetworkProps, ODBOdbNetworkAttribs>;
7
7
  /**
8
- * The AWS::ODB::OdbNetwork resource creates an ODB Network
8
+ * The `AWS::ODB::OdbNetwork` resource creates an ODB network. An ODB network provides the networking foundation for Oracle Database resources.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html}
10
10
  */
11
11
  export type ODBOdbNetworkProps = {
12
12
  /**
13
- * The AWS Availability Zone (AZ) where the ODB network is located.
13
+ * The Availability Zone (AZ) where the ODB network is located.
14
+ *
15
+ * Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.
14
16
  * @minLength 1
15
17
  * @maxLength 255
16
18
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzone}
@@ -18,6 +20,8 @@ export type ODBOdbNetworkProps = {
18
20
  AvailabilityZone?: string | undefined;
19
21
  /**
20
22
  * The AZ ID of the AZ where the ODB network is located.
23
+ *
24
+ * Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.
21
25
  * @minLength 1
22
26
  * @maxLength 255
23
27
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzoneid}
@@ -32,6 +36,8 @@ export type ODBOdbNetworkProps = {
32
36
  BackupSubnetCidr?: string | undefined;
33
37
  /**
34
38
  * The CIDR range of the client subnet in the ODB network.
39
+ *
40
+ * Required when creating an ODB network.
35
41
  * @minLength 1
36
42
  * @maxLength 255
37
43
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-clientsubnetcidr}
@@ -46,11 +52,15 @@ export type ODBOdbNetworkProps = {
46
52
  DefaultDnsPrefix?: string | undefined;
47
53
  /**
48
54
  * Specifies whether to delete associated OCI networking resources along with the ODB network.
55
+ *
56
+ * Required when creating an ODB network.
49
57
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-deleteassociatedresources}
50
58
  */
51
59
  DeleteAssociatedResources?: boolean | undefined;
52
60
  /**
53
61
  * The user-friendly name of the ODB network.
62
+ *
63
+ * Required when creating an ODB network.
54
64
  * @minLength 1
55
65
  * @maxLength 255
56
66
  * @pattern ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$
@@ -97,6 +97,7 @@ export type Capabilities = {
97
97
  */
98
98
  ExportToCsv?: CapabilityState | undefined;
99
99
  /**
100
+ * The ability to export to CSV files in scheduled email reports.
100
101
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttocsvinscheduledreports}
101
102
  */
102
103
  ExportToCsvInScheduledReports?: CapabilityState | undefined;
@@ -106,22 +107,27 @@ export type Capabilities = {
106
107
  */
107
108
  ExportToExcel?: CapabilityState | undefined;
108
109
  /**
110
+ * The ability to export to Excel files in scheduled email reports.
109
111
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttoexcelinscheduledreports}
110
112
  */
111
113
  ExportToExcelInScheduledReports?: CapabilityState | undefined;
112
114
  /**
115
+ * The ability to export to PDF files from the UI.
113
116
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttopdf}
114
117
  */
115
118
  ExportToPdf?: CapabilityState | undefined;
116
119
  /**
120
+ * The ability to export to PDF files in scheduled email reports.
117
121
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttopdfinscheduledreports}
118
122
  */
119
123
  ExportToPdfInScheduledReports?: CapabilityState | undefined;
120
124
  /**
125
+ * The ability to include content in scheduled email reports.
121
126
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-includecontentinscheduledreportsemail}
122
127
  */
123
128
  IncludeContentInScheduledReportsEmail?: CapabilityState | undefined;
124
129
  /**
130
+ * The ability to print reports.
125
131
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-printreports}
126
132
  */
127
133
  PrintReports?: CapabilityState | undefined;