Header menu logo FsCDK

CustomResourceConfig Type

High-level Custom Resource builder for one-time deployment tasks. **Default Settings:** - Timeout = 5 minutes - Remove on update = true (cleanup on changes) **Rationale:** Custom Resources provide deployment-time execution similar to Azure Deployment Scripts. These defaults follow AWS Well-Architected Framework: - Reasonable timeout for typical init tasks - Automatic cleanup prevents resource leaks **Use Cases:** - Database migrations and seeding - DNS record creation - Third-party API calls - Certificate validation - Resource initialization **Escape Hatch:** Access the underlying CDK AwsCustomResource via the `CustomResource` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

InstallLatestAwsSdk

Full Usage: InstallLatestAwsSdk

Field type: bool option
Field type: bool option

LogRetention

Full Usage: LogRetention

Field type: RetentionDays option
Field type: RetentionDays option

OnCreate

Full Usage: OnCreate

Field type: AwsSdkCall option
Field type: AwsSdkCall option

OnDelete

Full Usage: OnDelete

Field type: AwsSdkCall option
Field type: AwsSdkCall option

OnUpdate

Full Usage: OnUpdate

Field type: AwsSdkCall option
Field type: AwsSdkCall option

Policy

Full Usage: Policy

Field type: AwsCustomResourcePolicy option
Field type: AwsCustomResourcePolicy option

ResourceName

Full Usage: ResourceName

Field type: string
Field type: string

Timeout

Full Usage: Timeout

Field type: Duration option
Field type: Duration option

Type something to start searching.