generator.yaml

resources:
  CacheCluster:
    fields:
      CacheSubnetGroupName:
        references:
          resource: CacheSubnetGroup
          path: Spec.CacheSubnetGroupName
      CacheParameterGroupName:
        references:
          resource: CacheParameterGroup
          path: Spec.CacheParameterGroupName
        is_immutable: true
      ReplicationGroupID:
        references:
          resource: ReplicationGroup
          path: Spec.ReplicationGroupID
        is_immutable: true
      SnapshotName:
        references:
          resource: Snapshot
          path: Spec.SnapshotName
        is_immutable: true
      NotificationTopicARN:
        references:
          service_name: sns
          resource: Topic
          path: Status.ACKResourceMetadata.ARN
      AuthToken:
        is_secret: true
      PreferredAvailabilityZone:
        late_initialize: {}
      PreferredAvailabilityZones:
        compare:
          is_ignored: true
    print:
      add_age_column: true
      add_synced_column: true
      order_by: index
      additional_columns:
      - name: VERSION
        json_path: .spec.engineVersion
        type: string
        index: 10
      - name: STATUS
        json_path: .status.cacheClusterStatus
        type: string
        index: 20
      - name: ENDPOINT
        json_path: .status.configurationEndpoint.address
        type: string
        index: 30
        priority: 1
    exceptions:
      errors:
        404:
          code: CacheClusterNotFound
      terminal_codes:
        - ReplicationGroupNotFoundFault
        - InvalidReplicationGroupStateFault
        - CacheClusterAlreadyExistsFault
        - InsufficientCacheClusterCapacityFault
        - CacheSecurityGroupNotFoundFault
        - CacheSubnetGroupNotFoundFault
        - ClusterQuotaForCustomerExceededFault
        - NodeQuotaForClusterExceededFault
        - NodeQuotaForCustomerExceededFault
        - CacheParameterGroupNotFoundFault
        - InvalidVPCNetworkStateFault
        - TagQuotaPerResource
        - InvalidParameterValue
        - InvalidParameterCombination
    hooks:
      sdk_create_post_set_output:
        template_path: hooks/cache_cluster/sdk_create_post_set_output.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/cache_cluster/sdk_delete_pre_build_request.go.tpl
      sdk_read_many_post_set_output:
        template_path: hooks/cache_cluster/sdk_read_many_post_set_output.go.tpl
      sdk_update_pre_build_request:
        template_path: hooks/cache_cluster/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/cache_cluster/sdk_update_post_build_request.go.tpl
      sdk_update_post_set_output:
        template_path: hooks/cache_cluster/sdk_update_post_set_output.go.tpl
      delta_post_compare:
        code: "modifyDelta(delta, a, b)"
  CacheSubnetGroup:
    exceptions:
      errors:
        404:
          code: CacheSubnetGroupNotFoundFault
      terminal_codes:
        - CacheSubnetGroupQuotaExceeded
        - CacheSubnetQuotaExceededFault
        - SubnetInUse
        - InvalidSubnet
        - InvalidParameter
        - InvalidParameterValue
        - InvalidParameterCombination
    fields:
      SubnetIDs:
        references:
          service_name: ec2
          resource: Subnet
          path: Status.SubnetID
      Events:
        is_read_only: true
        from:
          operation: DescribeEvents
          path: Events
    hooks:
      sdk_read_many_post_set_output:
        template_path: hooks/cache_subnet_group/sdk_read_many_post_set_output.go.tpl
  ReplicationGroup:
    exceptions:
      terminal_codes:
        - InvalidParameter
        - InvalidParameterValue
        - InvalidParameterCombination
        - InsufficientCacheClusterCapacity
        - ClusterQuotaForCustomerExceeded
        - NodeQuotaForClusterExceeded
        - NodeQuotaForCustomerExceeded
        - InvalidVPCNetworkStateFault
        - TagQuotaPerResourceExceeded
        - NodeGroupsPerReplicationGroupQuotaExceeded
        - InvalidCacheSecurityGroupState
        - InvalidKMSKeyFault
    fields:
      AllowedScaleUpModifications:
        is_read_only: true
        from:
          operation: ListAllowedNodeTypeModifications
          path: ScaleUpModifications
      AllowedScaleDownModifications:
        is_read_only: true
        from:
          operation: ListAllowedNodeTypeModifications
          path: ScaleDownModifications
      AutomaticFailoverEnabled:
        compare:
          is_ignored: true
      CacheParameterGroupName:
        references:
          resource: CacheParameterGroup
          path: Spec.CacheParameterGroupName
      CacheSubnetGroupName:
        references:
          resource: CacheSubnetGroup
          path: Spec.CacheSubnetGroupName
      SecurityGroupIDs:
        references:
          resource: SecurityGroup
          service_name: ec2
          path: Status.ID
      Events:
        is_read_only: true
        from:
          operation: DescribeEvents
          path: Events
      AuthToken:
        is_secret: true
      LogDeliveryConfigurations:
        is_read_only: true # creates an additional status field of the same name
        from:
          operation: CreateReplicationGroup
          path: ReplicationGroup.LogDeliveryConfigurations
        compare: # removes the spec field from automatic delta comparison
          is_ignored: true
      MultiAZEnabled:
        compare:
          is_ignored: true
      PrimaryClusterId: # note: "PrimaryClusterID" will not function properly
        compare:
          is_ignored: true
      
    hooks:
      sdk_read_many_post_set_output:
        template_path: hooks/replication_group/sdk_read_many_post_set_output.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/replication_group/sdk_delete_pre_build_request.go.tpl
      sdk_delete_post_request:
        template_path: hooks/replication_group/sdk_delete_post_request.go.tpl
      sdk_update_pre_build_request:
        template_path: hooks/replication_group/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/replication_group/sdk_update_post_build_request.go.tpl
      delta_post_compare:
        code: "modifyDelta(delta, a, b)"
      sdk_file_end:
        template_path: hooks/replication_group/sdk_file_end.go.tpl
      sdk_file_end_set_output_post_populate:
        code: "rm.customSetOutput(ctx, *obj, ko) // custom set output from obj"
    renames:
      operations:
        CreateReplicationGroup:
          input_fields:
            ReplicationGroupDescription: Description
        ModifyReplicationGroup:
          input_fields:
            ReplicationGroupDescription: Description
  Snapshot:
    update_conditions_custom_method_name: CustomUpdateConditions
    exceptions:
      terminal_codes:
        - InvalidParameter
        - InvalidParameterValue
        - InvalidParameterCombination
        - SnapshotAlreadyExistsFault
        - SnapshotQuotaExceededFault
        - SnapshotFeatureNotSupportedFault
    fields:
      SourceSnapshotName:
        from:
          operation: CopySnapshot
          path: SourceSnapshotName
    update_operation:
      custom_method_name: customUpdateSnapshot
  CacheParameterGroup:
    exceptions:
      terminal_codes:
        - CacheParameterGroupAlreadyExists
        - CacheParameterGroupQuotaExceeded
        - InvalidCacheParameterGroupState
        - InvalidGlobalReplicationGroupState
        - InvalidParameterCombination
        - InvalidParameterValue
    fields:
      ParameterNameValues:
        from:
          operation: ModifyCacheParameterGroup
          path: ParameterNameValues
      Parameters:
        is_read_only: true
        from:
          operation: DescribeCacheParameters
          path: Parameters
      Events:
        is_read_only: true
        from:
          operation: DescribeEvents
          path: Events
    update_operation:
      custom_method_name: customUpdateCacheParameterGroup
  User:
    exceptions:
      errors:
        404:
          code: UserNotFound
      terminal_codes:
        - UserAlreadyExists
        - UserQuotaExceeded
        - DuplicateUserName
        - InvalidParameterValue
        - InvalidParameterCombination
        - InvalidUserState
        - DefaultUserAssociatedToUserGroup
    fields:
      LastRequestedAccessString:
        is_read_only: true
        from:
          operation: CreateUser
          path: AccessString
      ExpandedAccessString:
        is_read_only: true
        from:
          operation: CreateUser
          path: AccessString
      Passwords:
        is_secret: true
        compare:
          is_ignored: true
    hooks:
      sdk_read_many_post_set_output:
        code: "rm.setSyncedCondition(resp.Users[0].Status, &resource{ko})"
      sdk_create_post_set_output:
        code: "rm.setSyncedCondition(resp.Status, &resource{ko})"
      sdk_update_post_build_request:
        code: "rm.populateUpdatePayload(input, desired, delta)"
      sdk_update_post_set_output:
        code: "rm.setSyncedCondition(resp.Status, &resource{ko})"
      delta_post_compare:
        code: "filterDelta(delta, a, b)"
  UserGroup:
    exceptions:
      terminal_codes:
        - DuplicateUserNameFault
        - UserGroupAlreadyExistsFault
        - InvalidParameterCombination
        - InvalidParameterValueException
        - DefaultUserRequired
        - UserGroupQuotaExceededFault
        - TagQuotaPerResourceExceeded
    update_operation:
      custom_method_name: customUpdateUserGroup
operations:
  DescribeCacheSubnetGroups:
    set_output_custom_method_name: CustomDescribeCacheSubnetGroupsSetOutput
  DescribeReplicationGroups:
    set_output_custom_method_name: CustomDescribeReplicationGroupsSetOutput
  CreateReplicationGroup:
    set_output_custom_method_name: CustomCreateReplicationGroupSetOutput
  ModifyReplicationGroup:
    custom_implementation: CustomModifyReplicationGroup
    set_output_custom_method_name: CustomModifyReplicationGroupSetOutput
    override_values:
      ApplyImmediately: aws.Bool(true)
  CreateSnapshot:
    custom_implementation: CustomCreateSnapshot
    set_output_custom_method_name: CustomCreateSnapshotSetOutput
  DescribeSnapshots:
    set_output_custom_method_name: CustomDescribeSnapshotSetOutput
  CreateCacheParameterGroup:
    set_output_custom_method_name: CustomCreateCacheParameterGroupSetOutput
  DescribeCacheParameterGroups:
    set_output_custom_method_name: CustomDescribeCacheParameterGroupsSetOutput
  CreateUser:
    set_output_custom_method_name: CustomCreateUserSetOutput
  ModifyUser:
    custom_implementation: CustomModifyUser
    set_output_custom_method_name: CustomModifyUserSetOutput
  CreateUserGroup:
    set_output_custom_method_name: CustomCreateUserGroupSetOutput
  DescribeUserGroups:
    set_output_custom_method_name: CustomDescribeUserGroupsSetOutput
  CreateCacheCluster:
    set_output_custom_method_name: customCreateCacheClusterSetOutput
  ModifyCacheCluster:
    set_output_custom_method_name: customModifyCacheClusterSetOutput
    override_values:
      ApplyImmediately: aws.Bool(true)
ignore:
  resource_names:
    - ServerlessCache
    - ServerlessCacheSnapshot
    - GlobalReplicationGroup
    - CacheSecurityGroup
  field_paths:
    - DescribeSnapshotsInput.CacheClusterId
    - DescribeSnapshotsInput.ReplicationGroupId
    - DescribeSnapshotsInput.SnapshotSource
    - DescribeUsersInput.Engine
    - ModifyUserInput.AccessString
    - ModifyUserInput.NoPasswordRequired
    - ModifyUserInput.Passwords
    - ModifyReplicationGroupInput.SecurityGroupIds
    - ModifyReplicationGroupInput.EngineVersion
    - CreateReplicationGroupInput.GlobalReplicationGroupId
    - CreateReplicationGroupInput.AutoMinorVersionUpgrade
    - CreateReplicationGroupInput.NumCacheClusters
    - CacheCluster.LogDeliveryConfigurations
    - PendingModifiedValues.LogDeliveryConfigurations
    - CreateUserInput.AuthenticationMode
    - ModifyUserInput.AuthenticationMode
    - CreateCacheSubnetGroupOutput.CacheSubnetGroup.SupportedNetworkTypes
    - CreateCacheSubnetGroupOutput.CacheSubnetGroup.Subnets.SupportedNetworkTypes
    - ModifyCacheSubnetGroupOutput.CacheSubnetGroup.Subnets.SupportedNetworkTypes
    - CreateUserGroupOutput.ServerlessCaches
    - CreateReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.TransitEncryptionEnabled
    - ModifyReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.TransitEncryptionEnabled
    # - CreateReplicationGroupOutput.ReplicationGroup.TransitEncryptionEnabled
    # - ModifyReplicationGroupInput.TransitEncryptionEnabled
    # - CreateReplicationGroupInput.TransitEncryptionEnabled
    - CreateReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.TransitEncryptionMode
    - CreateReplicationGroupOutput.ReplicationGroup.TransitEncryptionMode
    - CreateReplicationGroupInput.TransitEncryptionMode
    - ModifyReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.TransitEncryptionMode
    - CreateReplicationGroupOutput.ReplicationGroup.ClusterMode
    - CreateReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.ClusterMode
    - CreateReplicationGroupInput.ClusterMode
    - ModifyReplicationGroupOutput.ReplicationGroup.ClusterMode
    - ModifyReplicationGroupOutput.ReplicationGroup.PendingModifiedValues.ClusterMode
    - CreateReplicationGroupInput.IpDiscovery
    - CreateReplicationGroupOutput.ReplicationGroup.IpDiscovery
    - Subnet.SupportedNetworkTypes
    - CreateReplicationGroupInput.ServerlessCacheSnapshotName
    - CreateReplicationGroupOutput.ReplicationGroup.NetworkType
    - CreateReplicationGroupInput.NetworkType
    # - ModifyReplicationGroupOutput.ReplicationGroup.ipDiscovery
    # - ModifyReplicationGroupInput.ipDiscovery