generator.yaml

ignore:
  resource_names:
    - BlueGreenDeployment
    - CustomAvailabilityZone
    - CustomDBEngineVersion
    #- DBCluster
    - DBClusterEndpoint
    #- DBClusterParameterGroup
    # DBClusterSnapshot
    #- DBInstance
    - DBInstanceReadReplica
    #- DBParameterGroup
    #- DBProxy
    - DBProxyEndpoint
    - DBSecurityGroup
    # DBSnapshot
    #- DBSubnetGroup
    - EventSubscription
    #- GlobalCluster
    - OptionGroup
  field_paths:
    - CreateDBInstanceInput.DBSecurityGroups
    - DBInstance.DBSecurityGroups
    # We handle Spec.Tags separately...
    - "DescribeDBInstancesOutput.DBInstances.DBInstance.TagList"
    # These fields are also supported for DBSnapshot updates but we can't
    # support them for the moment. They require some code-generator modifications.
    - "CreateDBSnapshotOutput.DBSnapshot.EngineVersion"
    - "CreateDBSnapshotOutput.DBSnapshot.OptionGroupName"
    - "DescribeDBClusterSnapshotsOutput.DBClusterSnapshots.TagList"
operations:
  ModifyDBCluster:
    override_values:
      # The whole concept of a "maintenance window" isn't aligned with the
      # declarative state model in Kubernetes. Users should build "maintenance
      # window" functionality at a higher layer than the APIs that manage the
      # lifecycle of individual resources like a DB cluster or DB instance. For
      # example, users can build maintenance window functionality into their
      # deployment pipeline solution or GitOps solution.
      #
      # We override the value of the ApplyImmediately field in the modify
      # operations to "true" because we want changes that a Kubernetes user
      # makes to a resource's Spec to be reconciled by the ACK service
      # controller, not a different service.
      ApplyImmediately: true
      # We override the value of AllowMajorVersionUpgrade field in the modify
      # call since any engine version change should apply directly.
      # This flag was designed as a protect flag but not necessary in controller
      # side when customer need to make the engine version change
      AllowMajorVersionUpgrade: true
  ModifyDBInstance:
    override_values:
      # The whole concept of a "maintenance window" isn't aligned with the
      # declarative state model in Kubernetes. Users should build "maintenance
      # window" functionality at a higher layer than the APIs that manage the
      # lifecycle of individual resources like a DB cluster or DB instance. For
      # example, users can build maintenance window functionality into their
      # deployment pipeline solution or GitOps solution.
      #
      # We override the value of the ApplyImmediately field in the modify
      # operations to "true" because we want changes that a Kubernetes user
      # makes to a resource's Spec to be reconciled by the ACK service
      # controller, not a different service.
      ApplyImmediately: true
      # We override the value of the ApplyImmediately field in the modify
      # operations to "true" because we want changes that a Kubernetes user
      # makes to a resource's Spec to be reconciled by the ACK service
      # controller, not a different service.
      AllowMajorVersionUpgrade: true
resources:
  DBCluster:
    update_operation:
      # We need a custom update implementation until the issue behind
      # https://github.com/aws-controllers-k8s/community/issues/917 is
      # resolved.
      custom_method_name: customUpdate
    hooks:
      sdk_create_pre_build_request:
        template_path: hooks/db_cluster/sdk_create_pre_build_request.go.tpl
      delta_pre_compare:
        template_path: hooks/db_cluster/delta_pre_compare.go.tpl
      sdk_create_post_set_output:
        template_path: hooks/db_cluster/sdk_create_post_set_output.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/db_cluster/sdk_read_many_post_set_output.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/db_cluster/sdk_delete_pre_build_request.go.tpl
      sdk_delete_post_build_request:
        template_path: hooks/db_cluster/sdk_delete_post_build_request.go.tpl
      sdk_file_end:
        template_path: hooks/db_cluster/sdk_file_end.go.tpl
    exceptions:
      terminal_codes:
        - DBClusterQuotaExceededFault
        - DBSubnetGroupDoesNotCoverEnoughAZs
        - InsufficientStorageClusterCapacity
        - InvalidParameter
        - InvalidParameterValue
        - InvalidParameterCombination
        - InvalidSubnet
        - StorageQuotaExceeded
    fields:
      DBClusterIdentifier:
        is_primary_key: true
      MasterUserPassword:
        is_secret: true
      KmsKeyId:
        references:
          resource: Key
          service_name: kms
          path: Status.ACKResourceMetadata.ARN
      MasterUserSecretKmsKeyId:
        references:
          resource: Key
          service_name: kms
          path: Status.ACKResourceMetadata.ARN
      DBClusterParameterGroupName:
        references:
          resource: DBClusterParameterGroup
          path: Spec.Name
      DBSubnetGroupName:
        references:
          resource: DBSubnetGroup
          path: Spec.Name
      VpcSecurityGroupIds:
        references:
          resource: SecurityGroup
          service_name: ec2
          path: Status.ID
      SnapshotIdentifier:
        from:
          operation: RestoreDBClusterFromSnapshot
          path: SnapshotIdentifier
      SourceDBClusterIdentifier:
        from:
          operation: RestoreDBClusterToPointInTime
          path: SourceDBClusterIdentifier
      RestoreType:
        from:
          operation: RestoreDBClusterToPointInTime
          path: RestoreType
      RestoreToTime:
        from:
          operation: RestoreDBClusterToPointInTime
          path: RestoreToTime
      UseLatestRestorableTime:
        from:
          operation: RestoreDBClusterToPointInTime
          path: UseLatestRestorableTime
      Tags:
        compare:
          # We have a custom comparison function...
          is_ignored: true
    renames:
      operations:
        CreateDBCluster:
          output_fields:
            ScalingConfigurationInfo: ScalingConfiguration
        ModifyDBCluster:
          output_fields:
            ScalingConfigurationInfo: ScalingConfiguration
  DBClusterParameterGroup:
    renames:
      operations:
        DescribeDBClusterParameterGroups:
          input_fields:
            DBClusterParameterGroupName: Name
            DBParameterGroupFamily: Family
        CreateDBClusterParameterGroup:
          input_fields:
            DBClusterParameterGroupName: Name
            DBParameterGroupFamily: Family
        DeleteDBClusterParameterGroup:
          input_fields:
            DBClusterParameterGroupName: Name
        ModifyDBClusterParameterGroup:
          input_fields:
            DBClusterParameterGroupName: Name
            DBParameterGroupFamily: Family
    update_operation:
      # We need a custom update implementation until the issue behind
      # https://github.com/aws-controllers-k8s/community/issues/869 is
      # resolved.
      custom_method_name: customUpdate
    hooks:
      sdk_read_many_post_set_output:
        template_path: hooks/db_cluster_parameter_group/sdk_read_many_post_set_output.go.tpl
      delta_pre_compare:
        template_path: hooks/db_cluster_parameter_group/delta_pre_compare.go.tpl
      sdk_create_post_set_output:
        template_path: hooks/db_cluster_parameter_group/sdk_create_post_set_output.go.tpl
    fields:
      Name:
        is_primary_key: true
      Parameters:
        from:
          operation: ModifyDBClusterParameterGroup
          path: Parameters
        documentation: DEPRECATED - do not use.  Prefer ParameterOverrides instead.
      ParameterOverrides:
        custom_field:
          # Map keys are the parameter name and the values are the parameter value.
          # We automatically determine the "apply method" for parameters.
          map_of: String
        documentation: These are ONLY user-defined parameter overrides for the
          DB cluster parameter group. This does not contain default or system
          parameters.
      Tags:
        compare:
          # We have a custom comparison function...
          is_ignored: true
      # These are the "statuses" for the user-defined parameter overrides in
      # Spec.ParameterOverrides
      ParameterOverrideStatuses:
        from:
          operation: DescribeDBClusterParameters
          path: Parameters
        is_read_only: true
  DBInstance:
    hooks:
      delta_pre_compare:
        template_path: hooks/db_instance/delta_pre_compare.go.tpl
      sdk_create_pre_build_request:
        template_path: hooks/db_instance/sdk_create_pre_build_request.go.tpl
      sdk_create_post_set_output:
        template_path: hooks/db_instance/sdk_create_post_set_output.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/db_instance/sdk_read_many_post_set_output.go.tpl
      sdk_update_pre_build_request:
        template_path: hooks/db_instance/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/db_instance/sdk_update_post_build_request.go.tpl
      sdk_update_post_set_output:
        template_path: hooks/db_instance/sdk_update_post_set_output.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/db_instance/sdk_delete_pre_build_request.go.tpl
      sdk_delete_post_build_request:
        template_path: hooks/db_instance/sdk_delete_post_build_request.go.tpl
      sdk_file_end:
        template_path: hooks/db_instance/sdk_file_end.go.tpl
    exceptions:
      terminal_codes:
        - InvalidParameter
        - InvalidParameterValue
        - InvalidParameterCombination
    fields:
      AvailabilityZone:
        late_initialize: {}
        is_immutable: true
      DBInstanceIdentifier:
        is_primary_key: true
      DBInstanceStatus:
        print:
          name: "STATUS"
      MasterUserPassword:
        is_secret: true
      KmsKeyId:
        references:
          resource: Key
          service_name: kms
          path: Status.ACKResourceMetadata.ARN
      MasterUserSecretKmsKeyId:
        references:
          resource: Key
          service_name: kms
          path: Status.ACKResourceMetadata.ARN
      DBParameterGroupName:
        references:
          resource: DBParameterGroup
          path: Spec.Name
      DBSubnetGroupName:
        references:
          resource: DBSubnetGroup
          path: Spec.Name
      VpcSecurityGroupIds:
        references:
          resource: SecurityGroup
          service_name: ec2
          path: Status.ID
      BackupTarget:
        late_initialize: {}
      NetworkType:
        late_initialize: {}
      # Used by restore db instance from db snapshot
      DBSnapshotIdentifier:
        from:
          operation: RestoreDBInstanceFromDBSnapshot
          path: DBSnapshotIdentifier
      DBClusterSnapshotIdentifier:
        from:
          operation: RestoreDBInstanceFromDBSnapshot
          path: DBClusterSnapshotIdentifier
      UseDefaultProcessorFeatures:
        from:
          operation: RestoreDBInstanceFromDBSnapshot
          path: UseDefaultProcessorFeatures
      # Used by create db instance read replica
      SourceDBInstanceIdentifier:
        from:
          operation: CreateDBInstanceReadReplica
          path: SourceDBInstanceIdentifier
      DestinationRegion:
        from:
          operation: CreateDBInstanceReadReplica
          path: DestinationRegion
      ReplicaMode:
        from:
          operation: CreateDBInstanceReadReplica
          path: ReplicaMode
      SourceRegion:
        from:
          operation: CreateDBInstanceReadReplica
          path: SourceRegion
      PreSignedURL:
        from:
          operation: CreateDBInstanceReadReplica
          path: PreSignedUrl
      Tags:
        compare:
          # We have a custom comparison function...
          is_ignored: true
    renames:
      operations:
        CreateDBInstance:
          input_fields:
            EnablePerformanceInsights: PerformanceInsightsEnabled
        ModifyDBInstance:
          input_fields:
            EnablePerformanceInsights: PerformanceInsightsEnabled
  GlobalCluster:
    exceptions:
      terminal_codes:
        - GlobalClusterAlreadyExistsFault
        - GlobalClusterQuotaExceededFault
    fields:
      GlobalClusterIdentifier:
        is_primary_key: true
    tags:
      ignore: true
  DBParameterGroup:
    renames:
      operations:
        DescribeDBParameterGroups:
          input_fields:
            DBParameterGroupName: Name
            DBParameterGroupFamily: Family
        CreateDBParameterGroup:
          input_fields:
            DBParameterGroupName: Name
            DBParameterGroupFamily: Family
        DeleteDBParameterGroup:
          input_fields:
            DBParameterGroupName: Name
        ModifyDBParameterGroup:
          input_fields:
            DBParameterGroupName: Name
            DBParameterGroupFamily: Family
    update_operation:
      # We need a custom update implementation until the issue behind
      # https://github.com/aws-controllers-k8s/community/issues/869 is
      # resolved.
      custom_method_name: customUpdate
    hooks:
      sdk_read_many_post_set_output:
        template_path: hooks/db_parameter_group/sdk_read_many_post_set_output.go.tpl
      delta_pre_compare:
        template_path: hooks/db_parameter_group/delta_pre_compare.go.tpl
      sdk_create_post_set_output:
        template_path: hooks/db_parameter_group/sdk_create_post_set_output.go.tpl
    fields:
      Name:
        is_primary_key: true
      ParameterOverrides:
        custom_field:
          # The type is a map[string]string where the map keys are the
          # parameter name and the values are the parameter value. We
          # automatically determine the "apply method" for parameters so all
          # the user needs to do is specify the parameter name and value they
          # want to override...
          map_of: String
        documentation:
          These are ONLY user-defined parameter overrides for the DB parameter
          group. This does not contain default or system parameters.
      Tags:
        compare:
          # We have a custom comparison function...
          is_ignored: true
      # These are the "statuses" for the user-defined parameter overrides in
      # Spec.ParameterOverrides
      ParameterOverrideStatuses:
        from:
          operation: DescribeDBParameters
          path: Parameters
        is_read_only: true
  DBSubnetGroup:
    renames:
      operations:
        DescribeDBSubnetGroups:
          input_fields:
            DBSubnetGroupName: Name
            DBSubnetGroupDescription: Description
        CreateDBSubnetGroup:
          input_fields:
            DBSubnetGroupName: Name
            DBSubnetGroupDescription: Description
        ModifyDBSubnetGroup:
          input_fields:
            DBSubnetGroupName: Name
            DBSubnetGroupDescription: Description
        DeleteDBSubnetGroup:
          input_fields:
            DBSubnetGroupName: Name
    exceptions:
      terminal_codes:
        - DBSubnetGroupDoesNotCoverEnoughAZs
        - InvalidSubnet
        - InvalidParameter
        - SubnetAlreadyInUse
    hooks:
      sdk_read_many_post_set_output:
        template_path: hooks/db_subnet_group/sdk_read_many_post_set_output.go.tpl
      sdk_update_pre_set_output:
        template_path: hooks/db_subnet_group/sdk_update_pre_set_output.go.tpl
      delta_pre_compare:
        template_path: hooks/db_subnet_group/delta_pre_compare.go.tpl
    fields:
      SubnetIDs:
        references:
          service_name: ec2
          resource: Subnet
          path: Status.SubnetID
      Name:
        is_primary_key: true
      Tags:
        compare:
          # We have a custom comparison function...
          is_ignored: true
  DBProxy:
    exceptions:
      terminal_codes:
        - InvalidSubnet
    fields:
      Name:
        is_primary_key: true
    renames:
      operations:
        CreateDBProxy:
          input_fields:
            DBProxyName: Name
        DeleteDBProxy:
          input_fields:
            DBProxyName: Name
        DescribeDBProxies:
          input_fields:
            DBProxyName: Name
        ModifyDBProxy:
          input_fields:
            DBProxyName: Name
    hooks:
      sdk_create_post_set_output:
        template_path: hooks/db_proxy/sdk_create_post_set_output.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/db_proxy/sdk_read_many_post_set_output.go.tpl
      sdk_update_pre_build_request:
        template_path: hooks/db_proxy/sdk_update_pre_build_request.go.tpl
      sdk_update_post_set_output:
        template_path: hooks/db_proxy/sdk_update_post_set_output.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/db_proxy/sdk_delete_pre_build_request.go.tpl
  DBSnapshot:
    fields:
      DBSnapshotIdentifier:
        is_primary_key: true
      DBInstanceIdentifier:
        references:
          resource: DBInstance
          path: Spec.DBInstanceIdentifier
      # EngineVersion:
      #   is_read_only: false
      # OptionGroupName:
      #   is_read_only: false
    hooks:
      sdk_create_post_set_output:
        template_path: hooks/db_snapshot/sdk_create_post_set_output.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/db_snapshot/sdk_read_many_post_set_output.go.tpl
      sdk_update_pre_build_request:
        template_path: hooks/db_snapshot/sdk_update_pre_build_request.go.tpl
  DBClusterSnapshot:
    fields:
      DBClusterSnapshotIdentifier:
        is_primary_key: true
      DBClusterIdentifier:
        references:
          resource: DBCluster
          path: Spec.DBClusterIdentifier
    hooks:
      sdk_create_post_set_output:
        template_path: hooks/db_cluster_snapshot/sdk_create_post_set_output.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/db_cluster_snapshot/sdk_read_many_post_set_output.go.tpl
    update_operation:
      custom_method_name: customUpdateDBClusterSnapshot