RubyGems - pangea - Versions diffs - 0.0.45 → 0.0.47 - Mend

pangea 0.0.45 → 0.0.47

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 (2198) hide show

data/lib/pangea/resources/aws_memorydb_user/CLAUDE.md DELETED Viewed

@@ -1,96 +0,0 @@
-# AwsMemorydbUser Implementation Documentation
-## Overview
-This directory contains the implementation for the `aws_memorydb_user` resource function, providing type-safe creation and management of Memorydb User resources through terraform-synthesizer integration.
-## Implementation Architecture
-### Core Components
-#### 1. Resource Function (`resource.rb`)
-The main `aws_memorydb_user` function that:
-- Accepts a symbol name and attributes hash
-- Validates attributes using dry-struct types
-- Generates terraform resource blocks via terraform-synthesizer
-- Returns ResourceReference with computed outputs and properties
-#### 2. Type Definitions (`types.rb`)
-MemorydbUserAttributes dry-struct defining:
-- Required attributes: TODO: List required attributes
-- Optional attributes: TODO: List optional attributes
-- Custom validations for business logic
-- Computed properties for convenience
-#### 3. Documentation
-- **CLAUDE.md** (this file): Implementation details for developers
-- **README.md**: User-facing documentation with examples
-## Technical Implementation Details
-### TODO: Add technical details
-- Describe the AWS service
-- Key features and constraints
-- Integration patterns
-### Type Validation Logic
-```ruby
-class MemorydbUserAttributes < Dry::Struct
-  # TODO: Document validation logic
-end
-```
-### Terraform Synthesis
-The resource function generates terraform JSON through terraform-synthesizer:
-```ruby
-resource(:aws_memorydb_user, name) do
-  # TODO: Document synthesis process
-end
-```
-### ResourceReference Return Value
-The function returns a ResourceReference providing:
-#### Terraform Outputs
-TODO: List available outputs
-#### Computed Properties
-TODO: List computed properties
-## Integration Patterns
-### 1. Basic Usage
-```ruby
-template :example do
-  # TODO: Add basic usage example
-end
-```
-## Error Handling and Validation
-### Common Validation Errors
-TODO: Document common errors and solutions
-## Testing Strategy
-### Unit Tests
-```ruby
-RSpec.describe Pangea::Resources::AWS do
-  describe "#aws_memorydb_user" do
-    # TODO: Add test examples
-  end
-end
-```
-## Security Best Practices
-TODO: Add security considerations
-## Future Enhancements
-TODO: List potential improvements

data/lib/pangea/resources/aws_mobile_analytics_app/CLAUDE.md DELETED Viewed

@@ -1,262 +0,0 @@
-# AWS Mobile Analytics App Resource - Technical Documentation
-## ⚠️ DEPRECATION NOTICE
-AWS Mobile Analytics was deprecated by Amazon in favor of Amazon Pinpoint. This resource is maintained solely for legacy infrastructure support. All new implementations should use Amazon Pinpoint.
-## Historical Context
-### Service Overview
-AWS Mobile Analytics was Amazon's first-generation mobile app analytics service, launched in 2014. It provided:
-- Basic usage metrics
-- Custom event tracking
-- User session analysis
-- Revenue tracking
-- Device and OS analytics
-### Deprecation Timeline
-- 2016: Amazon Pinpoint launched with Mobile Analytics features
-- 2018: AWS stopped promoting Mobile Analytics
-- 2021: Service entered maintenance mode
-- Present: Legacy support only, no new features
-## Migration Path
-### From Mobile Analytics to Pinpoint
-```ruby
-# Legacy Mobile Analytics setup
-aws_mobile_analytics_app(:old_analytics, {
-  name: "GameApp-Analytics"
-})
-# Modern Pinpoint replacement
-aws_pinpoint_app(:new_analytics, {
-  name: "GameApp-Analytics-v2",
-  tags: {
-    Purpose: "analytics",
-    MigratedFrom: "mobile-analytics",
-    MigrationDate: Time.now.strftime("%Y-%m-%d")
-  }
-})
-# Pinpoint event stream for analytics
-aws_pinpoint_event_stream(:analytics_stream, {
-  application_id: new_analytics.application_id,
-  destination_stream_arn: kinesis_stream.arn,
-  role_arn: analytics_role.arn
-})
-```
-### Feature Mapping
-| Mobile Analytics Feature | Pinpoint Equivalent |
-|-------------------------|-------------------|
-| App Opens | Session Start Events |
-| Custom Events | Custom Events (Enhanced) |
-| User Attributes | Endpoint Attributes |
-| Revenue Events | Monetization Events |
-| Daily/Monthly Active Users | Built-in Metrics |
-| Retention Metrics | Engagement Metrics |
-## Legacy Support Considerations
-### Existing Infrastructure
-```ruby
-# Only use for existing apps that haven't migrated
-aws_mobile_analytics_app(:legacy_support, {
-  name: "LegacyGame-Analytics"
-})
-# Add migration tracking
-aws_ssm_parameter(:migration_status, {
-  name: "/mobile-analytics/migration-status/LegacyGame",
-  type: "String",
-  value: "pending-migration"
-})
-```
-### Data Export Before Migration
-```ruby
-# Export historical data to S3
-aws_s3_bucket(:analytics_archive, {
-  bucket: "mobile-analytics-archive-${var.account_id}"
-})
-# Lambda to export data
-aws_lambda_function(:export_analytics, {
-  function_name: "export-mobile-analytics",
-  description: "Export Mobile Analytics data before migration",
-  environment: {
-    variables: {
-      ANALYTICS_APP_ID: legacy_app.id,
-      ARCHIVE_BUCKET: analytics_archive.id
-    }
-  }
-})
-```
-## SDK Considerations
-### Legacy SDK Usage
-```javascript
-// Old Mobile Analytics SDK (deprecated)
-var mobileAnalytics = new AWS.MobileAnalytics({
-  appId: 'legacy-app-id'
-});
-// New Pinpoint SDK
-var pinpoint = new AWS.Pinpoint({
-  region: 'us-east-1'
-});
-```
-### SDK Migration Steps
-1. Update mobile app to latest AWS SDK
-2. Replace Mobile Analytics calls with Pinpoint
-3. Test event recording
-4. Gradually phase out old SDK
-5. Remove Mobile Analytics dependency
-## Cost Implications
-### Mobile Analytics Pricing (Historical)
-- $1 per million events
-- First 100 million events free per month
-- No additional charges
-### Pinpoint Pricing (Current)
-- Similar event pricing
-- Additional features may incur costs
-- More flexible pricing tiers
-## Data Retention
-### Mobile Analytics Limitations
-- 60-day data retention
-- Limited export options
-- No real-time streaming
-### Pinpoint Advantages
-- Configurable retention
-- Real-time event streaming
-- S3 export capabilities
-- Integration with AWS analytics services
-## Common Migration Issues
-### 1. Event Schema Differences
-```ruby
-# Mobile Analytics event
-{
-  eventType: "level_complete",
-  attributes: {
-    level: "10",
-    score: "5000"
-  }
-}
-# Pinpoint event (richer schema)
-{
-  eventType: "level_complete",
-  attributes: {
-    level: "10",
-    score: "5000"
-  },
-  metrics: {
-    completion_time: 120.5,
-    attempts: 3
-  },
-  session: {
-    id: "session-123",
-    start_time: "2024-01-01T10:00:00Z"
-  }
-}
-```
-### 2. API Compatibility
-- Mobile Analytics API is deprecated
-- No new API features
-- Pinpoint API is actively developed
-### 3. Dashboard Access
-- Mobile Analytics console being phased out
-- Limited reporting capabilities
-- Pinpoint provides comprehensive dashboards
-## Minimal Implementation
-### Absolute Minimum for Legacy Support
-```ruby
-# Only if absolutely necessary
-aws_mobile_analytics_app(:minimal_legacy, {
-  name: "Required-Legacy-App"
-})
-# Document why it's still needed
-aws_ssm_parameter(:legacy_reason, {
-  name: "/mobile-analytics/legacy-reason/Required-Legacy-App",
-  type: "String",
-  value: "Cannot migrate due to: [specific reason]"
-})
-```
-## Best Practices for Legacy Resources
-### 1. Document Everything
-```ruby
-aws_mobile_analytics_app(:documented_legacy, {
-  name: "Legacy-Analytics-2019"
-})
-# Create comprehensive documentation
-aws_s3_object(:legacy_docs, {
-  bucket: docs_bucket.id,
-  key: "mobile-analytics/Legacy-Analytics-2019/README.md",
-  content: <<-DOC
-    # Legacy Mobile Analytics App
-    ## Why This Still Exists
-    - App version 1.x still in production
-    - 5% of users on legacy version
-    - Planned EOL: Q4 2024
-    ## Migration Plan
-    - Phase 1: Update SDK (Q2 2024)
-    - Phase 2: Dual-write events (Q3 2024)
-    - Phase 3: Cut over to Pinpoint (Q4 2024)
-  DOC
-})
-```
-### 2. Monitor Usage
-```ruby
-# Track if legacy app is still being used
-aws_cloudwatch_metric_alarm(:legacy_usage, {
-  alarm_name: "mobile-analytics-legacy-usage",
-  alarm_description: "Alert if legacy Mobile Analytics still receiving events",
-  comparison_operator: "GreaterThanThreshold",
-  evaluation_periods: 1,
-  threshold: 0
-})
-```
-### 3. Plan Retirement
-```ruby
-# Set retirement date
-aws_ssm_parameter(:retirement_date, {
-  name: "/mobile-analytics/retirement-date",
-  type: "String",
-  value: "2024-12-31",
-  description: "Target date for Mobile Analytics retirement"
-})
-```
-## Conclusion
-AWS Mobile Analytics should not be used for new projects. This resource exists purely for backwards compatibility with legacy infrastructure. All mobile analytics needs should be implemented using Amazon Pinpoint, which provides superior features, better SDK support, and active development.
-For teams still using Mobile Analytics:
-1. Create a migration plan immediately
-2. Document why migration hasn't occurred
-3. Set a firm retirement date
-4. Begin testing with Pinpoint in parallel
-The deprecation warning in the resource module serves as a constant reminder that migration is necessary.

data/lib/pangea/resources/aws_nat_gateway/CLAUDE.md DELETED Viewed

@@ -1,209 +0,0 @@
-# AWS NAT Gateway Resource Implementation
-## Overview
-The `aws_nat_gateway` resource creates an AWS NAT Gateway that enables instances in private subnets to connect to the internet or other AWS services while preventing inbound connections from the internet. NAT Gateways support both public (internet-facing) and private (for accessing AWS services via PrivateLink) connectivity types.
-## Type Safety Implementation
-### Attributes Structure
-```ruby
-class NatGatewayAttributes < Dry::Struct
-  attribute :subnet_id, String                # Required, must be public subnet for public NAT
-  attribute :allocation_id, String.optional   # EIP allocation ID for public NAT
-  attribute :connectivity_type, String        # 'public' or 'private'
-  attribute :tags, AwsTags                    # Resource tags
-end
-```
-### Key Design Decisions
-1. **Connectivity Type Support**: Supports both NAT Gateway types:
-   - **Public NAT Gateway**: Requires Elastic IP, provides internet connectivity
-   - **Private NAT Gateway**: No EIP needed, for AWS service connectivity via PrivateLink
-2. **Allocation ID Validation**:
-   - Required for public NAT gateways (unless AWS auto-allocates)
-   - Cannot be used with private NAT gateways
-   - Validation ensures consistency between `allocation_id` and `connectivity_type`
-3. **Subnet Requirements**:
-   - Public NAT Gateway must be in a public subnet
-   - Private NAT Gateway can be in any subnet
-   - Validation doesn't enforce this (requires runtime context)
-4. **Computed Properties**:
-   - `public?`: Returns true for public NAT gateways
-   - `private?`: Returns true for private NAT gateways
-   - `requires_elastic_ip?`: Indicates if EIP allocation is needed
-## Resource Function Pattern
-The `aws_nat_gateway` function follows the standard Pangea resource pattern:
-```ruby
-def aws_nat_gateway(name, attributes = {})
-  # 1. Validate attributes with dry-struct
-  nat_attrs = Types::NatGatewayAttributes.new(attributes)
-  # 2. Generate Terraform resource via synthesizer
-  resource(:aws_nat_gateway, name) do
-    subnet_id nat_attrs.subnet_id
-    allocation_id nat_attrs.allocation_id if nat_attrs.allocation_id
-    connectivity_type nat_attrs.connectivity_type if nat_attrs.connectivity_type != 'public'
-    tags { ... } if nat_attrs.tags.any?
-  end
-  # 3. Return ResourceReference with outputs and computed properties
-  ResourceReference.new(
-    type: 'aws_nat_gateway',
-    name: name,
-    resource_attributes: nat_attrs.to_h,
-    outputs: { id, allocation_id, subnet_id, network_interface_id, private_ip, public_ip },
-    computed_properties: { public, private, requires_elastic_ip }
-  )
-end
-```
-## Integration with Terraform Synthesizer
-The resource block generation uses conditional attributes:
-```ruby
-resource(:aws_nat_gateway, name) do
-  subnet_id nat_attrs.subnet_id
-  allocation_id nat_attrs.allocation_id if nat_attrs.allocation_id
-  connectivity_type nat_attrs.connectivity_type if nat_attrs.connectivity_type != 'public'
-  if nat_attrs.tags.any?
-    tags do
-      nat_attrs.tags.each do |key, value|
-        public_send(key, value)
-      end
-    end
-  end
-end
-```
-This generates the equivalent Terraform JSON:
-```json
-{
-  "resource": {
-    "aws_nat_gateway": {
-      "main": {
-        "subnet_id": "${aws_subnet.public.id}",
-        "allocation_id": "${aws_eip.nat.id}",
-        "tags": {
-          "Name": "main-nat-gateway",
-          "Environment": "production"
-        }
-      }
-    }
-  }
-}
-```
-## Common Usage Patterns
-### 1. Public NAT Gateway with Elastic IP
-```ruby
-# Create Elastic IP
-eip = aws_eip(:nat_eip, {
-  domain: "vpc",
-  tags: { Name: "nat-gateway-eip" }
-})
-# Create NAT Gateway
-nat = aws_nat_gateway(:main, {
-  subnet_id: public_subnet.id,
-  allocation_id: eip.id,
-  tags: { Name: "main-nat-gateway" }
-})
-```
-### 2. Private NAT Gateway
-```ruby
-private_nat = aws_nat_gateway(:private, {
-  subnet_id: private_subnet.id,
-  connectivity_type: "private",
-  tags: { Name: "private-nat-gateway" }
-})
-```
-### 3. Multi-AZ NAT Gateway Setup
-```ruby
-%w[a b c].each do |az|
-  # EIP for each AZ
-  eip = aws_eip(:"nat_eip_#{az}", {
-    domain: "vpc",
-    tags: { Name: "nat-eip-#{az}" }
-  })
-  # NAT Gateway in each AZ
-  nat = aws_nat_gateway(:"nat_#{az}", {
-    subnet_id: ref(:aws_subnet, :"public_#{az}", :id),
-    allocation_id: eip.id,
-    tags: {
-      Name: "nat-gateway-#{az}",
-      AvailabilityZone: "us-east-1#{az}"
-    }
-  })
-end
-```
-### 4. NAT Gateway with Route Table Integration
-```ruby
-# Create NAT Gateway
-nat = aws_nat_gateway(:main, {
-  subnet_id: public_subnet.id,
-  allocation_id: eip.id
-})
-# Create private route table using NAT Gateway
-private_rt = aws_route_table(:private, {
-  vpc_id: vpc.id,
-  routes: [{
-    cidr_block: "0.0.0.0/0",
-    nat_gateway_id: nat.id
-  }]
-})
-```
-## Testing Considerations
-1. **Type Validation**:
-   - Test allocation_id with private connectivity type (should fail)
-   - Test missing subnet_id (should fail)
-   - Test invalid connectivity_type values
-2. **Terraform Generation**:
-   - Verify connectivity_type only included when not 'public'
-   - Test allocation_id conditional inclusion
-   - Test tag block generation
-3. **Computed Properties**:
-   - Test public/private detection
-   - Test elastic IP requirement logic
-4. **ResourceReference**:
-   - Verify all outputs are accessible
-   - Test public_ip output for private NAT gateways
-## Future Enhancements
-1. **Enhanced Validation**:
-   - Validate subnet is public for public NAT gateways
-   - Validate allocation_id format
-   - Add subnet_id reference validation
-2. **Additional Computed Properties**:
-   - Bandwidth usage estimates
-   - Cost estimation based on type
-   - AZ information from subnet
-3. **Helper Methods**:
-   - Multi-AZ NAT Gateway creator
-   - Automatic EIP allocation helper
-   - Route table association helper

data/lib/pangea/resources/aws_neptune_cluster/CLAUDE.md DELETED Viewed

@@ -1,96 +0,0 @@
-# AwsNeptuneCluster Implementation Documentation
-## Overview
-This directory contains the implementation for the `aws_neptune_cluster` resource function, providing type-safe creation and management of Neptune Cluster resources through terraform-synthesizer integration.
-## Implementation Architecture
-### Core Components
-#### 1. Resource Function (`resource.rb`)
-The main `aws_neptune_cluster` function that:
-- Accepts a symbol name and attributes hash
-- Validates attributes using dry-struct types
-- Generates terraform resource blocks via terraform-synthesizer
-- Returns ResourceReference with computed outputs and properties
-#### 2. Type Definitions (`types.rb`)
-NeptuneClusterAttributes dry-struct defining:
-- Required attributes: TODO: List required attributes
-- Optional attributes: TODO: List optional attributes
-- Custom validations for business logic
-- Computed properties for convenience
-#### 3. Documentation
-- **CLAUDE.md** (this file): Implementation details for developers
-- **README.md**: User-facing documentation with examples
-## Technical Implementation Details
-### TODO: Add technical details
-- Describe the AWS service
-- Key features and constraints
-- Integration patterns
-### Type Validation Logic
-```ruby
-class NeptuneClusterAttributes < Dry::Struct
-  # TODO: Document validation logic
-end
-```
-### Terraform Synthesis
-The resource function generates terraform JSON through terraform-synthesizer:
-```ruby
-resource(:aws_neptune_cluster, name) do
-  # TODO: Document synthesis process
-end
-```
-### ResourceReference Return Value
-The function returns a ResourceReference providing:
-#### Terraform Outputs
-TODO: List available outputs
-#### Computed Properties
-TODO: List computed properties
-## Integration Patterns
-### 1. Basic Usage
-```ruby
-template :example do
-  # TODO: Add basic usage example
-end
-```
-## Error Handling and Validation
-### Common Validation Errors
-TODO: Document common errors and solutions
-## Testing Strategy
-### Unit Tests
-```ruby
-RSpec.describe Pangea::Resources::AWS do
-  describe "#aws_neptune_cluster" do
-    # TODO: Add test examples
-  end
-end
-```
-## Security Best Practices
-TODO: Add security considerations
-## Future Enhancements
-TODO: List potential improvements