@propulsionworks/cloudformation 0.1.30 → 0.1.32

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 (86) hide show
  1. package/out/exports/resources.generated/aws-applicationsignals-groupingconfiguration.d.ts +1 -1
  2. package/out/exports/resources.generated/aws-aps-anomalydetector.d.ts +168 -0
  3. package/out/exports/resources.generated/aws-bedrock-guardrail.d.ts +1 -1
  4. package/out/exports/resources.generated/aws-bedrockagentcore-browsercustom.d.ts +0 -4
  5. package/out/exports/resources.generated/aws-bedrockagentcore-codeinterpretercustom.d.ts +0 -4
  6. package/out/exports/resources.generated/aws-bedrockagentcore-gateway.d.ts +0 -4
  7. package/out/exports/resources.generated/aws-bedrockagentcore-gatewaytarget.d.ts +0 -4
  8. package/out/exports/resources.generated/aws-bedrockagentcore-memory.d.ts +85 -27
  9. package/out/exports/resources.generated/aws-bedrockagentcore-runtime.d.ts +0 -4
  10. package/out/exports/resources.generated/aws-bedrockagentcore-runtimeendpoint.d.ts +0 -4
  11. package/out/exports/resources.generated/aws-billingconductor-billinggroup.d.ts +1 -1
  12. package/out/exports/resources.generated/aws-billingconductor-pricingplan.d.ts +1 -1
  13. package/out/exports/resources.generated/aws-cloudfront-anycastiplist.d.ts +8 -0
  14. package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +4 -0
  15. package/out/exports/resources.generated/aws-cloudfront-vpcorigin.d.ts +4 -0
  16. package/out/exports/resources.generated/aws-connect-emailaddress.d.ts +17 -0
  17. package/out/exports/resources.generated/aws-connect-evaluationform.d.ts +155 -0
  18. package/out/exports/resources.generated/aws-customerprofiles-objecttype.d.ts +1 -1
  19. package/out/exports/resources.generated/aws-datazone-domain.d.ts +1 -1
  20. package/out/exports/resources.generated/aws-datazone-environmentblueprintconfiguration.d.ts +1 -1
  21. package/out/exports/resources.generated/aws-docdb-dbcluster.d.ts +7 -0
  22. package/out/exports/resources.generated/aws-dynamodb-globaltable.d.ts +0 -8
  23. package/out/exports/resources.generated/aws-dynamodb-table.d.ts +0 -4
  24. package/out/exports/resources.generated/aws-ec2-capacitymanagerdataexport.d.ts +46 -0
  25. package/out/exports/resources.generated/aws-ec2-capacityreservation.d.ts +3 -3
  26. package/out/exports/resources.generated/aws-ec2-natgateway.d.ts +9 -0
  27. package/out/exports/resources.generated/aws-ec2-volume.d.ts +14 -16
  28. package/out/exports/resources.generated/aws-ecr-repository.d.ts +4 -2
  29. package/out/exports/resources.generated/aws-ecr-repositorycreationtemplate.d.ts +2 -2
  30. package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +3 -0
  31. package/out/exports/resources.generated/aws-ecs-clustercapacityproviderassociations.d.ts +1 -1
  32. package/out/exports/resources.generated/aws-ecs-service.d.ts +11 -1
  33. package/out/exports/resources.generated/aws-elasticloadbalancingv2-listener.d.ts +8 -4
  34. package/out/exports/resources.generated/aws-elasticloadbalancingv2-listenerrule.d.ts +84 -8
  35. package/out/exports/resources.generated/aws-elasticloadbalancingv2-loadbalancer.d.ts +1 -0
  36. package/out/exports/resources.generated/aws-emrserverless-application.d.ts +4 -4
  37. package/out/exports/resources.generated/aws-events-eventbuspolicy.d.ts +14 -11
  38. package/out/exports/resources.generated/aws-events-rule.d.ts +4 -4
  39. package/out/exports/resources.generated/aws-fsx-filesystem.d.ts +4 -0
  40. package/out/exports/resources.generated/aws-imagebuilder-component.d.ts +20 -0
  41. package/out/exports/resources.generated/aws-imagebuilder-image.d.ts +118 -0
  42. package/out/exports/resources.generated/aws-imagebuilder-imagepipeline.d.ts +5 -0
  43. package/out/exports/resources.generated/aws-imagebuilder-workflow.d.ts +20 -0
  44. package/out/exports/resources.generated/aws-lambda-permission.d.ts +4 -3
  45. package/out/exports/resources.generated/aws-logs-deliverydestination.d.ts +1 -1
  46. package/out/exports/resources.generated/aws-logs-metricfilter.d.ts +2 -0
  47. package/out/exports/resources.generated/aws-logs-subscriptionfilter.d.ts +2 -0
  48. package/out/exports/resources.generated/aws-medialive-channel.d.ts +36 -0
  49. package/out/exports/resources.generated/aws-mediapackagev2-originendpoint.d.ts +50 -2
  50. package/out/exports/resources.generated/aws-neptune-dbinstance.d.ts +9 -0
  51. package/out/exports/resources.generated/aws-observabilityadmin-organizationcentralizationrule.d.ts +29 -3
  52. package/out/exports/resources.generated/aws-observabilityadmin-organizationtelemetryrule.d.ts +20 -20
  53. package/out/exports/resources.generated/aws-observabilityadmin-telemetryrule.d.ts +20 -20
  54. package/out/exports/resources.generated/aws-odb-odbpeeringconnection.d.ts +2 -2
  55. package/out/exports/resources.generated/aws-organizations-account.d.ts +5 -0
  56. package/out/exports/resources.generated/aws-osis-pipeline.d.ts +22 -1
  57. package/out/exports/resources.generated/aws-quicksight-analysis.d.ts +69 -69
  58. package/out/exports/resources.generated/aws-quicksight-custompermissions.d.ts +1 -1
  59. package/out/exports/resources.generated/aws-quicksight-dashboard.d.ts +73 -69
  60. package/out/exports/resources.generated/aws-quicksight-dataset.d.ts +11 -11
  61. package/out/exports/resources.generated/aws-quicksight-datasource.d.ts +22 -22
  62. package/out/exports/resources.generated/aws-quicksight-refreshschedule.d.ts +3 -3
  63. package/out/exports/resources.generated/aws-quicksight-template.d.ts +70 -70
  64. package/out/exports/resources.generated/aws-quicksight-theme.d.ts +7 -7
  65. package/out/exports/resources.generated/aws-rds-dbcluster.d.ts +7 -11
  66. package/out/exports/resources.generated/aws-route53-recordset.d.ts +1 -3
  67. package/out/exports/resources.generated/aws-route53-recordsetgroup.d.ts +1 -3
  68. package/out/exports/resources.generated/aws-route53resolver-resolverrule.d.ts +2 -0
  69. package/out/exports/resources.generated/aws-route53resolver-resolverruleassociation.d.ts +2 -0
  70. package/out/exports/resources.generated/aws-rtbfabric-link.d.ts +137 -0
  71. package/out/exports/resources.generated/aws-rtbfabric-requestergateway.d.ts +72 -0
  72. package/out/exports/resources.generated/aws-rtbfabric-respondergateway.d.ts +151 -0
  73. package/out/exports/resources.generated/aws-sagemaker-app.d.ts +1 -1
  74. package/out/exports/resources.generated/aws-sagemaker-cluster.d.ts +21 -0
  75. package/out/exports/resources.generated/aws-sagemaker-domain.d.ts +12 -2
  76. package/out/exports/resources.generated/aws-sagemaker-userprofile.d.ts +1 -1
  77. package/out/exports/resources.generated/aws-servicecatalog-launchnotificationconstraint.d.ts +1 -0
  78. package/out/exports/resources.generated/aws-servicecatalog-tagoptionassociation.d.ts +4 -13
  79. package/out/exports/resources.generated/aws-ssm-patchbaseline.d.ts +5 -1
  80. package/out/exports/resources.generated/aws-ssmquicksetup-lifecycleautomation.d.ts +52 -0
  81. package/out/exports/resources.generated/aws-synthetics-canary.d.ts +99 -0
  82. package/out/exports/resources.generated/aws-transfer-connector.d.ts +2 -0
  83. package/out/exports/resources.generated/aws-transfer-server.d.ts +4 -0
  84. package/out/exports/resources.generated/aws-vpclattice-resourcegateway.d.ts +1 -1
  85. package/out/exports/resources.generated/aws-wisdom-aiprompt.d.ts +1 -1
  86. package/package.json +1 -1
@@ -41,10 +41,12 @@ export type LogsSubscriptionFilterProps = {
41
41
  */
42
42
  Distribution?: "Random" | "ByLogStream" | undefined;
43
43
  /**
44
+ * The list of system fields that are included in the log events sent to the subscription destination. Returns the `emitSystemFields` value if it was specified when the subscription filter was created.
44
45
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-emitsystemfields}
45
46
  */
46
47
  EmitSystemFields?: string[] | undefined;
47
48
  /**
49
+ * The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the `fieldSelectionCriteria` value if it was specified when the subscription filter was created.
48
50
  * @minLength 0
49
51
  * @maxLength 2000
50
52
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-fieldselectioncriteria}
@@ -3847,6 +3847,42 @@ export type MediaPackageV2GroupSettings = {
3847
3847
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-captionlanguagemappings}
3848
3848
  */
3849
3849
  CaptionLanguageMappings?: CaptionLanguageMapping[] | undefined;
3850
+ /**
3851
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-id3behavior}
3852
+ */
3853
+ Id3Behavior?: string | undefined;
3854
+ /**
3855
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-klvbehavior}
3856
+ */
3857
+ KlvBehavior?: string | undefined;
3858
+ /**
3859
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-nielsenid3behavior}
3860
+ */
3861
+ NielsenId3Behavior?: string | undefined;
3862
+ /**
3863
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-scte35type}
3864
+ */
3865
+ Scte35Type?: string | undefined;
3866
+ /**
3867
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-segmentlength}
3868
+ */
3869
+ SegmentLength?: number | undefined;
3870
+ /**
3871
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-segmentlengthunits}
3872
+ */
3873
+ SegmentLengthUnits?: string | undefined;
3874
+ /**
3875
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadataid3frame}
3876
+ */
3877
+ TimedMetadataId3Frame?: string | undefined;
3878
+ /**
3879
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadataid3period}
3880
+ */
3881
+ TimedMetadataId3Period?: number | undefined;
3882
+ /**
3883
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadatapassthrough}
3884
+ */
3885
+ TimedMetadataPassthrough?: string | undefined;
3850
3886
  };
3851
3887
  /**
3852
3888
  * Settings to enable and configure the motion graphics overlay feature in the channel.
@@ -57,6 +57,11 @@ export type MediaPackageV2OriginEndpointProps = {
57
57
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifests}
58
58
  */
59
59
  LowLatencyHlsManifests?: LowLatencyHlsManifestConfiguration[] | undefined;
60
+ /**
61
+ * <p>The Microsoft Smooth Streaming (MSS) manifest configurations associated with this origin endpoint.</p>
62
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-mssmanifests}
63
+ */
64
+ MssManifests?: MssManifestConfiguration[] | undefined;
60
65
  /**
61
66
  * The name of the origin endpoint associated with the origin endpoint configuration.
62
67
  * @minLength 1
@@ -119,6 +124,10 @@ export type MediaPackageV2OriginEndpointAttribs = {
119
124
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-modifiedat}
120
125
  */
121
126
  ModifiedAt: string;
127
+ /**
128
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-mssmanifesturls}
129
+ */
130
+ MssManifestUrls: string[];
122
131
  };
123
132
  /**
124
133
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-admarkerdash.html}
@@ -127,7 +136,7 @@ export type AdMarkerDash = "BINARY" | "XML";
127
136
  /**
128
137
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-admarkerhls.html}
129
138
  */
130
- export type AdMarkerHls = "DATERANGE";
139
+ export type AdMarkerHls = "DATERANGE" | "SCTE35_ENHANCED";
131
140
  /**
132
141
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-cmafencryptionmethod.html}
133
142
  */
@@ -135,7 +144,7 @@ export type CmafEncryptionMethod = "CENC" | "CBCS";
135
144
  /**
136
145
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-containertype.html}
137
146
  */
138
- export type ContainerType = "TS" | "CMAF";
147
+ export type ContainerType = "TS" | "CMAF" | "ISM";
139
148
  /**
140
149
  * The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.
141
150
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html}
@@ -548,6 +557,10 @@ export type EncryptionMethod = {
548
557
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-cmafencryptionmethod}
549
558
  */
550
559
  CmafEncryptionMethod?: CmafEncryptionMethod | undefined;
560
+ /**
561
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-ismencryptionmethod}
562
+ */
563
+ IsmEncryptionMethod?: IsmEncryptionMethod | undefined;
551
564
  /**
552
565
  * The encryption method to use.
553
566
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-tsencryptionmethod}
@@ -664,6 +677,10 @@ export type HlsManifestConfiguration = {
664
677
  */
665
678
  UrlEncodeChildManifest?: boolean | undefined;
666
679
  };
680
+ /**
681
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-ismencryptionmethod.html}
682
+ */
683
+ export type IsmEncryptionMethod = "CENC";
667
684
  /**
668
685
  * Specify a low-latency HTTP live streaming (LL-HLS) manifest configuration.
669
686
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html}
@@ -718,6 +735,37 @@ export type LowLatencyHlsManifestConfiguration = {
718
735
  */
719
736
  UrlEncodeChildManifest?: boolean | undefined;
720
737
  };
738
+ /**
739
+ * <p>Configuration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered.</p>
740
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html}
741
+ */
742
+ export type MssManifestConfiguration = {
743
+ /**
744
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-filterconfiguration}
745
+ */
746
+ FilterConfiguration?: FilterConfiguration | undefined;
747
+ /**
748
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestlayout}
749
+ */
750
+ ManifestLayout?: MssManifestLayout | undefined;
751
+ /**
752
+ * <p>The name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest.</p>
753
+ * @minLength 1
754
+ * @maxLength 256
755
+ * @pattern ^[a-zA-Z0-9-]+$
756
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestname}
757
+ */
758
+ ManifestName: string;
759
+ /**
760
+ * <p>The duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time.</p>
761
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestwindowseconds}
762
+ */
763
+ ManifestWindowSeconds?: number | undefined;
764
+ };
765
+ /**
766
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestlayout.html}
767
+ */
768
+ export type MssManifestLayout = "FULL" | "COMPACT";
721
769
  /**
722
770
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-presetspeke20audio.html}
723
771
  */
@@ -111,6 +111,15 @@ export type NeptuneDBInstanceProps = {
111
111
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow}
112
112
  */
113
113
  PreferredMaintenanceWindow?: string | undefined;
114
+ /**
115
+ * Indicates whether the DB instance is publicly accessible.
116
+ *
117
+ * When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
118
+ *
119
+ * When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
120
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-publiclyaccessible}
121
+ */
122
+ PubliclyAccessible?: boolean | undefined;
114
123
  /**
115
124
  * An arbitrary set of tags (key-value pairs) for this DB instance.
116
125
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags}
@@ -1,11 +1,11 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * Resource schema for AWS:ObservabilityAdmin:OrganizationCentralizationRule
3
+ * Defines how telemetry data should be centralized across an AWS Organization, including source and destination configurations.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html}
5
5
  */
6
6
  export type ObservabilityAdminOrganizationCentralizationRule = ResourceDefinitionWithAttributes<"AWS::ObservabilityAdmin::OrganizationCentralizationRule", ObservabilityAdminOrganizationCentralizationRuleProps, ObservabilityAdminOrganizationCentralizationRuleAttribs>;
7
7
  /**
8
- * Resource schema for AWS:ObservabilityAdmin:OrganizationCentralizationRule
8
+ * Defines how telemetry data should be centralized across an AWS Organization, including source and destination configurations.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html}
10
10
  */
11
11
  export type ObservabilityAdminOrganizationCentralizationRuleProps = {
@@ -14,6 +14,7 @@ export type ObservabilityAdminOrganizationCentralizationRuleProps = {
14
14
  */
15
15
  Rule: CentralizationRule;
16
16
  /**
17
+ * The name of the organization centralization rule.
17
18
  * @minLength 1
18
19
  * @maxLength 100
19
20
  * @pattern ^[0-9A-Za-z-]+$
@@ -21,7 +22,7 @@ export type ObservabilityAdminOrganizationCentralizationRuleProps = {
21
22
  */
22
23
  RuleName: string;
23
24
  /**
24
- * An array of key-value pairs to apply to this resource.
25
+ * A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see [What are tags?](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html)
25
26
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-tags}
26
27
  */
27
28
  Tags?: Tag[] | undefined;
@@ -31,6 +32,7 @@ export type ObservabilityAdminOrganizationCentralizationRuleProps = {
31
32
  */
32
33
  export type ObservabilityAdminOrganizationCentralizationRuleAttribs = {
33
34
  /**
35
+ * The Amazon Resource Name (ARN) of the organization centralization rule.
34
36
  * @minLength 1
35
37
  * @maxLength 1011
36
38
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -39,106 +41,130 @@ export type ObservabilityAdminOrganizationCentralizationRuleAttribs = {
39
41
  RuleArn: string;
40
42
  };
41
43
  /**
44
+ * Defines how telemetry data should be centralized across an AWS Organization, including source and destination configurations.
42
45
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html}
43
46
  */
44
47
  export type CentralizationRule = {
45
48
  /**
49
+ * Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
46
50
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrule-destination}
47
51
  */
48
52
  Destination: CentralizationRuleDestination;
49
53
  /**
54
+ * Configuration determining the source of the telemetry data to be centralized.
50
55
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrule-source}
51
56
  */
52
57
  Source: CentralizationRuleSource;
53
58
  };
54
59
  /**
60
+ * Configuration specifying the primary destination for centralized telemetry data.
55
61
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html}
56
62
  */
57
63
  export type CentralizationRuleDestination = {
58
64
  /**
65
+ * The destination account (within the organization) to which the telemetry data should be centralized.
59
66
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-account}
60
67
  */
61
68
  Account?: string | undefined;
62
69
  /**
70
+ * Log specific configuration for centralization destination log groups.
63
71
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-destinationlogsconfiguration}
64
72
  */
65
73
  DestinationLogsConfiguration?: DestinationLogsConfiguration | undefined;
66
74
  /**
75
+ * The primary destination region to which telemetry data should be centralized.
67
76
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-region}
68
77
  */
69
78
  Region: string;
70
79
  };
71
80
  /**
81
+ * Configuration specifying the source of telemetry data to be centralized.
72
82
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html}
73
83
  */
74
84
  export type CentralizationRuleSource = {
75
85
  /**
86
+ * The list of source regions from which telemetry data should be centralized.
76
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-regions}
77
88
  */
78
89
  Regions: string[];
79
90
  /**
91
+ * The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
80
92
  * @minLength 1
81
93
  * @maxLength 2000
82
94
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-scope}
83
95
  */
84
96
  Scope?: string | undefined;
85
97
  /**
98
+ * Log specific configuration for centralization source log groups.
86
99
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-sourcelogsconfiguration}
87
100
  */
88
101
  SourceLogsConfiguration?: SourceLogsConfiguration | undefined;
89
102
  };
90
103
  /**
104
+ * Configuration for centralization destination log groups, including encryption and backup settings.
91
105
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html}
92
106
  */
93
107
  export type DestinationLogsConfiguration = {
94
108
  /**
109
+ * Configuration defining the backup region and an optional KMS key for the backup destination.
95
110
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration-backupconfiguration}
96
111
  */
97
112
  BackupConfiguration?: LogsBackupConfiguration | undefined;
98
113
  /**
114
+ * The encryption configuration for centralization destination log groups.
99
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration-logsencryptionconfiguration}
100
116
  */
101
117
  LogsEncryptionConfiguration?: LogsEncryptionConfiguration | undefined;
102
118
  };
103
119
  /**
120
+ * Configuration for backing up centralized log data to a secondary region.
104
121
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html}
105
122
  */
106
123
  export type LogsBackupConfiguration = {
107
124
  /**
125
+ * KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
108
126
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration-kmskeyarn}
109
127
  */
110
128
  KmsKeyArn?: string | undefined;
111
129
  /**
130
+ * Logs specific backup destination region within the primary destination account to which log data should be centralized.
112
131
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration-region}
113
132
  */
114
133
  Region: string;
115
134
  };
116
135
  /**
136
+ * Configuration for encrypting centralized log groups. This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys.
117
137
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html}
118
138
  */
119
139
  export type LogsEncryptionConfiguration = {
120
140
  /**
141
+ * Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
121
142
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-encryptionconflictresolutionstrategy}
122
143
  */
123
144
  EncryptionConflictResolutionStrategy?: "ALLOW" | "SKIP" | undefined;
124
145
  /**
146
+ * Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
125
147
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-encryptionstrategy}
126
148
  */
127
149
  EncryptionStrategy: "CUSTOMER_MANAGED" | "AWS_OWNED";
128
150
  /**
151
+ * KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
129
152
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-kmskeyarn}
130
153
  */
131
154
  KmsKeyArn?: string | undefined;
132
155
  };
133
156
  /**
157
+ * Configuration for selecting and handling source log groups for centralization.
134
158
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html}
135
159
  */
136
160
  export type SourceLogsConfiguration = {
137
161
  /**
162
+ * A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
138
163
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration-encryptedloggroupstrategy}
139
164
  */
140
165
  EncryptedLogGroupStrategy: "ALLOW" | "SKIP";
141
166
  /**
167
+ * The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
142
168
  * @minLength 1
143
169
  * @maxLength 2000
144
170
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration-loggroupselectioncriteria}
@@ -1,21 +1,21 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule.
3
+ * Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html}
5
5
  */
6
6
  export type ObservabilityAdminOrganizationTelemetryRule = ResourceDefinitionWithAttributes<"AWS::ObservabilityAdmin::OrganizationTelemetryRule", ObservabilityAdminOrganizationTelemetryRuleProps, ObservabilityAdminOrganizationTelemetryRuleAttribs>;
7
7
  /**
8
- * The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule.
8
+ * Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html}
10
10
  */
11
11
  export type ObservabilityAdminOrganizationTelemetryRuleProps = {
12
12
  /**
13
- * The telemetry rule
13
+ * The name of the organization telemetry rule.
14
14
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-rule}
15
15
  */
16
16
  Rule: TelemetryRule;
17
17
  /**
18
- * The name of the organization telemetry rule
18
+ * The name of the organization centralization rule.
19
19
  * @minLength 1
20
20
  * @maxLength 100
21
21
  * @pattern ^[0-9A-Za-z-]+$
@@ -23,7 +23,7 @@ export type ObservabilityAdminOrganizationTelemetryRuleProps = {
23
23
  */
24
24
  RuleName: string;
25
25
  /**
26
- * An array of key-value pairs to apply to this resource
26
+ * Lists all tags attached to the specified telemetry rule resource.
27
27
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-tags}
28
28
  */
29
29
  Tags?: Tag[] | undefined;
@@ -52,58 +52,58 @@ export type DestinationType = "cloud-watch-logs";
52
52
  */
53
53
  export type ResourceType = "AWS::EC2::VPC";
54
54
  /**
55
- * The destination configuration for telemetry data
55
+ * Configuration specifying where and how telemetry data should be delivered for AWS resources.
56
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html}
57
57
  */
58
58
  export type TelemetryDestinationConfiguration = {
59
59
  /**
60
- * Pattern for telemetry data destination
60
+ * The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
61
61
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationpattern}
62
62
  */
63
63
  DestinationPattern?: string | undefined;
64
64
  /**
65
- * Type of telemetry destination
65
+ * The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
66
66
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationtype}
67
67
  */
68
68
  DestinationType?: DestinationType | undefined;
69
69
  /**
70
- * Number of days to retain the telemetry data in the specified destination
70
+ * The number of days to retain the telemetry data in the destination.
71
71
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-retentionindays}
72
72
  */
73
73
  RetentionInDays?: number | undefined;
74
74
  /**
75
- * Telemetry parameters for VPC Flow logs
75
+ * Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
76
76
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters}
77
77
  */
78
78
  VPCFlowLogParameters?: VPCFlowLogParameters | undefined;
79
79
  };
80
80
  /**
81
- * The telemetry rule
81
+ * Defines how telemetry should be configured for specific AWS resources.
82
82
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html}
83
83
  */
84
84
  export type TelemetryRule = {
85
85
  /**
86
- * The destination configuration for telemetry data
86
+ * Configuration specifying where and how the telemetry data should be delivered.
87
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-destinationconfiguration}
88
88
  */
89
89
  DestinationConfiguration?: TelemetryDestinationConfiguration | undefined;
90
90
  /**
91
- * Resource Type associated with the Organization Telemetry Rule
91
+ * The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
92
92
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-resourcetype}
93
93
  */
94
94
  ResourceType: ResourceType;
95
95
  /**
96
- * Selection Criteria on scope level for rule application
96
+ * The organizational scope to which the rule applies, specified using accounts or organizational units.
97
97
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-scope}
98
98
  */
99
99
  Scope?: string | undefined;
100
100
  /**
101
- * Selection Criteria on resource level for rule application
101
+ * Criteria for selecting which resources the rule applies to, such as resource tags.
102
102
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-selectioncriteria}
103
103
  */
104
104
  SelectionCriteria?: string | undefined;
105
105
  /**
106
- * Telemetry Type associated with the Organization Telemetry Rule
106
+ * The type of telemetry to collect (Logs, Metrics, or Traces).
107
107
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-telemetrytype}
108
108
  */
109
109
  TelemetryType: TelemetryType;
@@ -114,22 +114,22 @@ export type TelemetryRule = {
114
114
  */
115
115
  export type TelemetryType = "Logs";
116
116
  /**
117
- * Telemetry parameters for VPC Flow logs
117
+ * Configuration parameters specific to VPC Flow Logs.
118
118
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html}
119
119
  */
120
120
  export type VPCFlowLogParameters = {
121
121
  /**
122
- * The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
122
+ * The format in which VPC Flow Log entries should be logged.
123
123
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-logformat}
124
124
  */
125
125
  LogFormat?: string | undefined;
126
126
  /**
127
- * The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
127
+ * The maximum interval in seconds between the capture of flow log records.
128
128
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-maxaggregationinterval}
129
129
  */
130
130
  MaxAggregationInterval?: number | undefined;
131
131
  /**
132
- * The type of traffic captured for the flow log. Default is ALL
132
+ * The type of traffic to log (ACCEPT, REJECT, or ALL).
133
133
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-traffictype}
134
134
  */
135
135
  TrafficType?: string | undefined;
@@ -1,21 +1,21 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.
3
+ * Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html}
5
5
  */
6
6
  export type ObservabilityAdminTelemetryRule = ResourceDefinitionWithAttributes<"AWS::ObservabilityAdmin::TelemetryRule", ObservabilityAdminTelemetryRuleProps, ObservabilityAdminTelemetryRuleAttribs>;
7
7
  /**
8
- * The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.
8
+ * Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.
9
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html}
10
10
  */
11
11
  export type ObservabilityAdminTelemetryRuleProps = {
12
12
  /**
13
- * The telemetry rule
13
+ * Retrieves the details of a specific telemetry rule in your account.
14
14
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#cfn-observabilityadmin-telemetryrule-rule}
15
15
  */
16
16
  Rule: TelemetryRule;
17
17
  /**
18
- * The name of the telemetry rule
18
+ * The name of the telemetry rule.
19
19
  * @minLength 1
20
20
  * @maxLength 100
21
21
  * @pattern ^[0-9A-Za-z-]+$
@@ -23,7 +23,7 @@ export type ObservabilityAdminTelemetryRuleProps = {
23
23
  */
24
24
  RuleName: string;
25
25
  /**
26
- * An array of key-value pairs to apply to this resource
26
+ * Lists all tags attached to the specified telemetry rule resource.
27
27
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#cfn-observabilityadmin-telemetryrule-tags}
28
28
  */
29
29
  Tags?: Tag[] | undefined;
@@ -33,7 +33,7 @@ export type ObservabilityAdminTelemetryRuleProps = {
33
33
  */
34
34
  export type ObservabilityAdminTelemetryRuleAttribs = {
35
35
  /**
36
- * The arn of the telemetry rule
36
+ * The Amazon Resource Name (ARN) of the telemetry rule.
37
37
  * @minLength 1
38
38
  * @maxLength 1011
39
39
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -52,53 +52,53 @@ export type DestinationType = "cloud-watch-logs";
52
52
  */
53
53
  export type ResourceType = "AWS::EC2::VPC";
54
54
  /**
55
- * The destination configuration for telemetry data
55
+ * Configuration specifying where and how telemetry data should be delivered for AWS resources.
56
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html}
57
57
  */
58
58
  export type TelemetryDestinationConfiguration = {
59
59
  /**
60
- * Pattern for telemetry data destination
60
+ * The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
61
61
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationpattern}
62
62
  */
63
63
  DestinationPattern?: string | undefined;
64
64
  /**
65
- * Type of telemetry destination
65
+ * The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
66
66
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationtype}
67
67
  */
68
68
  DestinationType?: DestinationType | undefined;
69
69
  /**
70
- * Number of days to retain the telemetry data in the specified destination
70
+ * The number of days to retain the telemetry data in the destination.
71
71
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-retentionindays}
72
72
  */
73
73
  RetentionInDays?: number | undefined;
74
74
  /**
75
- * Telemetry parameters for VPC Flow logs
75
+ * Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
76
76
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters}
77
77
  */
78
78
  VPCFlowLogParameters?: VPCFlowLogParameters | undefined;
79
79
  };
80
80
  /**
81
- * The telemetry rule
81
+ * Defines how telemetry should be configured for specific AWS resources.
82
82
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html}
83
83
  */
84
84
  export type TelemetryRule = {
85
85
  /**
86
- * The destination configuration for telemetry data
86
+ * Configuration specifying where and how the telemetry data should be delivered.
87
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-destinationconfiguration}
88
88
  */
89
89
  DestinationConfiguration?: TelemetryDestinationConfiguration | undefined;
90
90
  /**
91
- * Resource Type associated with the Telemetry Rule
91
+ * The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
92
92
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-resourcetype}
93
93
  */
94
94
  ResourceType: ResourceType;
95
95
  /**
96
- * Selection Criteria on resource level for rule application
96
+ * Criteria for selecting which resources the rule applies to, such as resource tags.
97
97
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-selectioncriteria}
98
98
  */
99
99
  SelectionCriteria?: string | undefined;
100
100
  /**
101
- * Telemetry Type associated with the Telemetry Rule
101
+ * The type of telemetry to collect (Logs, Metrics, or Traces).
102
102
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrytype}
103
103
  */
104
104
  TelemetryType: TelemetryType;
@@ -109,22 +109,22 @@ export type TelemetryRule = {
109
109
  */
110
110
  export type TelemetryType = "Logs";
111
111
  /**
112
- * Telemetry parameters for VPC Flow logs
112
+ * Configuration parameters specific to VPC Flow Logs.
113
113
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html}
114
114
  */
115
115
  export type VPCFlowLogParameters = {
116
116
  /**
117
- * The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
117
+ * The format in which VPC Flow Log entries should be logged.
118
118
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-logformat}
119
119
  */
120
120
  LogFormat?: string | undefined;
121
121
  /**
122
- * The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
122
+ * The maximum interval in seconds between the capture of flow log records.
123
123
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-maxaggregationinterval}
124
124
  */
125
125
  MaxAggregationInterval?: number | undefined;
126
126
  /**
127
- * The type of traffic captured for the flow log. Default is ALL
127
+ * The type of traffic to log (ACCEPT, REJECT, or ALL).
128
128
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-traffictype}
129
129
  */
130
130
  TrafficType?: string | undefined;