@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-cloudtrail-trail.d.ts

@@ -0,0 +1,366 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CloudTrailTrail = ResourceDefinitionWithAttributes<"AWS::CloudTrail::Trail", CloudTrailTrailProps, CloudTrailTrailAttribs>;
+/**
+ * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
+ */
+export type CloudTrailTrailProps = {
+    /**
+     * Specifies the settings for advanced event selectors. You can use advanced event selectors to log management events, data events for all resource types, and network activity events.
+     *
+     * You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either `AdvancedEventSelectors` or `EventSelectors` , but not both. If you apply `AdvancedEventSelectors` to a trail, any existing `EventSelectors` are overwritten. For more information about advanced event selectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
+     */
+    AdvancedEventSelectors?: AdvancedEventSelector[] | undefined;
+    /**
+     * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.
+     *
+     * To enable CloudWatch Logs delivery, you must provide values for `CloudWatchLogsLogGroupArn` and `CloudWatchLogsRoleArn` .
+     *
+     * > If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the `CloudWatchLogsRoleArn` and `CloudWatchLogsLogGroupArn` fields to `""` .
+     */
+    CloudWatchLogsLogGroupArn?: string | undefined;
+    /**
+     * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.
+     *
+     * To enable CloudWatch Logs delivery, you must provide values for `CloudWatchLogsLogGroupArn` and `CloudWatchLogsRoleArn` .
+     *
+     * > If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the `CloudWatchLogsRoleArn` and `CloudWatchLogsLogGroupArn` fields to `""` .
+     */
+    CloudWatchLogsRoleArn?: string | undefined;
+    /**
+     * Specifies whether log file validation is enabled. The default is false.
+     *
+     * > When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
+     */
+    EnableLogFileValidation?: boolean | undefined;
+    /**
+     * Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
+     *
+     * You can configure up to five event selectors for a trail.
+     *
+     * You cannot apply both event selectors and advanced event selectors to a trail.
+     */
+    EventSelectors?: EventSelector[] | undefined;
+    /**
+     * Specifies whether the trail is publishing events from global services such as IAM to the log files.
+     */
+    IncludeGlobalServiceEvents?: boolean | undefined;
+    /**
+     * A JSON string that contains the Insights types you want to log on a trail. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid Insight types.
+     *
+     * The `ApiCallRateInsight` Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
+     *
+     * The `ApiErrorRateInsight` Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
+     */
+    InsightSelectors?: InsightSelector[] | undefined;
+    /**
+     * Whether the CloudTrail trail is currently logging AWS API calls.
+     */
+    IsLogging: boolean;
+    /**
+     * Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
+     */
+    IsMultiRegionTrail?: boolean | undefined;
+    /**
+     * Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account . The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations . If the trail is not an organization trail and this is set to `true` , the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to `false` , the trail will remain in the current AWS account but be deleted from all member accounts in the organization.
+     *
+     * > Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.
+     */
+    IsOrganizationTrail?: boolean | undefined;
+    /**
+     * Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
+     *
+     * CloudTrail also supports AWS KMS multi-Region keys. For more information about multi-Region keys, see [Using multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .
+     *
+     * Examples:
+     *
+     * - alias/MyAliasName
+     * - arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
+     * - arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
+     * - 12345678-1234-1234-1234-123456789012
+     */
+    KMSKeyId?: string | undefined;
+    /**
+     * Specifies the name of the Amazon S3 bucket designated for publishing log files. See [Amazon S3 Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) .
+     */
+    S3BucketName: string;
+    /**
+     * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/get-and-view-cloudtrail-log-files.html#cloudtrail-find-log-files) . The maximum length is 200 characters.
+     * @maxLength 200
+     */
+    S3KeyPrefix?: string | undefined;
+    /**
+     * Specifies the name or ARN of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
+     * @maxLength 256
+     */
+    SnsTopicName?: string | undefined;
+    /**
+     * A custom set of tags (key-value pairs) for this trail.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Specifies the name of the trail. The name must meet the following requirements:
+     *
+     * - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
+     * - Start with a letter or number, and end with a letter or number
+     * - Be between 3 and 128 characters
+     * - Have no adjacent periods, underscores or dashes. Names like `my-_namespace` and `my--namespace` are not valid.
+     * - Not be in IP address format (for example, 192.168.5.4)
+     * @minLength 3
+     * @maxLength 128
+     * @pattern (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\._-])*[a-zA-Z0-9]$)
+     */
+    TrailName?: string | undefined;
+};
+export type CloudTrailTrailAttribs = {
+    /**
+     * `Ref` returns the ARN of the CloudTrail trail, such as `arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail` .
+     */
+    Arn: string;
+    /**
+     * `Ref` returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as `arn:aws:sns:us-east-2:123456789012:mySNSTopic` .
+     */
+    SnsTopicArn: string;
+};
+/**
+ * Advanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) , [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html) , and [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) topics in the *AWS CloudTrail User Guide* .
+ *
+ * You cannot apply both event selectors and advanced event selectors to a trail.
+ *
+ * *Supported CloudTrail event record fields for management events*
+ *
+ * - `eventCategory` (required)
+ * - `eventSource`
+ * - `readOnly`
+ *
+ * The following additional fields are available for event data stores:
+ *
+ * - `eventName`
+ * - `eventType`
+ * - `sessionCredentialFromConsole`
+ * - `userIdentity.arn`
+ *
+ * *Supported CloudTrail event record fields for data events*
+ *
+ * - `eventCategory` (required)
+ * - `eventName`
+ * - `eventSource`
+ * - `eventType`
+ * - `resources.ARN`
+ * - `resources.type` (required)
+ * - `readOnly`
+ * - `sessionCredentialFromConsole`
+ * - `userIdentity.arn`
+ *
+ * *Supported CloudTrail event record fields for network activity events*
+ *
+ * - `eventCategory` (required)
+ * - `eventSource` (required)
+ * - `eventName`
+ * - `errorCode` - The only valid value for `errorCode` is `VpceAccessDenied` .
+ * - `vpcEndpointId`
+ *
+ * > For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is `eventCategory` .
+ */
+export type AdvancedEventSelector = {
+    /**
+     * Contains all selector statements in an advanced event selector.
+     */
+    FieldSelectors: AdvancedFieldSelector[];
+    /**
+     * An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
+     * @minLength 1
+     * @maxLength 1000
+     */
+    Name?: string | undefined;
+};
+/**
+ * A single selector statement in an advanced event selector.
+ */
+export type AdvancedFieldSelector = {
+    /**
+     * An operator that includes events that match the last few characters of the event record field specified as the value of `Field` .
+     */
+    EndsWith?: string[] | undefined;
+    /**
+     * An operator that includes events that match the exact value of the event record field specified as the value of `Field` . This is the only valid operator that you can use with the `readOnly` , `eventCategory` , and `resources.type` fields.
+     */
+    Equals?: string[] | undefined;
+    /**
+     * A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported.
+     *
+     * For CloudTrail management events, supported fields include `eventCategory` (required), `eventSource` , and `readOnly` . The following additional fields are available for event data stores: `eventName` , `eventType` , `sessionCredentialFromConsole` , and `userIdentity.arn` .
+     *
+     * For CloudTrail data events, supported fields include `eventCategory` (required), `eventName` , `eventSource` , `eventType` , `resources.type` (required), `readOnly` , `resources.ARN` , `sessionCredentialFromConsole` , and `userIdentity.arn` .
+     *
+     * For CloudTrail network activity events, supported fields include `eventCategory` (required), `eventSource` (required), `eventName` , `errorCode` , and `vpcEndpointId` .
+     *
+     * For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is `eventCategory` .
+     *
+     * > Selectors don't support the use of wildcards like `*` . To match multiple values with a single condition, you may use `StartsWith` , `EndsWith` , `NotStartsWith` , or `NotEndsWith` to explicitly match the beginning or end of the event field.
+     *
+     * - *`readOnly`* - This is an optional field that is only used for management events and data events. This field can be set to `Equals` with a value of `true` or `false` . If you do not add this field, CloudTrail logs both `read` and `write` events. A value of `true` logs only `read` events. A value of `false` logs only `write` events.
+     * - *`eventSource`* - This field is only used for management events, data events, and network activity events.
+     *
+     * For management events for trails, this is an optional field that can be set to `NotEquals` `kms.amazonaws.com` to exclude KMS management events, or `NotEquals` `rdsdata.amazonaws.com` to exclude RDS management events.
+     *
+     * For data events for trails, this is an optional field that you can use to include or exclude any event source and can use any operator.
+     *
+     * For management and data events for event data stores, this is an optional field that you can use to include or exclude any event source and can use any operator.
+     *
+     * For network activity events, this is a required field that only uses the `Equals` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
+     * - *`eventName`* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with `eventName` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
+     * - *`eventCategory`* - This field is required and must be set to `Equals` .
+     *
+     * - For CloudTrail management events, the value must be `Management` .
+     * - For CloudTrail data events, the value must be `Data` .
+     * - For CloudTrail network activity events, the value must be `NetworkActivity` .
+     *
+     * The following are used only for event data stores:
+     *
+     * - For CloudTrail Insights events, the value must be `Insight` .
+     * - For AWS Config configuration items, the value must be `ConfigurationItem` .
+     * - For Audit Manager evidence, the value must be `Evidence` .
+     * - For events outside of AWS , the value must be `ActivityAuditLog` .
+     * - *`eventType`* - For event data stores, this is an optional field available for event data stores to filter management and data events on the event type. For trails, this is an optional field to filter data events on the event type. For information about available event types, see [CloudTrail record contents](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type) in the *AWS CloudTrail user guide* .
+     * - *`errorCode`* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid `errorCode` is `VpceAccessDenied` . `errorCode` can only use the `Equals` operator.
+     * - *`sessionCredentialFromConsole`* - For event data stores, this is an optional field used to filter management and data events based on whether the events originated from an AWS Management Console session. For trails, this is an optional field used to filter data events. `sessionCredentialFromConsole` can only use the `Equals` and `NotEquals` operators.
+     * - *`resources.type`* - This field is required for CloudTrail data events. `resources.type` can only use the `Equals` operator.
+     *
+     * For a list of available resource types for data events, see [Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) in the *AWS CloudTrail User Guide* .
+     *
+     * You can have only one `resources.type` field per selector. To log events on more than one resource type, add another selector.
+     * - *`resources.ARN`* - The `resources.ARN` is an optional field for data events. You can use any operator with `resources.ARN` , but if you use `Equals` or `NotEquals` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the `StartsWith` operator, and include only the bucket ARN as the matching value.
+     *
+     * For more information about the ARN formats of data event resources, see [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) in the *Service Authorization Reference* .
+     *
+     * > You can't use the `resources.ARN` field to filter resource types that do not have ARNs.
+     * - *`userIdentity.arn`* - For event data stores, this is an optional field used to filter management and data events for actions taken by specific IAM identities. For trails, this is an optional field used to filter data events. You can use any operator with `userIdentity.arn` . For more information on the userIdentity element, see [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide* .
+     * - *`vpcEndpointId`* - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with `vpcEndpointId` .
+     * @minLength 1
+     * @maxLength 1000
+     * @pattern ([\w|\d|\.|_]+)
+     */
+    Field: string;
+    /**
+     * An operator that excludes events that match the last few characters of the event record field specified as the value of `Field` .
+     */
+    NotEndsWith?: string[] | undefined;
+    /**
+     * An operator that excludes events that match the exact value of the event record field specified as the value of `Field` .
+     */
+    NotEquals?: string[] | undefined;
+    /**
+     * An operator that excludes events that match the first few characters of the event record field specified as the value of `Field` .
+     */
+    NotStartsWith?: string[] | undefined;
+    /**
+     * An operator that includes events that match the first few characters of the event record field specified as the value of `Field` .
+     */
+    StartsWith?: string[] | undefined;
+};
+/**
+ * You can configure the `DataResource` in an `EventSelector` to log data events for the following three resource types:
+ *
+ * - `AWS::DynamoDB::Table`
+ * - `AWS::Lambda::Function`
+ * - `AWS::S3::Object`
+ *
+ * To log data events for all other resource types including objects stored in [directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) , you must use [AdvancedEventSelectors](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html) . You must also use `AdvancedEventSelectors` if you want to filter on the `eventName` field.
+ *
+ * Configure the `DataResource` to specify the resource type and resource ARNs for which you want to log data events.
+ *
+ * > The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.
+ *
+ * The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named `amzn-s3-demo-bucket1` . In this example, the CloudTrail user specified an empty prefix, and the option to log both `Read` and `Write` data events.
+ *
+ * - A user uploads an image file to `amzn-s3-demo-bucket1` .
+ * - The `PutObject` API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
+ * - A user uploads an object to an Amazon S3 bucket named `arn:aws:s3:::amzn-s3-demo-bucket1` .
+ * - The `PutObject` API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
+ *
+ * The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named *MyLambdaFunction* , but not for all Lambda functions.
+ *
+ * - A user runs a script that includes a call to the *MyLambdaFunction* function and the *MyOtherLambdaFunction* function.
+ * - The `Invoke` API operation on *MyLambdaFunction* is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for *MyLambdaFunction* , any invocations of that function are logged. The trail processes and logs the event.
+ * - The `Invoke` API operation on *MyOtherLambdaFunction* is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the `Invoke` operation for *MyOtherLambdaFunction* does not match the function specified for the trail. The trail doesn’t log the event.
+ */
+export type DataResource = {
+    /**
+     * The resource type in which you want to log data events. You can specify the following *basic* event selector resource types:
+     *
+     * - `AWS::DynamoDB::Table`
+     * - `AWS::Lambda::Function`
+     * - `AWS::S3::Object`
+     *
+     * Additional resource types are available through *advanced* event selectors. For more information, see [AdvancedEventSelector](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html) .
+     */
+    Type: string;
+    /**
+     * An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
+     *
+     * - To log data events for all objects in all S3 buckets in your AWS account , specify the prefix as `arn:aws:s3` .
+     *
+     * > This also enables logging of data event activity performed by any user or role in your AWS account , even if that activity is performed on a bucket that belongs to another AWS account .
+     * - To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::amzn-s3-demo-bucket1/` . The trail logs data events for all objects in this S3 bucket.
+     * - To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::amzn-s3-demo-bucket1/example-images` . The trail logs data events for objects in this S3 bucket that match the prefix.
+     * - To log data events for all Lambda functions in your AWS account , specify the prefix as `arn:aws:lambda` .
+     *
+     * > This also enables logging of `Invoke` activity performed by any user or role in your AWS account , even if that activity is performed on a function that belongs to another AWS account .
+     * - To log data events for a specific Lambda function, specify the function ARN.
+     *
+     * > Lambda function ARNs are exact. For example, if you specify a function ARN *arn:aws:lambda:us-west-2:111111111111:function:helloworld* , data events will only be logged for *arn:aws:lambda:us-west-2:111111111111:function:helloworld* . They will not be logged for *arn:aws:lambda:us-west-2:111111111111:function:helloworld2* .
+     * - To log data events for all DynamoDB tables in your AWS account , specify the prefix as `arn:aws:dynamodb` .
+     */
+    Values?: string[] | undefined;
+};
+/**
+ * Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
+ *
+ * You can configure up to five event selectors for a trail.
+ *
+ * You cannot apply both event selectors and advanced event selectors to a trail.
+ */
+export type EventSelector = {
+    /**
+     * CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
+     *
+     * For more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide* .
+     *
+     * > To log data events for all other resource types including objects stored in [directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) , you must use [AdvancedEventSelectors](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html) . You must also use `AdvancedEventSelectors` if you want to filter on the `eventName` field.
+     */
+    DataResources?: DataResource[] | undefined;
+    /**
+     * An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing `kms.amazonaws.com` or `rdsdata.amazonaws.com` . By default, `ExcludeManagementEventSources` is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.
+     */
+    ExcludeManagementEventSources?: string[] | undefined;
+    /**
+     * Specify if you want your event selector to include management events for your trail.
+     *
+     * For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
+     *
+     * By default, the value is `true` .
+     *
+     * The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://docs.aws.amazon.com/cloudtrail/pricing/) .
+     */
+    IncludeManagementEvents?: boolean | undefined;
+    /**
+     * Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 `GetConsoleOutput` is a read-only API operation and `RunInstances` is a write-only API operation.
+     *
+     * By default, the value is `All` .
+     */
+    ReadWriteType?: "All" | "ReadOnly" | "WriteOnly" | undefined;
+};
+/**
+ * A JSON string that contains a list of Insights types that are logged on a trail.
+ */
+export type InsightSelector = {
+    /**
+     * The type of Insights events to log on a trail. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid Insight types.
+     *
+     * The `ApiCallRateInsight` Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
+     *
+     * The `ApiErrorRateInsight` Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
+     */
+    InsightType?: string | undefined;
+};
+//# sourceMappingURL=aws-cloudtrail-trail.d.ts.map

package/out/exports/resources.generated/aws-cloudwatch-alarm.d.ts

@@ -0,0 +1,239 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CloudWatchAlarm = ResourceDefinitionWithAttributes<"AWS::CloudWatch::Alarm", CloudWatchAlarmProps, CloudWatchAlarmAttribs>;
+/**
+ * The `AWS::CloudWatch::Alarm` type specifies an alarm and associates it with the specified metric or metric math expression.
+ *
+ * When this operation creates an alarm, the alarm state is immediately set to `INSUFFICIENT_DATA` . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
+ *
+ * When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
+ */
+export type CloudWatchAlarmProps = {
+    /**
+     * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
+     * @default true
+     */
+    ActionsEnabled?: boolean | undefined;
+    /**
+     * The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *Amazon CloudWatch API Reference* .
+     */
+    AlarmActions?: string[] | undefined;
+    /**
+     * The description of the alarm.
+     */
+    AlarmDescription?: string | undefined;
+    /**
+     * The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
+     *
+     * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
+     */
+    AlarmName?: string | undefined;
+    /**
+     * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
+     */
+    ComparisonOperator: string;
+    /**
+     * The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for `EvaluationPeriods` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
+     *
+     * If you omit this parameter, CloudWatch uses the same value here that you set for `EvaluationPeriods` , and the alarm goes to alarm state if that many consecutive periods are breaching.
+     */
+    DatapointsToAlarm?: number | undefined;
+    /**
+     * The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify `Dimensions` . Instead, you use `Metrics` .
+     */
+    Dimensions?: Dimension[] | undefined;
+    /**
+     * Used only for alarms based on percentiles. If `ignore` , the alarm state does not change during periods with too few data points to be statistically significant. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
+     */
+    EvaluateLowSampleCountPercentile?: string | undefined;
+    /**
+     * The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and `DatapointsToAlarm` is the M.
+     *
+     * For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
+     */
+    EvaluationPeriods: number;
+    /**
+     * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
+     *
+     * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
+     *
+     * For an alarm based on a math expression, you can't specify `ExtendedStatistic` . Instead, you use `Metrics` .
+     */
+    ExtendedStatistic?: string | undefined;
+    /**
+     * The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
+     */
+    InsufficientDataActions?: string[] | undefined;
+    /**
+     * The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use `Metrics` instead and you can't specify `MetricName` .
+     */
+    MetricName?: string | undefined;
+    /**
+     * An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
+     *
+     * If you specify the `Metrics` parameter, you cannot specify `MetricName` , `Dimensions` , `Period` , `Namespace` , `Statistic` , `ExtendedStatistic` , or `Unit` .
+     */
+    Metrics?: MetricDataQuery[] | undefined;
+    /**
+     * The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify `Namespace` and you use `Metrics` instead.
+     *
+     * For a list of namespaces for metrics from AWS services, see [AWS Services That Publish CloudWatch Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
+     */
+    Namespace?: string | undefined;
+    /**
+     * The actions to execute when this alarm transitions to the `OK` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
+     */
+    OKActions?: string[] | undefined;
+    /**
+     * The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 20, 30, 60, and any multiple of 60.
+     *
+     * For an alarm based on a math expression, you can't specify `Period` , and instead you use the `Metrics` parameter.
+     *
+     * *Minimum:* 10
+     */
+    Period?: number | undefined;
+    /**
+     * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .
+     *
+     * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
+     *
+     * For an alarm based on a math expression, you can't specify `Statistic` . Instead, you use `Metrics` .
+     */
+    Statistic?: string | undefined;
+    /**
+     * A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the `cloudwatch:TagResource` permission.
+     *
+     * Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The value to compare with the specified statistic.
+     */
+    Threshold?: number | undefined;
+    /**
+     * In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
+     */
+    ThresholdMetricId?: string | undefined;
+    /**
+     * Sets how this alarm is to handle missing data points. Valid values are `breaching` , `notBreaching` , `ignore` , and `missing` . For more information, see [Configuring How CloudWatch Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon CloudWatch User Guide* .
+     *
+     * If you omit this parameter, the default behavior of `missing` is used.
+     */
+    TreatMissingData?: string | undefined;
+    /**
+     * The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a `Metrics` array.
+     *
+     * You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
+     */
+    Unit?: string | undefined;
+};
+export type CloudWatchAlarmAttribs = {
+    /**
+     * The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
+     */
+    Arn: string;
+};
+/**
+ * Dimension is an embedded property of the `AWS::CloudWatch::Alarm` type. Dimensions are name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 30 dimensions for a given metric.
+ */
+export type Dimension = {
+    /**
+     * The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.
+     */
+    Name: string;
+    /**
+     * The value for the dimension, from 1–255 characters in length.
+     */
+    Value: string;
+};
+/**
+ * The `Metric` property type represents a specific metric. `Metric` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.
+ */
+export type Metric = {
+    /**
+     * The metric dimensions that you want to be used for the metric that the alarm will watch.
+     */
+    Dimensions?: Dimension[] | undefined;
+    /**
+     * The name of the metric that you want the alarm to watch. This is a required field.
+     */
+    MetricName?: string | undefined;
+    /**
+     * The namespace of the metric that the alarm will watch.
+     */
+    Namespace?: string | undefined;
+};
+/**
+ * The `MetricDataQuery` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
+ *
+ * Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
+ */
+export type MetricDataQuery = {
+    /**
+     * The ID of the account where the metrics are located, if this is a cross-account alarm.
+     */
+    AccountId?: string | undefined;
+    /**
+     * The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
+     *
+     * Within each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
+     */
+    Expression?: string | undefined;
+    /**
+     * A short name used to tie this object to the results in the response. This name must be unique within a single call to `GetMetricData` . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
+     */
+    Id: string;
+    /**
+     * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If `Label` is omitted, CloudWatch generates a default.
+     */
+    Label?: string | undefined;
+    /**
+     * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
+     *
+     * Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
+     */
+    MetricStat?: MetricStat | undefined;
+    /**
+     * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second` .
+     */
+    Period?: number | undefined;
+    /**
+     * This option indicates whether to return the timestamps and raw data values of this metric.
+     *
+     * When you create an alarm based on a metric math expression, specify `True` for this value for only the one math expression that the alarm is based on. You must specify `False` for `ReturnData` for all the other metrics and expressions used in the alarm.
+     *
+     * This field is required.
+     */
+    ReturnData?: boolean | undefined;
+};
+/**
+ * This structure defines the metric to be returned, along with the statistics, period, and units.
+ *
+ * `MetricStat` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.
+ */
+export type MetricStat = {
+    /**
+     * The metric to return, including the metric name, namespace, and dimensions.
+     */
+    Metric: Metric;
+    /**
+     * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.
+     *
+     * If the `StartTime` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
+     *
+     * - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
+     * - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
+     * - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
+     */
+    Period: number;
+    /**
+     * The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide* .
+     */
+    Stat: string;
+    /**
+     * The unit to use for the returned data points.
+     *
+     * Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
+     */
+    Unit?: string | undefined;
+};
+//# sourceMappingURL=aws-cloudwatch-alarm.d.ts.map