@btc-embedded/cdk-extensions 0.10.4 → 0.11.0

package/API.md

@@ -859,6 +859,542 @@ public readonly targetGroup: IApplicationTargetGroup;
 ---
 
 
+### BTCLogGroup <a name="BTCLogGroup" id="@btc-embedded/cdk-extensions.BTCLogGroup"></a>
+
+A log group with sensible defaults.
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.BTCLogGroup.Initializer"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+new BTCLogGroup(scope: Construct, id: string, options: BTCLogGroupOptions)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.options">options</a></code> | <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroupOptions">BTCLogGroupOptions</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `options`<sup>Required</sup> <a name="options" id="@btc-embedded/cdk-extensions.BTCLogGroup.Initializer.parameter.options"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.BTCLogGroupOptions">BTCLogGroupOptions</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.addMetricFilter">addMetricFilter</a></code> | Create a new Metric Filter on this Log Group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.addStream">addStream</a></code> | Create a new Log Stream for this Log Group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.addSubscriptionFilter">addSubscriptionFilter</a></code> | Create a new Subscription Filter on this Log Group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.addToResourcePolicy">addToResourcePolicy</a></code> | Adds a statement to the resource policy associated with this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.extractMetric">extractMetric</a></code> | Extract a metric from structured log events in the LogGroup. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.grant">grant</a></code> | Give the indicated permissions on this log group and all streams. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.grantRead">grantRead</a></code> | Give permissions to read and filter events from this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.grantWrite">grantWrite</a></code> | Give permissions to create and write to streams in this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.logGroupPhysicalName">logGroupPhysicalName</a></code> | Public method to get the physical name of this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.metric">metric</a></code> | Creates a CloudWatch metric for this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingBytes">metricIncomingBytes</a></code> | Creates a CloudWatch metric for the volume of incoming log data in bytes to this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingLogEvents">metricIncomingLogEvents</a></code> | Creates a CloudWatch metric for the number of incoming log events to this log group. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.BTCLogGroup.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@btc-embedded/cdk-extensions.BTCLogGroup.applyRemovalPolicy"></a>
+
+```typescript
+public applyRemovalPolicy(policy: RemovalPolicy): void
+```
+
+Apply the given removal policy to this resource.
+
+The Removal Policy controls what happens to this resource when it stops
+being managed by CloudFormation, either because you've removed it from the
+CDK application or because you've made a change that requires the resource
+to be replaced.
+
+The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
+account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
+
+###### `policy`<sup>Required</sup> <a name="policy" id="@btc-embedded/cdk-extensions.BTCLogGroup.applyRemovalPolicy.parameter.policy"></a>
+
+- *Type:* aws-cdk-lib.RemovalPolicy
+
+---
+
+##### `addMetricFilter` <a name="addMetricFilter" id="@btc-embedded/cdk-extensions.BTCLogGroup.addMetricFilter"></a>
+
+```typescript
+public addMetricFilter(id: string, props: MetricFilterOptions): MetricFilter
+```
+
+Create a new Metric Filter on this Log Group.
+
+###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.addMetricFilter.parameter.id"></a>
+
+- *Type:* string
+
+Unique identifier for the construct in its parent.
+
+---
+
+###### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.addMetricFilter.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_logs.MetricFilterOptions
+
+Properties for creating the MetricFilter.
+
+---
+
+##### `addStream` <a name="addStream" id="@btc-embedded/cdk-extensions.BTCLogGroup.addStream"></a>
+
+```typescript
+public addStream(id: string, props?: StreamOptions): LogStream
+```
+
+Create a new Log Stream for this Log Group.
+
+###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.addStream.parameter.id"></a>
+
+- *Type:* string
+
+Unique identifier for the construct in its parent.
+
+---
+
+###### `props`<sup>Optional</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.addStream.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_logs.StreamOptions
+
+Properties for creating the LogStream.
+
+---
+
+##### `addSubscriptionFilter` <a name="addSubscriptionFilter" id="@btc-embedded/cdk-extensions.BTCLogGroup.addSubscriptionFilter"></a>
+
+```typescript
+public addSubscriptionFilter(id: string, props: SubscriptionFilterOptions): SubscriptionFilter
+```
+
+Create a new Subscription Filter on this Log Group.
+
+###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.addSubscriptionFilter.parameter.id"></a>
+
+- *Type:* string
+
+Unique identifier for the construct in its parent.
+
+---
+
+###### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.addSubscriptionFilter.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_logs.SubscriptionFilterOptions
+
+Properties for creating the SubscriptionFilter.
+
+---
+
+##### `addToResourcePolicy` <a name="addToResourcePolicy" id="@btc-embedded/cdk-extensions.BTCLogGroup.addToResourcePolicy"></a>
+
+```typescript
+public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult
+```
+
+Adds a statement to the resource policy associated with this log group.
+
+A resource policy will be automatically created upon the first call to `addToResourcePolicy`.
+
+Any ARN Principals inside of the statement will be converted into AWS Account ID strings
+because CloudWatch Logs Resource Policies do not accept ARN principals.
+
+###### `statement`<sup>Required</sup> <a name="statement" id="@btc-embedded/cdk-extensions.BTCLogGroup.addToResourcePolicy.parameter.statement"></a>
+
+- *Type:* aws-cdk-lib.aws_iam.PolicyStatement
+
+The policy statement to add.
+
+---
+
+##### `extractMetric` <a name="extractMetric" id="@btc-embedded/cdk-extensions.BTCLogGroup.extractMetric"></a>
+
+```typescript
+public extractMetric(jsonField: string, metricNamespace: string, metricName: string): Metric
+```
+
+Extract a metric from structured log events in the LogGroup.
+
+Creates a MetricFilter on this LogGroup that will extract the value
+of the indicated JSON field in all records where it occurs.
+
+The metric will be available in CloudWatch Metrics under the
+indicated namespace and name.
+
+###### `jsonField`<sup>Required</sup> <a name="jsonField" id="@btc-embedded/cdk-extensions.BTCLogGroup.extractMetric.parameter.jsonField"></a>
+
+- *Type:* string
+
+JSON field to extract (example: '$.myfield').
+
+---
+
+###### `metricNamespace`<sup>Required</sup> <a name="metricNamespace" id="@btc-embedded/cdk-extensions.BTCLogGroup.extractMetric.parameter.metricNamespace"></a>
+
+- *Type:* string
+
+Namespace to emit the metric under.
+
+---
+
+###### `metricName`<sup>Required</sup> <a name="metricName" id="@btc-embedded/cdk-extensions.BTCLogGroup.extractMetric.parameter.metricName"></a>
+
+- *Type:* string
+
+Name to emit the metric under.
+
+---
+
+##### `grant` <a name="grant" id="@btc-embedded/cdk-extensions.BTCLogGroup.grant"></a>
+
+```typescript
+public grant(grantee: IGrantable, actions: ...string[]): Grant
+```
+
+Give the indicated permissions on this log group and all streams.
+
+###### `grantee`<sup>Required</sup> <a name="grantee" id="@btc-embedded/cdk-extensions.BTCLogGroup.grant.parameter.grantee"></a>
+
+- *Type:* aws-cdk-lib.aws_iam.IGrantable
+
+---
+
+###### `actions`<sup>Required</sup> <a name="actions" id="@btc-embedded/cdk-extensions.BTCLogGroup.grant.parameter.actions"></a>
+
+- *Type:* ...string[]
+
+---
+
+##### `grantRead` <a name="grantRead" id="@btc-embedded/cdk-extensions.BTCLogGroup.grantRead"></a>
+
+```typescript
+public grantRead(grantee: IGrantable): Grant
+```
+
+Give permissions to read and filter events from this log group.
+
+###### `grantee`<sup>Required</sup> <a name="grantee" id="@btc-embedded/cdk-extensions.BTCLogGroup.grantRead.parameter.grantee"></a>
+
+- *Type:* aws-cdk-lib.aws_iam.IGrantable
+
+---
+
+##### `grantWrite` <a name="grantWrite" id="@btc-embedded/cdk-extensions.BTCLogGroup.grantWrite"></a>
+
+```typescript
+public grantWrite(grantee: IGrantable): Grant
+```
+
+Give permissions to create and write to streams in this log group.
+
+###### `grantee`<sup>Required</sup> <a name="grantee" id="@btc-embedded/cdk-extensions.BTCLogGroup.grantWrite.parameter.grantee"></a>
+
+- *Type:* aws-cdk-lib.aws_iam.IGrantable
+
+---
+
+##### `logGroupPhysicalName` <a name="logGroupPhysicalName" id="@btc-embedded/cdk-extensions.BTCLogGroup.logGroupPhysicalName"></a>
+
+```typescript
+public logGroupPhysicalName(): string
+```
+
+Public method to get the physical name of this log group.
+
+##### `metric` <a name="metric" id="@btc-embedded/cdk-extensions.BTCLogGroup.metric"></a>
+
+```typescript
+public metric(metricName: string, props?: MetricOptions): Metric
+```
+
+Creates a CloudWatch metric for this log group.
+
+###### `metricName`<sup>Required</sup> <a name="metricName" id="@btc-embedded/cdk-extensions.BTCLogGroup.metric.parameter.metricName"></a>
+
+- *Type:* string
+
+The name of the metric to create.
+
+---
+
+###### `props`<sup>Optional</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.metric.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
+
+Optional.
+
+Additional properties to configure the metric.
+
+---
+
+##### `metricIncomingBytes` <a name="metricIncomingBytes" id="@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingBytes"></a>
+
+```typescript
+public metricIncomingBytes(props?: MetricOptions): Metric
+```
+
+Creates a CloudWatch metric for the volume of incoming log data in bytes to this log group.
+
+###### `props`<sup>Optional</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingBytes.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
+
+Optional.
+
+Configuration options for the metric.
+
+---
+
+##### `metricIncomingLogEvents` <a name="metricIncomingLogEvents" id="@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingLogEvents"></a>
+
+```typescript
+public metricIncomingLogEvents(props?: MetricOptions): Metric
+```
+
+Creates a CloudWatch metric for the number of incoming log events to this log group.
+
+###### `props`<sup>Optional</sup> <a name="props" id="@btc-embedded/cdk-extensions.BTCLogGroup.metricIncomingLogEvents.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
+
+Optional.
+
+Configuration options for the metric.
+
+---
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupArn">fromLogGroupArn</a></code> | Import an existing LogGroup given its ARN. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupName">fromLogGroupName</a></code> | Import an existing LogGroup given its name. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.BTCLogGroup.isConstruct"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+BTCLogGroup.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.BTCLogGroup.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+##### `isOwnedResource` <a name="isOwnedResource" id="@btc-embedded/cdk-extensions.BTCLogGroup.isOwnedResource"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+BTCLogGroup.isOwnedResource(construct: IConstruct)
+```
+
+Returns true if the construct was created by CDK, and false otherwise.
+
+###### `construct`<sup>Required</sup> <a name="construct" id="@btc-embedded/cdk-extensions.BTCLogGroup.isOwnedResource.parameter.construct"></a>
+
+- *Type:* constructs.IConstruct
+
+---
+
+##### `isResource` <a name="isResource" id="@btc-embedded/cdk-extensions.BTCLogGroup.isResource"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+BTCLogGroup.isResource(construct: IConstruct)
+```
+
+Check whether the given construct is a Resource.
+
+###### `construct`<sup>Required</sup> <a name="construct" id="@btc-embedded/cdk-extensions.BTCLogGroup.isResource.parameter.construct"></a>
+
+- *Type:* constructs.IConstruct
+
+---
+
+##### `fromLogGroupArn` <a name="fromLogGroupArn" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupArn"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+BTCLogGroup.fromLogGroupArn(scope: Construct, id: string, logGroupArn: string)
+```
+
+Import an existing LogGroup given its ARN.
+
+###### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupArn.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupArn.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+###### `logGroupArn`<sup>Required</sup> <a name="logGroupArn" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupArn.parameter.logGroupArn"></a>
+
+- *Type:* string
+
+---
+
+##### `fromLogGroupName` <a name="fromLogGroupName" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupName"></a>
+
+```typescript
+import { BTCLogGroup } from '@btc-embedded/cdk-extensions'
+
+BTCLogGroup.fromLogGroupName(scope: Construct, id: string, logGroupName: string)
+```
+
+Import an existing LogGroup given its name.
+
+###### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupName.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupName.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+###### `logGroupName`<sup>Required</sup> <a name="logGroupName" id="@btc-embedded/cdk-extensions.BTCLogGroup.fromLogGroupName.parameter.logGroupName"></a>
+
+- *Type:* string
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.property.logGroupArn">logGroupArn</a></code> | <code>string</code> | The ARN of this log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroup.property.logGroupName">logGroupName</a></code> | <code>string</code> | The name of this log group. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.BTCLogGroup.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="@btc-embedded/cdk-extensions.BTCLogGroup.property.env"></a>
+
+```typescript
+public readonly env: ResourceEnvironment;
+```
+
+- *Type:* aws-cdk-lib.ResourceEnvironment
+
+The environment this resource belongs to.
+
+For resources that are created and managed by the CDK
+(generally, those created by creating new class instances like Role, Bucket, etc.),
+this is always the same as the environment of the stack they belong to;
+however, for imported resources
+(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
+that might be different than the stack they were imported into.
+
+---
+
+##### `stack`<sup>Required</sup> <a name="stack" id="@btc-embedded/cdk-extensions.BTCLogGroup.property.stack"></a>
+
+```typescript
+public readonly stack: Stack;
+```
+
+- *Type:* aws-cdk-lib.Stack
+
+The stack in which this resource is defined.
+
+---
+
+##### `logGroupArn`<sup>Required</sup> <a name="logGroupArn" id="@btc-embedded/cdk-extensions.BTCLogGroup.property.logGroupArn"></a>
+
+```typescript
+public readonly logGroupArn: string;
+```
+
+- *Type:* string
+
+The ARN of this log group.
+
+---
+
+##### `logGroupName`<sup>Required</sup> <a name="logGroupName" id="@btc-embedded/cdk-extensions.BTCLogGroup.property.logGroupName"></a>
+
+```typescript
+public readonly logGroupName: string;
+```
+
+- *Type:* string
+
+The name of this log group.
+
+---
+
+
 ### CognitoUserPool <a name="CognitoUserPool" id="@btc-embedded/cdk-extensions.CognitoUserPool"></a>
 
 #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.CognitoUserPool.Initializer"></a>
@@ -4170,6 +4706,66 @@ public readonly basePlatform: string;
 
 ---
 
+### BTCLogGroupOptions <a name="BTCLogGroupOptions" id="@btc-embedded/cdk-extensions.BTCLogGroupOptions"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.BTCLogGroupOptions.Initializer"></a>
+
+```typescript
+import { BTCLogGroupOptions } from '@btc-embedded/cdk-extensions'
+
+const bTCLogGroupOptions: BTCLogGroupOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.logType">logType</a></code> | <code>string</code> | Specify the log type to be used as a prefix in the log group: /app-name/type/... |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.appName">appName</a></code> | <code>string</code> | Name of the application. |
+| <code><a href="#@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.retention">retention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | Specify how long the logs should be kept. |
+
+---
+
+##### `logType`<sup>Required</sup> <a name="logType" id="@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.logType"></a>
+
+```typescript
+public readonly logType: string;
+```
+
+- *Type:* string
+
+Specify the log type to be used as a prefix in the log group: /app-name/type/...
+
+---
+
+##### `appName`<sup>Optional</sup> <a name="appName" id="@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.appName"></a>
+
+```typescript
+public readonly appName: string;
+```
+
+- *Type:* string
+- *Default:* the stack name
+
+Name of the application.
+
+This name will be used as a prefix for the log group name.
+
+---
+
+##### `retention`<sup>Optional</sup> <a name="retention" id="@btc-embedded/cdk-extensions.BTCLogGroupOptions.property.retention"></a>
+
+```typescript
+public readonly retention: RetentionDays;
+```
+
+- *Type:* aws-cdk-lib.aws_logs.RetentionDays
+- *Default:* one month
+
+Specify how long the logs should be kept.
+
+---
+
 ### CloudMapExtensionProps <a name="CloudMapExtensionProps" id="@btc-embedded/cdk-extensions.CloudMapExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.CloudMapExtensionProps.Initializer"></a>
@@ -5931,7 +6527,7 @@ const eventPipeProps: EventPipeProps = { ... }
 | <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.source">source</a></code> | <code>aws-cdk-lib.aws_sqs.IQueue</code> | The source SQS queue. |
 | <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.target">target</a></code> | <code><a href="#@btc-embedded/cdk-extensions.TargetQueue">TargetQueue</a> \| <a href="#@btc-embedded/cdk-extensions.TargetStepFunction">TargetStepFunction</a></code> | The target SQS queue or target step function. |
 | <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.filter">filter</a></code> | <code><a href="#@btc-embedded/cdk-extensions.PipeFilter">PipeFilter</a></code> | An optional filter for the pipe. |
-| <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.logGroup">logGroup</a></code> | <code>aws-cdk-lib.aws_logs.LogGroup</code> | Use an existing log group. |
+| <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.logGroup">logGroup</a></code> | <code>aws-cdk-lib.aws_logs.ILogGroup</code> | Use an existing log group. |
 | <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.logLevel">logLevel</a></code> | <code><a href="#@btc-embedded/cdk-extensions.LogLevel">LogLevel</a></code> | Set the log level for the pipe. |
 | <code><a href="#@btc-embedded/cdk-extensions.EventPipeProps.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.Role</code> | The role used by the event pipe. |
 
@@ -5978,10 +6574,10 @@ An optional filter for the pipe.
 ##### `logGroup`<sup>Optional</sup> <a name="logGroup" id="@btc-embedded/cdk-extensions.EventPipeProps.property.logGroup"></a>
 
 ```typescript
-public readonly logGroup: LogGroup;
+public readonly logGroup: ILogGroup;
 ```
 
-- *Type:* aws-cdk-lib.aws_logs.LogGroup
+- *Type:* aws-cdk-lib.aws_logs.ILogGroup
 
 Use an existing log group.
 
@@ -6185,6 +6781,37 @@ const inputTemplate: InputTemplate = { ... }
 ```
 
 
+### LogExtensionOptions <a name="LogExtensionOptions" id="@btc-embedded/cdk-extensions.LogExtensionOptions"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.LogExtensionOptions.Initializer"></a>
+
+```typescript
+import { LogExtensionOptions } from '@btc-embedded/cdk-extensions'
+
+const logExtensionOptions: LogExtensionOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.LogExtensionOptions.property.appName">appName</a></code> | <code>string</code> | The name of the application. |
+
+---
+
+##### `appName`<sup>Optional</sup> <a name="appName" id="@btc-embedded/cdk-extensions.LogExtensionOptions.property.appName"></a>
+
+```typescript
+public readonly appName: string;
+```
+
+- *Type:* string
+- *Default:* the stack name
+
+The name of the application.
+
+---
+
 ### OpenTelemetryExtensionProps <a name="OpenTelemetryExtensionProps" id="@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps.Initializer"></a>
@@ -6276,6 +6903,7 @@ const postgresDbAccessExtensionProps: PostgresDbAccessExtensionProps = { ... }
 | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.dbConnectionProperties">dbConnectionProperties</a></code> | <code>{[ key: string ]: string}</code> | Additional connection properties to be added to the database connection string as query parameters. |
 | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.enableMigration">enableMigration</a></code> | <code>boolean</code> | Enable database migration by calling the default image with the migration parameter. |
 | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.environmentVariableNames">environmentVariableNames</a></code> | <code><a href="#@btc-embedded/cdk-extensions.EnvironmentVariableNames">EnvironmentVariableNames</a></code> | Adjust the environment variables. |
+| <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.logGroup">logGroup</a></code> | <code>aws-cdk-lib.aws_logs.ILogGroup</code> | Specify a log group to use for the database migration container. |
 | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.migrationParameter">migrationParameter</a></code> | <code>string</code> | The parameter passed to the default container to perform the database migration. |
 
 ---
@@ -6362,6 +6990,21 @@ Adjust the environment variables.
 
 ---
 
+##### `logGroup`<sup>Optional</sup> <a name="logGroup" id="@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.logGroup"></a>
+
+```typescript
+public readonly logGroup: ILogGroup;
+```
+
+- *Type:* aws-cdk-lib.aws_logs.ILogGroup
+- *Default:* creates a new log group
+
+Specify a log group to use for the database migration container.
+
+This log group is used when the log extension is not added to the service.
+
+---
+
 ##### `migrationParameter`<sup>Optional</sup> <a name="migrationParameter" id="@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.migrationParameter"></a>
 
 ```typescript
@@ -9477,11 +10120,18 @@ public readonly props: HTTPApiExtensionProps;
 ```typescript
 import { LogExtension } from '@btc-embedded/cdk-extensions'
 
-new LogExtension()
+new LogExtension(options?: LogExtensionOptions)
 ```
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.LogExtension.Initializer.parameter.options">options</a></code> | <code><a href="#@btc-embedded/cdk-extensions.LogExtensionOptions">LogExtensionOptions</a></code> | *No description.* |
+
+---
+
+##### `options`<sup>Optional</sup> <a name="options" id="@btc-embedded/cdk-extensions.LogExtension.Initializer.parameter.options"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.LogExtensionOptions">LogExtensionOptions</a>
 
 ---